Package com.primavera.integration.client.bo.object

Class FinancialPeriodTemplate

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.FinancialPeriodTemplate
public class FinancialPeriodTemplate extends BusinessObject

Customized financial periods Templates 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 FinancialPeriodTemplate fields

  • Constructor Details

    • FinancialPeriodTemplate

      public FinancialPeriodTemplate(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

    • FinancialPeriodTemplate

      public FinancialPeriodTemplate(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

    • FinancialPeriodTemplate

      public FinancialPeriodTemplate(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 Details

    • loadFinancialPeriods

      public BOIterator<FinancialPeriod> loadFinancialPeriods(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated FinancialPeriod 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

    • getFinancialPeriodTemplateName

      public String getFinancialPeriodTemplateName() throws BusinessObjectException
      Gets the name of the financial period template name. 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 FinancialPeriodTemplateName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFinancialPeriodTemplateName

      public void setFinancialPeriodTemplateName(String s) throws BusinessObjectException
      Sets the name of the financial period template name. 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

    • getDefaultFlag

      public boolean getDefaultFlag() throws BusinessObjectException
      Gets the Financial period default template.
      Returns:
      the value in the field DefaultFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDefaultFlag

      public void setDefaultFlag(boolean b) throws BusinessObjectException
      Sets the Financial period default template.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this financial period template was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this financial period template was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateUser

      public 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 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

    • getUsedByCount

      public int getUsedByCount() throws BusinessObjectException
      Gets the total number of projects assigned to the template. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UsedByCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsShortFinancialPeriod

      public boolean getIsShortFinancialPeriod() throws BusinessObjectException
      Gets if financial periods has less than 7 days. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field IsShortFinancialPeriod
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static 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 String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static 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 String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this FinancialPeriodTemplate object in the database.
      Returns:
      ObjectId the unique ID of the newly created FinancialPeriodTemplate 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, FinancialPeriodTemplate[] financialperiodtemplates) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple FinancialPeriodTemplate objects in the database.
      Parameters:
      session - the Session object
      financialperiodtemplates - array of FinancialPeriodTemplate objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created FinancialPeriodTemplate 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 FinancialPeriodTemplate load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single FinancialPeriodTemplate object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the FinancialPeriodTemplate object
      Returns:
      FinancialPeriodTemplate the FinancialPeriodTemplate 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<FinancialPeriodTemplate> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple FinancialPeriodTemplate objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the FinancialPeriodTemplate 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 FinancialPeriodTemplate object in the database.
      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, FinancialPeriodTemplate[] financialperiodtemplates) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple FinancialPeriodTemplate objects in the database.
      Parameters:
      session - the Session object
      financialperiodtemplates - array of FinancialPeriodTemplate 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 FinancialPeriodTemplate object from the database.
      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, FinancialPeriodTemplate[] financialperiodtemplates) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple FinancialPeriodTemplate objects from the database.
      Parameters:
      session - the Session object
      financialperiodtemplates - array of FinancialPeriodTemplate 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