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

Class PAuditX

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.PAuditX
public class PAuditX extends BusinessObject
PAuditX is associated with published audit records for the table for which auditing is enabled.

See Also:   Quick reference of PAuditX fields

  • Constructor Details

    • PAuditX

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

    • PAuditX

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

    • PAuditX

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

    • getSubjectArea

      public String getSubjectArea() throws BusinessObjectException
      Gets denotes the table name of the audit record. This field is automatically loaded by default whenever this type of business object is loaded from 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(String s) throws BusinessObjectException
      Sets denotes the table name of the audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTablePrimaryKeys

      public String getTablePrimaryKeys() throws BusinessObjectException
      Gets denotes the table primary keys of the audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field TablePrimaryKeys
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTablePrimaryKeys

      public void setTablePrimaryKeys(String s) throws BusinessObjectException
      Sets denotes the table primary keys of the audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTableColumnName

      public String getTableColumnName() throws BusinessObjectException
      Gets denotes the table column name of the audit record.
      Returns:
      the value in the field TableColumnName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTableColumnName

      public void setTableColumnName(String s) throws BusinessObjectException
      Sets denotes the table column name of the audit record.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOldValue

      public String getOldValue() throws BusinessObjectException
      Gets denotes the previous value of the attribute column of audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field OldValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOldValue

      public void setOldValue(String s) throws BusinessObjectException
      Sets denotes the previous value of the attribute column of audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getNewValue

      public String getNewValue() throws BusinessObjectException
      Gets denotes the new value of the attribute column of audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field NewValue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setNewValue

      public void setNewValue(String s) throws BusinessObjectException
      Sets denotes the new value of the attribute column of audit record. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      s - 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 project id of the audit record. 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

    • setProjectObjectId

      public void setProjectObjectId(ObjectId o) throws BusinessObjectException
      Sets project id of the audit record. 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

    • getOperation

      public String getOperation() throws BusinessObjectException
      Gets denotes the operation that was executed on the audit record.
      Returns:
      the value in the field Operation
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOperation

      public void setOperation(String s) throws BusinessObjectException
      Sets denotes the operation that was executed on the audit record.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPrmUserName

      public String getPrmUserName() throws BusinessObjectException
      Gets denotes the name of the user which created or updated the audit record.
      Returns:
      the value in the field PrmUserName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPrmUserName

      public void setPrmUserName(String s) throws BusinessObjectException
      Sets denotes the name of the user which created or updated the audit record.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getHostName

      public String getHostName() throws BusinessObjectException
      Gets denotes the hostname when the audit record was created or updated.
      Returns:
      the value in the field HostName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setHostName

      public void setHostName(String s) throws BusinessObjectException
      Sets denotes the hostname when the audit record was created or updated.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getApplicationName

      public String getApplicationName() throws BusinessObjectException
      Gets denotes the application name of the audit record.
      Returns:
      the value in the field ApplicationName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setApplicationName

      public void setApplicationName(String s) throws BusinessObjectException
      Sets denotes the application name of the audit record.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAuditTimestamp

      public Date getAuditTimestamp() throws BusinessObjectException
      Gets denotes the timestamp at which the record was created, updated or deleted. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field AuditTimestamp
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAuditTimestamp

      public void setAuditTimestamp(Date d) throws BusinessObjectException
      Sets denotes the timestamp at which the record was created, updated or deleted. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectName

      public String getProjectName() throws BusinessObjectException
      Gets denotes the project name of the audit record with respect to project id.
      Returns:
      the value in the field ProjectName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProjectName

      public void setProjectName(String s) throws BusinessObjectException
      Sets denotes the project name of the audit record with respect to project id.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectShortName

      public String getProjectShortName() throws BusinessObjectException
      Gets denotes the project short name of the audit record with respect to project id.
      Returns:
      the value in the field ProjectShortName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProjectShortName

      public void setProjectShortName(String s) throws BusinessObjectException
      Sets denotes the project short name of the audit record with respect to project id.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityCode

      public String getActivityCode() throws BusinessObjectException
      Gets denotes the activity name of the audit record with respect to table primary key when table name is TASK.
      Returns:
      the value in the field ActivityCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityCode

      public void setActivityCode(String s) throws BusinessObjectException
      Sets denotes the activity name of the audit record with respect to table primary key when table name is TASK.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityName

      public String getActivityName() throws BusinessObjectException
      Gets denotest the actiity name of the audit record with respect to table primary key when table name is TASK.
      Returns:
      the value in the field ActivityName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityName

      public void setActivityName(String s) throws BusinessObjectException
      Sets denotest the actiity name of the audit record with respect to table primary key when table name is TASK.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActualName

      public String getActualName() throws BusinessObjectException
      Gets denotes the actual name of the user which executed the operation on the audit record.
      Returns:
      the value in the field ActualName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActualName

      public void setActualName(String s) throws BusinessObjectException
      Sets denotes the actual name of the user which executed the operation on the audit record.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getBussinessObjName

      public String getBussinessObjName() throws BusinessObjectException
      Gets denotes the business object name.
      Returns:
      the value in the field BussinessObjName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setBussinessObjName

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

    • getBOFieldName

      public String getBOFieldName() throws BusinessObjectException
      Gets denotes the field name.
      Returns:
      the value in the field BOFieldName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setBOFieldName

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

    • getBOFieldType

      public String getBOFieldType() throws BusinessObjectException
      Gets denotes the field type.
      Returns:
      the value in the field BOFieldType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setBOFieldType

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

    • getOldValueName

      public String getOldValueName() throws BusinessObjectException
      Gets denotes the display value for the old value column. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field OldValueName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOldValueName

      public void setOldValueName(String s) throws BusinessObjectException
      Sets denotes the display value for the old value column. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getNewValueName

      public String getNewValueName() throws BusinessObjectException
      Gets denotes the display value for the new value column. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field NewValueName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setNewValueName

      public void setNewValueName(String s) throws BusinessObjectException
      Sets denotes the display value for the new value column. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUdfCodeTypeLabel

      public String getUdfCodeTypeLabel() throws BusinessObjectException
      Gets denotes the display value for the udf records, otherwise null.
      Returns:
      the value in the field UdfCodeTypeLabel
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUdfCodeTypeLabel

      public void setUdfCodeTypeLabel(String s) throws BusinessObjectException
      Sets denotes the display value for the udf records, otherwise null.
      Parameters:
      s - the value to set this field to
      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 PAuditX object in the database.
      Returns:
      ObjectId the unique ID of the newly created PAuditX 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, PAuditX[] pauditxs) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple PAuditX objects in the database.
      Parameters:
      session - the Session object
      pauditxs - array of PAuditX objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created PAuditX 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 PAuditX load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single PAuditX object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the PAuditX object
      Returns:
      PAuditX the PAuditX 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<PAuditX> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple PAuditX objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the PAuditX 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 PAuditX 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, PAuditX[] pauditxs) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple PAuditX objects in the database.
      Parameters:
      session - the Session object
      pauditxs - array of PAuditX 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 PAuditX 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, PAuditX[] pauditxs) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple PAuditX objects from the database.
      Parameters:
      session - the Session object
      pauditxs - array of PAuditX 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