Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class Currency

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.Currency

public class Currency
extends BusinessObject

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 Summary
Currency(Session session)
          Class constructor specifying the Session.
Currency(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
Currency(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this Currency object in the database.
static ObjectId[] create(Session session, Currency[] currencies)
          Creates multiple Currency objects in the database.
 void delete()
          Deletes this Currency object from the database.
static void delete(Session session, Currency[] currencies)
          Deletes multiple Currency objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this currency was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this currency.
 int getDecimalPlaces()
          Gets the number of decimal places displayed.
 java.lang.String getDecimalSymbol()
          Gets the decimal symbol displayed.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getDigitGroupingSymbol()
          Gets the symbol used to group the numbers.
 double getExchangeRate()
          Gets the exchange rate against the base currency.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 java.lang.String getId()
          Gets the unique currency abbreviation for each currency.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsBaseCurrency()
          Gets the currency used to store cost in the Project Management database.
 java.util.Date getLastUpdateDate()
          Gets the date this currency was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this currency.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the currency.
 NegativeCurrencyFormat getNegativeSymbol()
          Gets the symbol used to display a negative currency.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 PositiveCurrencyFormat getPositiveSymbol()
          Gets the symbol used to display a positive currency.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 java.lang.String getSymbol()
          Gets the currency symbol displayed.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Currency load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Currency object from the database.
static BOIterator<Currency> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Currency objects from the database.
 BOIterator<Resource> loadResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Resource objects from the database.
 BOIterator<User> loadUsers(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated User objects from the database.
 void setDecimalPlaces(int i)
          Sets the number of decimal places displayed.
 void setDecimalSymbol(java.lang.String s)
          Sets the decimal symbol displayed.
 void setDigitGroupingSymbol(java.lang.String s)
          Sets the symbol used to group the numbers.
 void setExchangeRate(double d)
          Sets the exchange rate against the base currency.
 void setId(java.lang.String s)
          Sets the unique currency abbreviation for each currency.
 void setName(java.lang.String s)
          Sets the name of the currency.
 void setNegativeSymbol(NegativeCurrencyFormat enm)
          Sets the symbol used to display a negative currency.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setPositiveSymbol(PositiveCurrencyFormat enm)
          Sets the symbol used to display a positive currency.
 void setSymbol(java.lang.String s)
          Sets the currency symbol displayed.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this Currency object in the database.
static void update(Session session, Currency[] currencies)
          Updates multiple Currency objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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 Detail

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,
                            java.lang.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,
                                        java.lang.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.

Overrides:
update in class BOBase
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.

Overrides:
delete in class BOBase
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

loadResources

public BOIterator<Resource> loadResources(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.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(java.lang.String[] fields,
                                  java.lang.String sWhereClause,
                                  java.lang.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

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

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.

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 java.lang.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(java.lang.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 java.lang.String 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(java.lang.String s)
                      throws BusinessObjectException
Sets the decimal symbol displayed.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDigitGroupingSymbol

public java.lang.String 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(java.lang.String s)
                            throws BusinessObjectException
Sets the symbol used to group the numbers.

Parameters:
s - 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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.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 java.util.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.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 java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.