Package com.primavera.integration.client.bo.object

Class Currency

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.CurrencyBase
com.primavera.integration.client.bo.object.Currency
public class Currency extends com.primavera.integration.client.bo.base.CurrencyBase

Currencies allow you to specify the types of currencies you want to use for costs. A currency type is set for every database. The user is able to specify the currency, its symbol, decimal symbol, number of decimal places, the positive and negative currency format and the digit grouping symbol.

See Also:   Quick reference of Currency fields

  • Constructor Details

    • Currency

      public Currency(Session session)
      Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.
      Parameters:
      session - the Session

    • Currency

      public Currency(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • Currency

      public Currency(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
      Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.
      Parameters:
      session - the Session
      rowSet - the PrmRowSet retrieved from the server
      iIndex - the row index in the PrmRowSet associated with this business object
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

  • Method Details

    • loadResources

      public BOIterator<Resource> loadResources(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated Resource objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadUsers

      public BOIterator<User> loadUsers(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated User objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • hasAllResourceAccess

      public static boolean hasAllResourceAccess(Session session) throws BusinessObjectException, ServerException, NetworkException
      Checks if the current user has all resource access.
      Parameters:
      session - the Session object
      Returns:
      true if the current has all resource access
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public static void update(Session session, BusinessObject[] currencies, boolean updateResourceRate) throws ServerException, NetworkException, BusinessObjectException
      Updates Currency objects and recalculate resource rate if exchange rate is changed in the database with the option to update resource rate.
      Parameters:
      session - the Session object
      currencies - array of Currency objects to update
      updateResourceRate - whether to update Resource Rate
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsBaseCurrency

      public boolean getIsBaseCurrency() throws BusinessObjectException
      Gets the currency used to store cost in the Project Management database. The exchange rate for the base currency is always 1.0. The base currency ID, name, and symbol default to U.S. dollars and can be edited but never deleted. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field IsBaseCurrency
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDecimalPlaces

      public int getDecimalPlaces() throws BusinessObjectException
      Gets the number of decimal places displayed.
      Returns:
      the value in the field DecimalPlaces
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDecimalPlaces

      public void setDecimalPlaces(int i) throws BusinessObjectException
      Sets the number of decimal places displayed.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSymbol

      public String getSymbol() throws BusinessObjectException
      Gets the currency symbol displayed. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Symbol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSymbol

      public void setSymbol(String s) throws BusinessObjectException
      Sets the currency symbol displayed. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDecimalSymbol

      public CurrencySeparator getDecimalSymbol() throws BusinessObjectException
      Gets the decimal symbol displayed.
      Returns:
      the value in the field DecimalSymbol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDecimalSymbol

      public void setDecimalSymbol(CurrencySeparator enm) throws BusinessObjectException
      Sets the decimal symbol displayed.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDigitGroupingSymbol

      public CurrencySeparator getDigitGroupingSymbol() throws BusinessObjectException
      Gets the symbol used to group the numbers.
      Returns:
      the value in the field DigitGroupingSymbol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDigitGroupingSymbol

      public void setDigitGroupingSymbol(CurrencySeparator enm) throws BusinessObjectException
      Sets the symbol used to group the numbers.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPositiveSymbol

      public PositiveCurrencyFormat getPositiveSymbol() throws BusinessObjectException
      Gets the symbol used to display a positive currency.
      Returns:
      the value in the field PositiveSymbol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPositiveSymbol

      public void setPositiveSymbol(PositiveCurrencyFormat enm) throws BusinessObjectException
      Sets the symbol used to display a positive currency.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getNegativeSymbol

      public NegativeCurrencyFormat getNegativeSymbol() throws BusinessObjectException
      Gets the symbol used to display a negative currency.
      Returns:
      the value in the field NegativeSymbol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setNegativeSymbol

      public void setNegativeSymbol(NegativeCurrencyFormat enm) throws BusinessObjectException
      Sets the symbol used to display a negative currency.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the currency. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Name
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setName

      public void setName(String s) throws BusinessObjectException
      Sets the name of the currency. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getId

      public String getId() throws BusinessObjectException
      Gets the unique currency abbreviation for each currency. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Id
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setId

      public void setId(String s) throws BusinessObjectException
      Sets the unique currency abbreviation for each currency. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getExchangeRate

      public double getExchangeRate() throws BusinessObjectException
      Gets the exchange rate against the base currency.
      Returns:
      the value in the field ExchangeRate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setExchangeRate

      public void setExchangeRate(double d) throws BusinessObjectException
      Sets the exchange rate against the base currency.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this currency was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this currency was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this currency.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this currency.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields

    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this Currency object in the database.
      Returns:
      ObjectId the unique ID of the newly created Currency object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, Currency[] currencies) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple Currency objects in the database.
      Parameters:
      session - the Session object
      currencies - array of Currency objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created Currency objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static Currency load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single Currency object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the Currency object
      Returns:
      Currency the Currency object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static BOIterator<Currency> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple Currency objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the Currency objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public void update() throws ServerException, NetworkException, BusinessObjectException
      Updates this Currency object in the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • update

      public static void update(Session session, Currency[] currencies) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple Currency objects in the database.
      Parameters:
      session - the Session object
      currencies - array of Currency objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this Currency object from the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public static void delete(Session session, Currency[] currencies) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple Currency objects from the database.
      Parameters:
      session - the Session object
      currencies - array of Currency objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects