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

Class UserFieldTitle

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

User fields enable you to add your own custom fields and values to the project database. For example, you can track additional activity data, such as delivery dates and purchase order numbers, or resource and cost-related data, such as profit, variances, and revised budgets.

In the Project Management application you can display custom user fields in the columns of the Activity Table and then print the layout. You can also group, sort, filter, and summarize by user field, as well as add user fields to reports you create. Use Global Change to assign values to Activity and Activity Resource Assignments type user fields.

You may not create or delete user field titles; they may only be loaded and updated.

See Also:   Quick reference of UserFieldTitle fields

  • Constructor Details

    • UserFieldTitle

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

    • UserFieldTitle

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

    • UserFieldTitle

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

    • objectNameToTableName

      public static String objectNameToTableName(String sObjectName)
      Translate from object name to physical database table name.
      Parameters:
      sObjectName - object name
      Returns:
      physical database table name

    • 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

    • getUserTableName

      public String getUserTableName() throws BusinessObjectException
      Gets the table name of the user defined column.
      Returns:
      the value in the field UserTableName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDefaultTitle

      public String getDefaultTitle() throws BusinessObjectException
      Gets the default title of the column name.
      Returns:
      the value in the field DefaultTitle
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getObjectName

      public String getObjectName() throws BusinessObjectException
      Gets the name of the business object to which this user defined column belongs. 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 ObjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUserDefinedTitle

      public String getUserDefinedTitle() throws BusinessObjectException
      Gets the user defined column name.
      Returns:
      the value in the field UserDefinedTitle
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUserDefinedTitle

      public void setUserDefinedTitle(String s) throws BusinessObjectException
      Sets the user defined column name.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

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

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

    • load

      public static UserFieldTitle load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single UserFieldTitle object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the UserFieldTitle object
      Returns:
      UserFieldTitle the UserFieldTitle 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<UserFieldTitle> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple UserFieldTitle objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the UserFieldTitle 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 UserFieldTitle 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, UserFieldTitle[] userfieldtitles) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple UserFieldTitle objects in the database.
      Parameters:
      session - the Session object
      userfieldtitles - array of UserFieldTitle 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