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

Class UDFType

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.UDFTypeBase
com.primavera.integration.client.bo.object.UDFType
public class UDFType extends com.primavera.integration.client.bo.base.UDFTypeBase

User-defined fields (UDFs) enable users to add custom fields and values to the project database. For example, additional activity data, such as delivery dates and purchase order numbers, can be tracked. Business objects that support UDFs are Activity, ActivityExpense, ActivityStep, ActivityStepTemplateItem, Document, EPS, Project, ProjectIssue, ProjectRisk, Resource, ResourceAssignment, and WBS. Note that UDFs with a data type of Code may only be assigned to ProjectIssues.

The assignment of a UDF to a particular business object is represented by the UDFValue business object.

See Also:   Quick reference of UDFType fields

  • Constructor Details

    • UDFType

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

    • UDFType

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

    • UDFType

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

    • loadUDFValues

      public BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, 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

    • loadUDFCodes

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

    • getUDFFieldName

      public String getUDFFieldName() throws BusinessObjectException
      Obtaining composed field name used for loading udf data.
      Returns:
      String represent of the field name used for udf data loading
      Throws:
      BusinessObjectException

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSubjectArea

      public UDFSubjectArea getSubjectArea() throws BusinessObjectException
      Gets the subject area of the user-defined field: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents". 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 SubjectArea
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSubjectArea

      public void setSubjectArea(UDFSubjectArea enm) throws BusinessObjectException
      Sets the subject area of the user-defined field: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents". This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTitle

      public String getTitle() throws BusinessObjectException
      Gets the name/title of the user-defined field. 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 Title
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTitle

      public void setTitle(String s) throws BusinessObjectException
      Sets the name/title of the user-defined field. 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

    • getDataType

      public UDFDataType getDataType() throws BusinessObjectException
      Gets the data type of the user-defined field: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code". 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 DataType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDataType

      public void setDataType(UDFDataType enm) throws BusinessObjectException
      Sets the data type of the user-defined field: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code". 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:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsSecureCode

      public boolean getIsSecureCode() throws BusinessObjectException
      Gets the flag indicating whether this is a secure code type.
      Returns:
      the value in the field IsSecureCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsSecureCode

      public void setIsSecureCode(boolean b) throws BusinessObjectException
      Sets the flag indicating whether this is a secure code type.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsCalculated

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

    • getIsConditional

      public boolean getIsConditional() throws BusinessObjectException
      Gets the flag indicating whether this is a indicator user defined field type.
      Returns:
      the value in the field IsConditional
      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

    • getDisplayIndicatorFlag

      public boolean getDisplayIndicatorFlag() throws BusinessObjectException
      Throws:
      BusinessObjectException

    • setDisplayIndicatorFlag

      public void setDisplayIndicatorFlag(boolean b) throws BusinessObjectException
      Throws:
      BusinessObjectException

    • getSummaryMethod

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

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this user-defined field 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 user-defined field 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 user-defined field.
      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 user-defined field.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields

    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

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

    • getAllFields

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

    • getInternalAllFields

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

    • getInternalAllFieldsSet

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

    • getWritableFields

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

    • getDefaultXMLExportFields

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

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this UDFType object in the database.
      Returns:
      ObjectId the unique ID of the newly created 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

    • create

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

    • load

      public static BOIterator<UDFType> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple UDFType objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the UDFType 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 UDFType 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, UDFType[] udftypes) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple UDFType objects in the database.
      Parameters:
      session - the Session object
      udftypes - array of UDFType 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 UDFType 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, UDFType[] udftypes) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple UDFType objects from the database.
      Parameters:
      session - the Session object
      udftypes - array of UDFType 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