|
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.FinancialPeriod
public class FinancialPeriod
Customized financial periods are used to provide accurate display and reporting of actual units and costs. Rather than spreading costs evenly throughout the length of a project, users can view how actual costs were incurred by defining customized financial periods with a StartDate and EndDate. The minimum financial period duration is one day. Financial periods may not overlap each other and do not have to be contiguous.
Past period actuals are stored at the activity and resource/role assignment level using the ActivityPeriodActual and ResourceAssignmentPeriodActual business objects.
You can not delete a financial period if there are existing activity or resource assignment period actual values stored. To delete a financial period with stored actual values, first use the loadResourceAssignmentPeriodActuals() method to load all resource assignment period actuals for that financial period, then delete each instance. Repeat the process for activity period actuals using the loadActivityPeriodActuals() method.
See Also: Quick reference of FinancialPeriod fields
Constructor Summary | |
---|---|
FinancialPeriod(Session session)
Class constructor specifying the Session. |
|
FinancialPeriod(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
FinancialPeriod(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 FinancialPeriod object in the database. |
static ObjectId[] |
create(Session session,
FinancialPeriod[] financialperiods)
Creates multiple FinancialPeriod objects in the database. |
void |
delete()
Deletes this FinancialPeriod object from the database. |
static void |
delete(Session session,
FinancialPeriod[] financialperiods)
Deletes multiple FinancialPeriod objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this financial period was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this financial period. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
EndDate |
getEndDate()
Gets the end date of the period. |
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 financial period was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this financial period. |
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 financial period. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
BeginDate |
getStartDate()
Gets the start date of the period. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static FinancialPeriod |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single FinancialPeriod object from the database. |
static BOIterator<FinancialPeriod> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple FinancialPeriod objects from the database. |
BOIterator<ActivityPeriodActual> |
loadActivityPeriodActuals(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ActivityPeriodActual objects from the database. |
BOIterator<ResourceAssignmentPeriodActual> |
loadResourceAssignmentPeriodActuals(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated ResourceAssignmentPeriodActual objects from the database. |
void |
setEndDate(EndDate d)
Sets the end date of the period. |
void |
setName(java.lang.String s)
Sets the name of the financial period. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setStartDate(BeginDate d)
Sets the start date of the period. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this FinancialPeriod object in the database. |
static void |
update(Session session,
FinancialPeriod[] financialperiods)
Updates multiple FinancialPeriod 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 FinancialPeriod(Session session)
session
- the Sessionpublic FinancialPeriod(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic FinancialPeriod(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, FinancialPeriod[] financialperiods) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfinancialperiods
- array of FinancialPeriod 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 FinancialPeriod load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the FinancialPeriod 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<FinancialPeriod> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the FinancialPeriod 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, FinancialPeriod[] financialperiods) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfinancialperiods
- array of FinancialPeriod 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, FinancialPeriod[] financialperiods) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfinancialperiods
- array of FinancialPeriod 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<ActivityPeriodActual> loadActivityPeriodActuals(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<ResourceAssignmentPeriodActual> loadResourceAssignmentPeriodActuals(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 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 BeginDate getStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setStartDate(BeginDate d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic EndDate getEndDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setEndDate(EndDate 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 |