Primavera Integration API 7.0

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

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.base.ActivityExpenseBase
              extended by com.primavera.integration.client.bo.object.ActivityExpense

public class ActivityExpense
extends com.primavera.integration.client.bo.base.ActivityExpenseBase

Activity expenses are non-resource costs associated with a project and assigned to a project's activities. They are typically one-time expenditures for non-reusable items. Examples of expenses include materials, facilities, travel, overhead, and training.

You can categorize expenses, indicate a unit of measure for expenses, and specify whether an expense accrues at the start or end of an activity or uniformly over its duration. Each expense has a planned cost, actual cost, and estimated remaining cost.

Expenses are not the same as resources. Resources are time-based and generally extend across multiple activities and/or multiple projects. Examples of resources are personnel and equipment. Unlike resources, expenses are project-specific and they are not time-based. Expenses are not included when resources are leveled.

This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.

See Also:   Quick reference of ActivityExpense fields


Constructor Summary
ActivityExpense(Session session)
          Class constructor specifying the Session.
ActivityExpense(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ActivityExpense(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 ActivityExpense object in the database.
static ObjectId[] create(Session session, ActivityExpense[] activityexpenses)
          Creates multiple ActivityExpense objects in the database.
 void delete()
          Deletes this ActivityExpense object from the database.
static void delete(Session session, ActivityExpense[] activityexpenses)
          Deletes multiple ActivityExpense objects from the database.
 AccrualType getAccrualType()
          Gets the accrual type for the project expense.
 java.lang.String getActivityId()
          Gets the short ID that uniquely identifies the activity within the project.
 java.lang.String getActivityName()
          Gets the name of the activity.
 ObjectId getActivityObjectId()
          Gets the unique ID of the activity to which the project expense is linked.
 Cost getActualCost()
          Gets the actual cost for the project expense.
 double getActualUnits()
          Gets the actual units for the project expense.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 double getAtCompletionCost()
          Gets the sum of the actual plus remaining costs for the project expense.
 double getAtCompletionUnits()
          Gets the at completion units for the project expense.
 boolean getAutoComputeActuals()
          Gets the flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete.
 java.lang.String getCostAccountId()
          Gets the id of associated cost account.
 java.lang.String getCostAccountName()
          Gets the name of the associated cost account.
 ObjectId getCostAccountObjectId()
          Gets the unique ID of the cost account associated with the project expense.
 java.util.Date getCreateDate()
          Gets the date this expense was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this expense.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getDocumentNumber()
          Gets the document number for the expense.
 java.lang.String getExpenseCategoryName()
          Gets the name of the expense category.
 ObjectId getExpenseCategoryObjectId()
          Gets the unique ID of the expense category for the project expense.
 java.lang.String getExpenseDescription()
          Gets the description of the expense.
 java.lang.String getExpenseItem()
          Gets the name of the project expense.
 Percent getExpensePercentComplete()
          Gets the percent complete of the project expense.
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 expense was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this expense.
static java.lang.String[] getMainFields()
          Gets all fields in the main group for this business object.
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.
 boolean getOverBudget()
          Gets the indicator that reflects whether the project expense is over budget.
 Cost getPlannedCost()
          Gets the planned cost for the project expense.
 double getPlannedUnits()
          Gets the planned number of units for the project expense.
 Cost getPricePerUnit()
          Gets the planned price per unit for the project expense.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 Cost getRemainingCost()
          Gets the remaining cost for the project expense.
 double getRemainingUnits()
          Gets the remaining units for the project expense.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 Cost getUDFCost(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Double getUDFDouble(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 EndDate getUDFFinishDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 UDFIndicator getUDFIndicator(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Integer getUDFInteger(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 BeginDate getUDFStartDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.String getUDFText(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 ObjectId[] getUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 java.lang.String getUnitOfMeasure()
          Gets the unit of measure for the project expense.
 java.lang.String getVendor()
          Gets the name of the vendor providing the product or service associated with the expense.
 ObjectId getWBSObjectId()
          Gets the unique ID of the WBS for the activity.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ActivityExpense load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ActivityExpense object from the database.
static BOIterator<ActivityExpense> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ActivityExpense objects from the database.
 Activity loadActivity(java.lang.String[] fields)
          Loads an associated Activity object from the database.
 CostAccount loadCostAccount(java.lang.String[] fields)
          Loads an associated CostAccount object from the database.
 ExpenseCategory loadExpenseCategory(java.lang.String[] fields)
          Loads an associated ExpenseCategory object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 void setAccrualType(AccrualType enm)
          Sets the accrual type for the project expense.
 void setActivityObjectId(ObjectId o)
          Sets the unique ID of the activity to which the project expense is linked.
 void setActualCost(Cost c)
          Sets the actual cost for the project expense.
 void setActualUnits(double d)
          Sets the actual units for the project expense.
 void setAutoComputeActuals(boolean b)
          Sets the flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete.
 void setCostAccountObjectId(ObjectId o)
          Sets the unique ID of the cost account associated with the project expense.
 void setDocumentNumber(java.lang.String s)
          Sets the document number for the expense.
 void setExpenseCategoryObjectId(ObjectId o)
          Sets the unique ID of the expense category for the project expense.
 void setExpenseDescription(java.lang.String s)
          Sets the description of the expense.
 void setExpenseItem(java.lang.String s)
          Sets the name of the project expense.
 void setExpensePercentComplete(Percent p)
          Sets the percent complete of the project expense.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setPlannedCost(Cost c)
          Sets the planned cost for the project expense.
 void setPlannedUnits(double d)
          Sets the planned number of units for the project expense.
 void setPricePerUnit(Cost c)
          Sets the planned price per unit for the project expense.
 void setRemainingCost(Cost c)
          Sets the remaining cost for the project expense.
 void setRemainingUnits(double d)
          Sets the remaining units for the project expense.
 void setUDFCost(ObjectId objId, Cost cost)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFDouble(ObjectId objId, java.lang.Double n)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFFinishDate(ObjectId objId, EndDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFIndicator(ObjectId objId, UDFIndicator ind)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFInteger(ObjectId objId, java.lang.Integer i)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFStartDate(ObjectId objId, BeginDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFText(ObjectId objId, java.lang.String s)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUnitOfMeasure(java.lang.String s)
          Sets the unit of measure for the project expense.
 void setVendor(java.lang.String s)
          Sets the name of the vendor providing the product or service associated with the expense.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ActivityExpense object in the database.
static void update(Session session, ActivityExpense[] activityexpenses)
          Updates multiple ActivityExpense 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

ActivityExpense

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

ActivityExpense

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

ActivityExpense

public ActivityExpense(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 ActivityExpense object in the database.

Returns:
ObjectId the unique ID of the newly created ActivityExpense 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,
                                ActivityExpense[] activityexpenses)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ActivityExpense objects in the database.

Parameters:
session - the Session object
activityexpenses - array of ActivityExpense objects to create
Returns:
ObjectId[] the array of unique IDs of newly created ActivityExpense 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 ActivityExpense load(Session session,
                                   java.lang.String[] fields,
                                   ObjectId objId)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Loads a single ActivityExpense object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ActivityExpense object
Returns:
ActivityExpense the ActivityExpense 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<ActivityExpense> load(Session session,
                                               java.lang.String[] fields,
                                               ObjectId[] objIds)
                                        throws ServerException,
                                               NetworkException,
                                               BusinessObjectException
Loads multiple ActivityExpense objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ActivityExpense 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 ActivityExpense 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,
                          ActivityExpense[] activityexpenses)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ActivityExpense objects in the database.

Parameters:
session - the Session object
activityexpenses - array of ActivityExpense 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 ActivityExpense 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,
                          ActivityExpense[] activityexpenses)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ActivityExpense objects from the database.

Parameters:
session - the Session object
activityexpenses - array of ActivityExpense 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

loadProject

public Project loadProject(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated Project object from the database.

Parameters:
fields - fields to load
Returns:
Project the Project 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

loadExpenseCategory

public ExpenseCategory loadExpenseCategory(java.lang.String[] fields)
                                    throws ServerException,
                                           NetworkException,
                                           BusinessObjectException
Loads an associated ExpenseCategory object from the database.

Parameters:
fields - fields to load
Returns:
ExpenseCategory the ExpenseCategory 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

loadActivity

public Activity loadActivity(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated Activity object from the database.

Parameters:
fields - fields to load
Returns:
Activity the Activity 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

loadCostAccount

public CostAccount loadCostAccount(java.lang.String[] fields)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Loads an associated CostAccount object from the database.

Parameters:
fields - fields to load
Returns:
CostAccount the CostAccount 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

loadUDFValues

public BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple associated UDFValue 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

getUDFTypesAssigned

@Deprecated
public ObjectId[] getUDFTypesAssigned()
                               throws BusinessObjectException
Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.

Gets the ObjectIds of all UDFTypes for which UDFs are assigned to this expense.

Overrides:
getUDFTypesAssigned in class com.primavera.integration.client.bo.base.ActivityExpenseBase
Returns:
ObjectId array of UDFType
Throws:
BusinessObjectException

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

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.

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

getActivityObjectId

public ObjectId getActivityObjectId()
                             throws BusinessObjectException
Gets the unique ID of the activity to which the project expense is linked. Every project expense is associated with one activity in the project. This field is automatically loaded by default whenever this type of business object is loaded from the database. 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 ActivityObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActivityObjectId

public void setActivityObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the activity to which the project expense is linked. Every project expense is associated with one activity in the project. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

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

getActivityId

public java.lang.String getActivityId()
                               throws BusinessObjectException
Gets the short ID that uniquely identifies the activity within the project.

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

getProjectObjectId

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

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

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the project.

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

getExpenseCategoryObjectId

public ObjectId getExpenseCategoryObjectId()
                                    throws BusinessObjectException
Gets the unique ID of the expense category for the project expense. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setExpenseCategoryObjectId

public void setExpenseCategoryObjectId(ObjectId o)
                                throws BusinessObjectException
Sets the unique ID of the expense category for the project expense. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getCostAccountObjectId

public ObjectId getCostAccountObjectId()
                                throws BusinessObjectException
Gets the unique ID of the cost account associated with the project expense. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setCostAccountObjectId

public void setCostAccountObjectId(ObjectId o)
                            throws BusinessObjectException
Sets the unique ID of the cost account associated with the project expense. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getWBSObjectId

public ObjectId getWBSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the WBS for the activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getExpenseItem

public java.lang.String getExpenseItem()
                                throws BusinessObjectException
Gets the name of the project expense. 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 ExpenseItem
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setExpenseItem

public void setExpenseItem(java.lang.String s)
                    throws BusinessObjectException
Sets the name of the project expense. 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

getExpenseCategoryName

public java.lang.String getExpenseCategoryName()
                                        throws BusinessObjectException
Gets the name of the expense category.

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

getCostAccountName

public java.lang.String getCostAccountName()
                                    throws BusinessObjectException
Gets the name of the associated cost account.

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

getCostAccountId

public java.lang.String getCostAccountId()
                                  throws BusinessObjectException
Gets the id of associated cost account.

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

getActivityName

public java.lang.String getActivityName()
                                 throws BusinessObjectException
Gets the name of the activity. The activity name does not have to be unique.

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

getVendor

public java.lang.String getVendor()
                           throws BusinessObjectException
Gets the name of the vendor providing the product or service associated with the expense.

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

setVendor

public void setVendor(java.lang.String s)
               throws BusinessObjectException
Sets the name of the vendor providing the product or service associated with the expense.

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

getAccrualType

public AccrualType getAccrualType()
                           throws BusinessObjectException
Gets the accrual type for the project expense. If the accrual type is 'Start of Activity', the entire expense costs are accrued at the start date of the activity. If the accrual type is 'End of Activity', the entire expense costs are accrued at the finish date of the activity. If the accrual type is 'Uniform over Activity', the expense costs are accrued uniformly over the duration of the activity.

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

setAccrualType

public void setAccrualType(AccrualType enm)
                    throws BusinessObjectException
Sets the accrual type for the project expense. If the accrual type is 'Start of Activity', the entire expense costs are accrued at the start date of the activity. If the accrual type is 'End of Activity', the entire expense costs are accrued at the finish date of the activity. If the accrual type is 'Uniform over Activity', the expense costs are accrued uniformly over the duration of the activity.

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

getDocumentNumber

public java.lang.String getDocumentNumber()
                                   throws BusinessObjectException
Gets the document number for the expense. Use this for the purchase order number, invoice number, requisition number, or similar, as needed.

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

setDocumentNumber

public void setDocumentNumber(java.lang.String s)
                       throws BusinessObjectException
Sets the document number for the expense. Use this for the purchase order number, invoice number, requisition number, or similar, as needed.

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

getUnitOfMeasure

public java.lang.String getUnitOfMeasure()
                                  throws BusinessObjectException
Gets the unit of measure for the project expense.

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

setUnitOfMeasure

public void setUnitOfMeasure(java.lang.String s)
                      throws BusinessObjectException
Sets the unit of measure for the project expense.

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

getAutoComputeActuals

public boolean getAutoComputeActuals()
                              throws BusinessObjectException
Gets the flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete. If this option is selected, the actual/remaining costs are automatically updated when project actuals are applied. This assumes the expenses are made according to plan.

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

setAutoComputeActuals

public void setAutoComputeActuals(boolean b)
                           throws BusinessObjectException
Sets the flag that identifies whether the actual and remaining costs for the expense are computed automatically using the planned cost and the activity's schedule percent complete. If this option is selected, the actual/remaining costs are automatically updated when project actuals are applied. This assumes the expenses are made according to plan.

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

getPlannedCost

public Cost getPlannedCost()
                    throws BusinessObjectException
Gets the planned cost for the project expense. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

setPlannedCost

public void setPlannedCost(Cost c)
                    throws BusinessObjectException
Sets the planned cost for the project expense. This field is named BudgetedCost in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

getActualCost

public Cost getActualCost()
                   throws BusinessObjectException
Gets the actual cost for the project expense.

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

setActualCost

public void setActualCost(Cost c)
                   throws BusinessObjectException
Sets the actual cost for the project expense.

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

getRemainingCost

public Cost getRemainingCost()
                      throws BusinessObjectException
Gets the remaining cost for the project expense. Before actual expenses are made, remaining cost should be the same as planned cost. While the activity is in progress, the remaining cost should be updated to reflect the estimated remaining cost required for the expense. After the expense is completed, the remaining cost should be zero.

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

setRemainingCost

public void setRemainingCost(Cost c)
                      throws BusinessObjectException
Sets the remaining cost for the project expense. Before actual expenses are made, remaining cost should be the same as planned cost. While the activity is in progress, the remaining cost should be updated to reflect the estimated remaining cost required for the expense. After the expense is completed, the remaining cost should be zero.

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

getPricePerUnit

public Cost getPricePerUnit()
                     throws BusinessObjectException
Gets the planned price per unit for the project expense. This number is multiplied by the planned number of units to compute the planned cost.

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

setPricePerUnit

public void setPricePerUnit(Cost c)
                     throws BusinessObjectException
Sets the planned price per unit for the project expense. This number is multiplied by the planned number of units to compute the planned cost.

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

getPlannedUnits

public double getPlannedUnits()
                       throws BusinessObjectException
Gets the planned number of units for the project expense. This number is multiplied by the price per unit to compute the planned cost. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

setPlannedUnits

public void setPlannedUnits(double d)
                     throws BusinessObjectException
Sets the planned number of units for the project expense. This number is multiplied by the price per unit to compute the planned cost. This field is named BudgetedUnits in Primavera's Engineering & Construction and Maintenance & Turnaround solutions.

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

getActualUnits

public double getActualUnits()
                      throws BusinessObjectException
Gets the actual units for the project expense. 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 ActualUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualUnits

public void setActualUnits(double d)
                    throws BusinessObjectException
Sets the actual units for the project expense. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getRemainingUnits

public double getRemainingUnits()
                         throws BusinessObjectException
Gets the remaining units for the project expense. 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 RemainingUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRemainingUnits

public void setRemainingUnits(double d)
                       throws BusinessObjectException
Sets the remaining units for the project expense. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getExpenseDescription

public java.lang.String getExpenseDescription()
                                       throws BusinessObjectException
Gets the description of the expense. 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 ExpenseDescription
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setExpenseDescription

public void setExpenseDescription(java.lang.String s)
                           throws BusinessObjectException
Sets the description of the expense. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getAtCompletionUnits

public double getAtCompletionUnits()
                            throws BusinessObjectException
Gets the at completion units for the project expense. 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 AtCompletionUnits
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAtCompletionCost

public double getAtCompletionCost()
                           throws BusinessObjectException
Gets the sum of the actual plus remaining costs for the project expense. Computed as actual cost + remaining cost. 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 AtCompletionCost
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getExpensePercentComplete

public Percent getExpensePercentComplete()
                                  throws BusinessObjectException
Gets the percent complete of the project expense. 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 ExpensePercentComplete
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setExpensePercentComplete

public void setExpensePercentComplete(Percent p)
                               throws BusinessObjectException
Sets the percent complete of the project expense. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getOverBudget

public boolean getOverBudget()
                      throws BusinessObjectException
Gets the indicator that reflects whether the project expense is over budget. An expense is over budget when the actual cost + remaining cost exceeds the planned cost. 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 OverBudget
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this expense 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 expense 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 expense.

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 expense.

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

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

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

getUDFCost

@Deprecated
public Cost getUDFCost(ObjectId objId)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Cost the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFCost

@Deprecated
public void setUDFCost(ObjectId objId,
                                  Cost cost)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
cost - the Cost value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFDouble

@Deprecated
public java.lang.Double getUDFDouble(ObjectId objId)
                              throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Double the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFDouble

@Deprecated
public void setUDFDouble(ObjectId objId,
                                    java.lang.Double n)
                  throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
n - the Double value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFFinishDate

@Deprecated
public EndDate getUDFFinishDate(ObjectId objId)
                         throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
EndDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFFinishDate

@Deprecated
public void setUDFFinishDate(ObjectId objId,
                                        EndDate date)
                      throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the FinishDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFIndicator

@Deprecated
public UDFIndicator getUDFIndicator(ObjectId objId)
                             throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
com.primavera.integration.client.bo.enm.UDFIndicator the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFIndicator

@Deprecated
public void setUDFIndicator(ObjectId objId,
                                       UDFIndicator ind)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
ind - the Indicator value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFInteger

@Deprecated
public java.lang.Integer getUDFInteger(ObjectId objId)
                                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Integer the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFInteger

@Deprecated
public void setUDFInteger(ObjectId objId,
                                     java.lang.Integer i)
                   throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
i - the Integer value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFStartDate

@Deprecated
public BeginDate getUDFStartDate(ObjectId objId)
                          throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
BeginDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFStartDate

@Deprecated
public void setUDFStartDate(ObjectId objId,
                                       BeginDate date)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the StartDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFText

@Deprecated
public java.lang.String getUDFText(ObjectId objId)
                            throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
String the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFText

@Deprecated
public void setUDFText(ObjectId objId,
                                  java.lang.String s)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
s - the Text value to set
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

getMainFields

public static java.lang.String[] getMainFields()
Gets all fields in the main group for this business object.

Returns:
String[] an array of fields in this group

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.