Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class FinancialPeriod

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.FinancialPeriod

public class FinancialPeriod
extends BusinessObject

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

FinancialPeriod

public FinancialPeriod(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

FinancialPeriod

public FinancialPeriod(Session session,
                       ObjectId objId)
                throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

FinancialPeriod

public FinancialPeriod(Session session,
                       com.primavera.infr.db.PrmRowSet rowSet,
                       int iIndex)
                throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this FinancialPeriod object in the database.

Returns:
ObjectId the unique ID of the newly created FinancialPeriod object
Throws:
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 objects

create

public static ObjectId[] create(Session session,
                                FinancialPeriod[] financialperiods)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple FinancialPeriod objects in the database.

Parameters:
session - the Session object
financialperiods - array of FinancialPeriod objects to create
Returns:
ObjectId[] the array of unique IDs of newly created FinancialPeriod objects
Throws:
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 objects

load

public static FinancialPeriod load(Session session,
                                   java.lang.String[] fields,
                                   ObjectId objId)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Loads a single FinancialPeriod object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the FinancialPeriod object
Returns:
FinancialPeriod the FinancialPeriod object
Throws:
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 objects

load

public static BOIterator<FinancialPeriod> load(Session session,
                                               java.lang.String[] fields,
                                               ObjectId[] objIds)
                                        throws ServerException,
                                               NetworkException,
                                               BusinessObjectException
Loads multiple FinancialPeriod objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the FinancialPeriod objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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 objects

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this FinancialPeriod object in the database.

Overrides:
update in class BOBase
Throws:
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 objects

update

public static void update(Session session,
                          FinancialPeriod[] financialperiods)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple FinancialPeriod objects in the database.

Parameters:
session - the Session object
financialperiods - array of FinancialPeriod objects to update
Throws:
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 objects

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this FinancialPeriod object from the database.

Overrides:
delete in class BOBase
Throws:
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 objects

delete

public static void delete(Session session,
                          FinancialPeriod[] financialperiods)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple FinancialPeriod objects from the database.

Parameters:
session - the Session object
financialperiods - array of FinancialPeriod objects to delete
Throws:
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 objects

loadActivityPeriodActuals

public BOIterator<ActivityPeriodActual> loadActivityPeriodActuals(java.lang.String[] fields,
                                                                  java.lang.String sWhereClause,
                                                                  java.lang.String sOrderBy)
                                                           throws ServerException,
                                                                  NetworkException,
                                                                  BusinessObjectException
Loads multiple associated ActivityPeriodActual objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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 objects

loadResourceAssignmentPeriodActuals

public BOIterator<ResourceAssignmentPeriodActual> loadResourceAssignmentPeriodActuals(java.lang.String[] fields,
                                                                                      java.lang.String sWhereClause,
                                                                                      java.lang.String sOrderBy)
                                                                               throws ServerException,
                                                                                      NetworkException,
                                                                                      BusinessObjectException
Loads multiple associated ResourceAssignmentPeriodActual objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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 objects

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the financial period. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the financial period. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getStartDate

public BeginDate getStartDate()
                       throws BusinessObjectException
Gets the start date of the period. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field StartDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setStartDate

public void setStartDate(BeginDate d)
                  throws BusinessObjectException
Sets the start date of the period. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
d - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEndDate

public EndDate getEndDate()
                   throws BusinessObjectException
Gets the end date of the period. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field EndDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setEndDate

public void setEndDate(EndDate d)
                throws BusinessObjectException
Sets the end date of the period. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
d - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this financial period was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this financial period was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this financial period.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this financial period.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.