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

Class UDFValue

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

A user defined field value represents the value of a particular user defined field when assigned to another business object. The ForeignObjectId field represents the ObjectId of the business object to which the UDF is assigned. Note that the type of the foreign business object must match the subject area of the associated UDFType.

The data type of the associated UDFType determines the type of value that can be set. For example, if the data type of the associated UDFType is Indicator, only the get/set UDFIndicator methods may be used.

Note that this business object has a multi-part object ID; its object ID is a combination of its UDF type object ID and its foreign object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.

See Also:   Quick reference of UDFValue fields

  • Constructor Details

    • UDFValue

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

    • UDFValue

      public UDFValue(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the UDFTypeObjectId and ForeignObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • UDFValue

      public UDFValue(Session session, ObjectId uDFTypeObjectId, ObjectId foreignObjectId) throws BusinessObjectException
      Class constructor specifying the Session and the individual components of the multi-part key: UDFTypeObjectId and ForeignObjectId. This constructor is most commonly used when update() is intended to be called on this object.
      Parameters:
      session - the Session
      uDFTypeObjectId - the first ObjectId in the key
      foreignObjectId - the second ObjectId in the key
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • UDFValue

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

    • loadUDFType

      public UDFType loadUDFType(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated UDFType object from the database.
      Parameters:
      fields - fields to load
      Returns:
      UDFType the UDFType 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

    • loadUDFCode

      public UDFCode loadUDFCode(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated UDFCode object from the database.
      Parameters:
      fields - fields to load
      Returns:
      UDFCode the UDFCode 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

    • loadProject

      public Project loadProject(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

    • getUDFTypeObjectId

      public ObjectId getUDFTypeObjectId() throws BusinessObjectException
      Gets the unique ID of the associated UDF type. 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 UDFTypeObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUDFTypeObjectId

      public void setUDFTypeObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated UDF type. 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

    • getForeignObjectId

      public ObjectId getForeignObjectId() throws BusinessObjectException
      Gets the unique ID of the business object to which the UDF is assigned: ProjectObjectId, ActivityObjectId, ResourceObjectId, etc. 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 ForeignObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setForeignObjectId

      public void setForeignObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the business object to which the UDF is assigned: ProjectObjectId, ActivityObjectId, ResourceObjectId, etc. 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

    • 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

    • getText

      public String getText() throws BusinessObjectException
      Gets the value of the text UDF.
      Returns:
      the value in the field Text
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setText

      public void setText(String s) throws BusinessObjectException
      Sets the value of the text UDF.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIndicator

      public UDFIndicator getIndicator() throws BusinessObjectException
      Gets the value of the indicator UDF.
      Returns:
      the value in the field Indicator
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIndicator

      public void setIndicator(UDFIndicator enm) throws BusinessObjectException
      Sets the value of the indicator UDF.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDouble

      public double getDouble() throws BusinessObjectException
      Gets the value of the double UDF.
      Returns:
      the value in the field Double
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDouble

      public void setDouble(double d) throws BusinessObjectException
      Sets the value of the double UDF.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getInteger

      public int getInteger() throws BusinessObjectException
      Gets the value of the integer UDF.
      Returns:
      the value in the field Integer
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setInteger

      public void setInteger(int i) throws BusinessObjectException
      Sets the value of the integer UDF.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCost

      public Cost getCost() throws BusinessObjectException
      Gets the value of the cost UDF.
      Returns:
      the value in the field Cost
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCost

      public void setCost(Cost c) throws BusinessObjectException
      Sets the value of the cost UDF.
      Parameters:
      c - 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 value of the start date UDF.
      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 value of the start date UDF.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFinishDate

      public EndDate getFinishDate() throws BusinessObjectException
      Gets the value of the finish date UDF.
      Returns:
      the value in the field FinishDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFinishDate

      public void setFinishDate(EndDate d) throws BusinessObjectException
      Sets the value of the finish date UDF.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUDFTypeSubjectArea

      public UDFSubjectArea getUDFTypeSubjectArea() throws BusinessObjectException
      Gets the subject area of the associated user-defined field type: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents".
      Returns:
      the value in the field UDFTypeSubjectArea
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUDFTypeTitle

      public String getUDFTypeTitle() throws BusinessObjectException
      Gets the name/title of the associated user-defined field type.
      Returns:
      the value in the field UDFTypeTitle
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUDFTypeDataType

      public UDFDataType getUDFTypeDataType() throws BusinessObjectException
      Gets the data type of the associated user-defined field type: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code".
      Returns:
      the value in the field UDFTypeDataType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUDFCodeObjectId

      public ObjectId getUDFCodeObjectId() throws BusinessObjectException
      Gets the unique ID of the associated UDF code. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field UDFCodeObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUDFCodeObjectId

      public void setUDFCodeObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated UDF code. 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

    • getCodeValue

      public String getCodeValue() throws BusinessObjectException
      Gets the short ID that uniquely identifies the associated UDF code within the UDF code type.
      Returns:
      the value in the field CodeValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDescription

      public String getDescription() throws BusinessObjectException
      Gets the description of the associated UDF code.
      Returns:
      the value in the field Description
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

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

    • getFormula

      public String getFormula() throws BusinessObjectException
      Gets formula.
      Returns:
      the value in the field Formula
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsUDFTypeCalculated

      public boolean getIsUDFTypeCalculated() throws BusinessObjectException
      Gets the flag indicating whether this is a value associated with a calculated user defined field type.
      Returns:
      the value in the field IsUDFTypeCalculated
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsUDFTypeConditional

      public boolean getIsUDFTypeConditional() throws BusinessObjectException
      Gets the flag indicating whether this is a value associated with a user defined field type having a conditional expression.
      Returns:
      the value in the field IsUDFTypeConditional
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getConditionalIndicator

      public int getConditionalIndicator() throws BusinessObjectException
      Gets the conditional indicator of the user defined field, obtained by evaluating the conditional expression. 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 ConditionalIndicator
      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.

    • createObjectId

      public static ObjectId createObjectId(ObjectId uDFTypeObjectId, ObjectId foreignObjectId) throws InvalidValueException
      Creates a multi-part ObjectId from two individual ObjectIds.
      Parameters:
      uDFTypeObjectId - the ObjectId of the associated uDFType object.
      foreignObjectId - the ObjectId of the associated foreign object.
      Returns:
      ObjectId the multi-part ObjectId
      Throws:
      InvalidValueException - if one of the input parameters was invalid.
      IllegalArgumentException - if one of the input parameters was null.

    • 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. For this object, the ObjectId is multi-part, consisting internally of the UDFTypeObjectId and ForeignObjectId fields.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      ObjectId the multi-part ObjectId of this object
      Throws:
      BusinessObjectException - if the ObjectId fields were not loaded.

    • create

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