com.primavera.integration.client.bo

Class BusinessObject

java.lang.Object

com.primavera.integration.client.BOBase

com.primavera.integration.client.bo.BusinessObject

Direct Known Subclasses:

com.primavera.integration.client.bo.base.ActivityBase, ActivityCodeAssignment, com.primavera.integration.client.bo.base.ActivityCodeBase, ActivityCodeType, ActivityComment, ActivityExpense, ActivityNote, ActivityOwner, ActivityPeriodActual, ActivityRisk, ActivityStep, ActivityStepTemplate, ActivityStepTemplateItem, com.primavera.integration.client.bo.base.BaselineProjectBase, BaselineType, com.primavera.integration.client.bo.base.CalendarBase, CostAccount, Currency, Document, DocumentCategory, DocumentStatusCode, com.primavera.integration.client.bo.base.EPSBase, EPSBudgetChangeLog, EPSFunding, EPSNote, EPSSpendingPlan, ExpenseCategory, FinancialPeriod, FundingSource, GlobalPreferences, com.primavera.integration.client.bo.base.GlobalProfileBase, IssueHistory, NotebookTopic, OBS, OverheadCode, com.primavera.integration.client.bo.base.ProjectBase, ProjectBudgetChangeLog, ProjectCodeAssignment, com.primavera.integration.client.bo.base.ProjectCodeBase, ProjectCodeType, ProjectCodeUser, ProjectDocument, ProjectFunding, ProjectIssue, ProjectNote, com.primavera.integration.client.bo.base.ProjectPortfolioBase, com.primavera.integration.client.bo.base.ProjectProfileBase, ProjectResource, ProjectResourceCategory, ProjectResourceQuantity, ProjectSpendingPlan, ProjectThreshold, Relationship, ResourceAccess, ResourceAssignment, ResourceAssignmentPeriodActual, com.primavera.integration.client.bo.base.ResourceBase, ResourceCodeAssignment, com.primavera.integration.client.bo.base.ResourceCodeBase, ResourceCodeType, com.primavera.integration.client.bo.base.ResourceCurveBase, ResourceHour, ResourceRate, ResourceRole, com.primavera.integration.client.bo.base.ResourceTeamBase, com.primavera.integration.client.bo.base.RiskBase, RiskCategory, Role, RoleLimit, RoleRate, com.primavera.integration.client.bo.base.RoleTeamBase, ScheduleOptions, com.primavera.integration.client.bo.base.ShiftBase, ShiftPeriod, ThresholdParameter, Timesheet, TimesheetAudit, TimesheetDelegate, TimesheetPeriod, UDFCode, com.primavera.integration.client.bo.base.UDFTypeBase, UDFValue, UnitOfMeasure, com.primavera.integration.client.bo.base.UserBase, com.primavera.integration.client.bo.base.UserFieldTitleBase, UserInterfaceView, UserLicense, UserOBS, com.primavera.integration.client.bo.base.WBSBase, WBSCategory, WBSMilestone

public abstract class BusinessObject
extends com.primavera.integration.client.BOBase

The base class of all client-side business objects.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
ObjectId	getObjectId() Gets the ObjectId for this object.
Object	getValue(int fieldId)
Object	getValue(String sFieldName)
int	hashCode() Returns a hash code for this business object.
boolean	isNull(String sFieldName) Checks whether a field is currently null in the result set returned from the database.
void	setNull(String sFieldName) Sets a field to null.
void	setObjectId(ObjectId objId) Sets the ObjectId for this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

isNull

public boolean isNull(String sFieldName)
               throws FieldNotLoadedException,
                      InvalidFieldException,
                      BusinessObjectException

Checks whether a field is currently null in the result set returned from the database. Note that for fields that have a primitive type (boolean, double, int), the only way to tell if the value stored in the database is null is by calling this method.

Parameters:

sFieldName - the field name to check.

Returns:

boolean true if null; false otherwise.

Throws:

FieldNotLoadedException - if no fields were loaded in this business object

InvalidFieldException - if the specified field name is null or invalid

BusinessObjectException - if the internal data is invalid

IllegalArgumentException - if the input parameter is null or invalid

setNull

public void setNull(String sFieldName)
             throws BusinessObjectException

Sets a field to null. Note that for fields that have a primitive type (boolean, double, int), the only way to set them to null is by calling this method. Other fields that have a non-primitive type may be set to null by calling the appropriate set method on the business object itself.

Parameters:

sFieldName - the name of the field to set.

Throws:

BusinessObjectException - if the internal data is invalid

IllegalArgumentException - if the specified field name is null or invalid

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException

Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database.

Specified by:

getObjectId in class com.primavera.integration.client.BOBase

Returns:

ObjectId the ObjectId of this object

Throws:

BusinessObjectException - if the ObjectId field(s) were not loaded in this business object

setObjectId

public void setObjectId(ObjectId objId)
                 throws BusinessObjectException

Sets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database.

Parameters:

objId - the ObjectId of this object

Throws:

BusinessObjectException - if the number of key fields mismatch between the ObjectId and the business object

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one. This method will return true if the objects are the same type of business object and contain the exact same fields.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

boolean true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

Returns a hash code for this business object.

Overrides:

hashCode in class Object

Returns:

the hash code

getValue

public Object getValue(String sFieldName)
                throws BusinessObjectException

Specified by:

getValue in class com.primavera.integration.client.BOBase

Throws:

BusinessObjectException

getValue

public Object getValue(int fieldId)
                throws BusinessObjectException

Throws:

BusinessObjectException