Package 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, ActivityCodeUpdate, ActivityComment, ActivityExpense, ActivityFilter, ActivityNote, ActivityNoteUpdate, ActivityOwner, ActivityPeriodActual, ActivityRisk, ActivityStep, ActivityStepCreate, ActivityStepDelete, ActivityStepTemplate, ActivityStepTemplateItem, ActivityStepUpdate, ActivityUpdate, Alert, AutovueAttr, com.primavera.integration.client.bo.base.BaselineProjectBase, BaselineType, com.primavera.integration.client.bo.base.CalendarBase, CBS, CBSDurationSummary, ChangeSet, CostAccount, com.primavera.integration.client.bo.base.CurrencyBase, Document, DocumentCategory, DocumentStatusCode, com.primavera.integration.client.bo.base.EPSBase, EPSBudgetChangeLog, EPSFunding, EPSNote, EPSSpendingPlan, ExpenseCategory, FinancialPeriod, FinancialPeriodTemplate, FundingSource, GatewayDeployment, GlobalPreferences, com.primavera.integration.client.bo.base.GlobalProfileBase, GlobalReplace, ImportOptionsTemplate, IssueHistory, JobService, LeanTask, Location, MSPTemplate, NotebookTopic, OBS, OverheadCode, PAuditX, Profile, com.primavera.integration.client.bo.base.ProjectBase, ProjectBudgetChangeLog, ProjectCodeAssignment, com.primavera.integration.client.bo.base.ProjectCodeBase, ProjectCodeType, ProjectDeployment, 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, ResourceAssignmentCodeAssignment, com.primavera.integration.client.bo.base.ResourceAssignmentCodeBase, ResourceAssignmentCodeType, ResourceAssignmentCreate, ResourceAssignmentPeriodActual, ResourceAssignmentUpdate, com.primavera.integration.client.bo.base.ResourceBase, ResourceCodeAssignment, com.primavera.integration.client.bo.base.ResourceCodeBase, ResourceCodeType, com.primavera.integration.client.bo.base.ResourceCurveBase, ResourceHour, ResourceLocation, ResourceRate, ResourceRole, com.primavera.integration.client.bo.base.ResourceTeamBase, Risk, RiskCategory, RiskImpact, RiskMatrix, RiskMatrixScore, RiskMatrixThreshold, RiskResponseAction, RiskResponseActionImpact, RiskResponsePlan, RiskThreshold, RiskThresholdLevel, com.primavera.integration.client.bo.base.RoleBase, RoleCodeAssignment, com.primavera.integration.client.bo.base.RoleCodeBase, RoleCodeType, RoleLimit, RoleRate, com.primavera.integration.client.bo.base.RoleTeamBase, ScheduleCheckOption, ScheduleOptions, com.primavera.integration.client.bo.base.ShiftBase, ShiftPeriod, StepUserDefinedValueUpdate, ThresholdParameter, Timesheet, TimesheetAudit, TimesheetDelegate, TimesheetPeriod, UDFCode, com.primavera.integration.client.bo.base.UDFTypeBase, UDFValue, UnitOfMeasure, UpdateBaselineOption, com.primavera.integration.client.bo.base.UserBase, UserConsent, UserDefinedValueUpdate, com.primavera.integration.client.bo.base.UserFieldTitleBase, UserInterfaceView, UserLicense, UserOBS, com.primavera.integration.client.bo.base.WBSBase, WBSCategory, WBSMilestone, WbsReviewers
public abstract class BusinessObject extends com.primavera.integration.client.BOBase
The base class of all client-side business objects.

  • Method Details

    • 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.
      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
      Throws:
      BusinessObjectException

    • getValue

      public Object getValue(int fieldId) throws BusinessObjectException
      Throws:
      BusinessObjectException

    • getMaxFieldLength

      public Integer getMaxFieldLength(Session session, String sfieldName) throws BusinessObjectException
      Throws:
      BusinessObjectException

    • setEarlyDate

      public void setEarlyDate(int fieldId, Date date) throws BusinessObjectException
      Throws:
      BusinessObjectException