|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.Currency
public class Currency
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 |
---|
public Currency(Session session)
session
- the Sessionpublic Currency(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Currency(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, Currency[] currencies) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcurrencies
- array of Currency objects to create
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 objectspublic static Currency load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Currency object
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 objectspublic static BOIterator<Currency> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Currency objects
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 objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
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 objectspublic static void update(Session session, Currency[] currencies) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcurrencies
- array of Currency objects to update
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
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 objectspublic static void delete(Session session, Currency[] currencies) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcurrencies
- array of Currency objects to delete
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 objectspublic BOIterator<Resource> loadResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 objectspublic BOIterator<User> loadUsers(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseCurrency() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getDecimalPlaces() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDecimalPlaces(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getSymbol() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSymbol(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getDecimalSymbol() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDecimalSymbol(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getDigitGroupingSymbol() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDigitGroupingSymbol(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic PositiveCurrencyFormat getPositiveSymbol() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPositiveSymbol(PositiveCurrencyFormat enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic NegativeCurrencyFormat getNegativeSymbol() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setNegativeSymbol(NegativeCurrencyFormat enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setId(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getExchangeRate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setExchangeRate(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |