|
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.ProjectSpendingPlan
public class ProjectSpendingPlan
Project spending plans represent monthly spending amounts for a project or WBS.
See Also: Quick reference of ProjectSpendingPlan fields
Constructor Summary | |
---|---|
ProjectSpendingPlan(Session session)
Class constructor specifying the Session. |
|
ProjectSpendingPlan(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectSpendingPlan(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 ProjectSpendingPlan object in the database. |
static ObjectId[] |
create(Session session,
ProjectSpendingPlan[] projectspendingplans)
Creates multiple ProjectSpendingPlan objects in the database. |
void |
delete()
Deletes this ProjectSpendingPlan object from the database. |
static void |
delete(Session session,
ProjectSpendingPlan[] projectspendingplans)
Deletes multiple ProjectSpendingPlan objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
Cost |
getBenefitPlan()
Gets the editable monthly profit portion for each month for the project. |
java.util.Date |
getCreateDate()
Gets the date this spending plan was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this spending plan. |
java.util.Date |
getDate()
Gets the start of a spending/benefit plan time period for the project. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
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. |
boolean |
getIsBaseline()
Gets the boolean value indicating if this business object is related to a Project or Baseline. |
java.util.Date |
getLastUpdateDate()
Gets the date this spending plan was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this spending plan. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
java.lang.String |
getProjectId()
Gets the Project short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project for this project spending plan. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
Cost |
getSpendingPlan()
Gets the editable total monthly expenditure for the project. |
java.lang.String |
getWBSCode()
Gets the short code assigned to each WBS element for identification. |
java.lang.String |
getWBSName()
Gets the name of the WBS element. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the associated WBS for this project spending plan. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectSpendingPlan |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectSpendingPlan object from the database. |
static BOIterator<ProjectSpendingPlan> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectSpendingPlan objects from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
WBS |
loadWBS(java.lang.String[] fields)
Loads an associated WBS object from the database. |
void |
setBenefitPlan(Cost c)
Sets the editable monthly profit portion for each month for the project. |
void |
setDate(java.util.Date d)
Sets the start of a spending/benefit plan time period for the project. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project for this project spending plan. |
void |
setSpendingPlan(Cost c)
Sets the editable total monthly expenditure for the project. |
void |
setWBSObjectId(ObjectId o)
Sets the unique ID of the associated WBS for this project spending plan. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectSpendingPlan object in the database. |
static void |
update(Session session,
ProjectSpendingPlan[] projectspendingplans)
Updates multiple ProjectSpendingPlan 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 ProjectSpendingPlan(Session session)
session
- the Sessionpublic ProjectSpendingPlan(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectSpendingPlan(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, ProjectSpendingPlan[] projectspendingplans) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectspendingplans
- array of ProjectSpendingPlan 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 ProjectSpendingPlan load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectSpendingPlan 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<ProjectSpendingPlan> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectSpendingPlan 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, ProjectSpendingPlan[] projectspendingplans) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectspendingplans
- array of ProjectSpendingPlan 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, ProjectSpendingPlan[] projectspendingplans) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectspendingplans
- array of ProjectSpendingPlan 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 Project loadProject(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 WBS loadWBS(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 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 getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDate(java.util.Date d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getSpendingPlan() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSpendingPlan(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getBenefitPlan() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setBenefitPlan(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
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 boolean getIsBaseline() 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 |