|
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.CostAccount
public class CostAccount
Cost accounts contain the organization's cost account IDs. Available across all projects, they support tracking of costs and earned value based on the organization's cost account IDs. Cost accounts are hierarchical objects.
You can specify a project's default cost account. This cost account is used for resource assignments to activities and project expenses in the open project.
See Also: Quick reference of CostAccount fields
Constructor Summary | |
---|---|
CostAccount(Session session)
Class constructor specifying the Session. |
|
CostAccount(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
CostAccount(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 CostAccount object in the database. |
static ObjectId[] |
create(Session session,
CostAccount[] costaccounts)
Creates multiple CostAccount objects in the database. |
ObjectId |
createCostAccountChild(CostAccount costaccountchild)
Creates an associated CostAccount object in the database. |
ObjectId[] |
createCostAccountChildren(CostAccount[] costaccountchildren)
Creates multiple associated CostAccount objects in the database. |
void |
delete()
Deletes this CostAccount object from the database. |
void |
delete(ObjectId replacementId)
Deletes this CostAccount object from the database. |
static void |
delete(Session session,
CostAccount[] costaccounts)
Deletes multiple CostAccount objects from the database. |
static void |
delete(Session session,
CostAccount[] costaccounts,
ObjectId replacementParent)
Deletes multiple costaccount objects in a hierarchy from the database and set the new parent of all child objects. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this account was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this account. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
java.lang.String |
getDescription()
Gets the description of the cost account. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
java.lang.String |
getId()
Gets the short ID assigned to each cost account for identification. |
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. |
java.util.Date |
getLastUpdateDate()
Gets the date this account was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this account. |
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 cost account. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
ObjectId |
getParentObjectId()
Gets the unique ID of the parent cost account of this cost account in the hierarchy. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static CostAccount |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single CostAccount object from the database. |
static BOIterator<CostAccount> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple CostAccount objects from the database. |
BOIterator<ActivityExpense> |
loadActivityExpenses(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ActivityExpense objects from the database. |
BOIterator<CostAccount> |
loadCostAccountChildren(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated CostAccount objects from the database. |
CostAccount |
loadParentCostAccount(java.lang.String[] fields)
Loads an associated CostAccount object from the database. |
BOIterator<ResourceAssignment> |
loadResourceAssignments(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceAssignment objects from the database. |
static BOIterator<CostAccount> |
loadRootCostAccounts(Session session,
java.lang.String[] fields)
Loads the root CostAccount objects from the database. |
void |
setDescription(java.lang.String s)
Sets the description of the cost account. |
void |
setId(java.lang.String s)
Sets the short ID assigned to each cost account for identification. |
void |
setName(java.lang.String s)
Sets the name of the cost account. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setParentObjectId(ObjectId o)
Sets the unique ID of the parent cost account of this cost account in the hierarchy. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this CostAccount object in the database. |
static void |
update(Session session,
CostAccount[] costaccounts)
Updates multiple CostAccount 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 CostAccount(Session session)
session
- the Sessionpublic CostAccount(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic CostAccount(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, CostAccount[] costaccounts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcostaccounts
- array of CostAccount 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 CostAccount load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the CostAccount 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<CostAccount> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the CostAccount 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, CostAccount[] costaccounts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcostaccounts
- array of CostAccount 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 void delete(ObjectId replacementId) throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
replacementId
- unique ID of the new parent for all current child 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 static void delete(Session session, CostAccount[] costaccounts) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcostaccounts
- array of CostAccount 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 static void delete(Session session, CostAccount[] costaccounts, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectcostaccounts
- array of CostAccount objects to deletereplacementParent
- replacement parent 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 CostAccount loadParentCostAccount(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 createCostAccountChild(CostAccount costaccountchild) throws ServerException, NetworkException, BusinessObjectException
costaccountchild
- CostAccountChild object 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 ObjectId[] createCostAccountChildren(CostAccount[] costaccountchildren) throws ServerException, NetworkException, BusinessObjectException
costaccountchildren
- array of CostAccountChild 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 BOIterator<CostAccount> loadCostAccountChildren(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<ResourceAssignment> loadResourceAssignments(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<ActivityExpense> loadActivityExpenses(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 static BOIterator<CostAccount> loadRootCostAccounts(Session session, java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to load
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 ObjectId getParentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setParentObjectId(ObjectId o) throws BusinessObjectException
o
- 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 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 getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(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 int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- 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 |