|
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.FundingSource
public class FundingSource
Funding sources are hierarchical objects used to specify the names and descriptions of nonprofit, government-allocated, or other funding sources. You can assign funding sources to budgets as you develop projects.
See Also: Quick reference of FundingSource fields
Constructor Summary | |
---|---|
FundingSource(Session session)
Class constructor specifying the Session. |
|
FundingSource(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
FundingSource(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 FundingSource object in the database. |
static ObjectId[] |
create(Session session,
FundingSource[] fundingsources)
Creates multiple FundingSource objects in the database. |
ObjectId |
createFundingSourceChild(FundingSource fundingsourcechild)
Creates an associated FundingSource object in the database. |
ObjectId[] |
createFundingSourceChildren(FundingSource[] fundingsourcechildren)
Creates multiple associated FundingSource objects in the database. |
void |
delete()
Deletes this FundingSource object from the database. |
void |
delete(ObjectId replacementId)
Deletes this FundingSource object from the database. |
static void |
delete(Session session,
FundingSource[] fundingsources)
Deletes multiple FundingSource objects from the database. |
static void |
delete(Session session,
FundingSource[] fundingsources,
ObjectId replacementParent)
Deletes multiple fundingsource 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 funding source was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this funding source. |
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 funding source. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
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 funding source was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this funding source. |
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 funding source. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
ObjectId |
getParentObjectId()
Gets the unique ID of the parent funding source of this funding source 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 FundingSource |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single FundingSource object from the database. |
static BOIterator<FundingSource> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple FundingSource objects from the database. |
BOIterator<EPSFunding> |
loadEPSFundings(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated EPSFunding objects from the database. |
BOIterator<FundingSource> |
loadFundingSourceChildren(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated FundingSource objects from the database. |
FundingSource |
loadParentFundingSource(java.lang.String[] fields)
Loads an associated FundingSource object from the database. |
BOIterator<ProjectFunding> |
loadProjectFundings(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ProjectFunding objects from the database. |
void |
setDescription(java.lang.String s)
Sets the description of the funding source. |
void |
setName(java.lang.String s)
Sets the name of the funding source. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setParentObjectId(ObjectId o)
Sets the unique ID of the parent funding source of this funding source 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 FundingSource object in the database. |
static void |
update(Session session,
FundingSource[] fundingsources)
Updates multiple FundingSource 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 FundingSource(Session session)
session
- the Sessionpublic FundingSource(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic FundingSource(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, FundingSource[] fundingsources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfundingsources
- array of FundingSource 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 FundingSource load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the FundingSource 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<FundingSource> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the FundingSource 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, FundingSource[] fundingsources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfundingsources
- array of FundingSource 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, FundingSource[] fundingsources) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfundingsources
- array of FundingSource 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, FundingSource[] fundingsources, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfundingsources
- array of FundingSource 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 FundingSource loadParentFundingSource(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 createFundingSourceChild(FundingSource fundingsourcechild) throws ServerException, NetworkException, BusinessObjectException
fundingsourcechild
- FundingSourceChild 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[] createFundingSourceChildren(FundingSource[] fundingsourcechildren) throws ServerException, NetworkException, BusinessObjectException
fundingsourcechildren
- array of FundingSourceChild 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<FundingSource> loadFundingSourceChildren(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<ProjectFunding> loadProjectFundings(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<EPSFunding> loadEPSFundings(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 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 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 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 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 |