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

Class ActivityComment

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

An activity comment business object represents a comment made on an activity.

See Also:   Quick reference of ActivityComment fields

  • Constructor Details

    • ActivityComment

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

    • ActivityComment

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

    • ActivityComment

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

    • loadUser

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

    • loadActivity

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

    • 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

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the activity to which this comment is added. 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 ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityObjectId

      public void setActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the activity to which this comment is added. 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 for the project that owns the activity to which this comment is added.
      Returns:
      the value in the field ProjectObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUserObjectId

      public ObjectId getUserObjectId() throws BusinessObjectException
      Gets the unique ID of the user who added this comment. 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 UserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUserObjectId

      public void setUserObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the user who added this comment. 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

    • getPersonalName

      public String getPersonalName() throws BusinessObjectException
      Gets the commented user's personal or actual name.
      Returns:
      the value in the field PersonalName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCommentDate

      public Date getCommentDate() throws BusinessObjectException
      Gets the date on which this comment was added.
      Returns:
      the value in the field CommentDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCommentDate

      public void setCommentDate(Date d) throws BusinessObjectException
      Sets the date on which this comment was added.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCommentText

      public String getCommentText() throws BusinessObjectException
      Gets the comment. This field must contain a valid value in order to create this type of business object in the database. 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 CommentText
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCommentText

      public void setCommentText(String s) throws BusinessObjectException
      Sets the comment. This field must contain a valid value in order to create this type of business object in the database. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getReadFlag

      public boolean getReadFlag() throws BusinessObjectException
      Gets the flag that identifies whether a comment is read by a particular user. 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 ReadFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setReadFlag

      public void setReadFlag(boolean b) throws BusinessObjectException
      Sets the flag that identifies whether a comment is read by a particular user. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTimeDiff

      public String getTimeDiff() throws BusinessObjectException
      Gets this field gives the time diffrence between current and createdate. 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 TimeDiff
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this activity code was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDeleteDate

      public Date getDeleteDate() throws BusinessObjectException
      Gets the date this activity code was deleted.
      Returns:
      the value in the field DeleteDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDeleteDate

      public void setDeleteDate(Date d) throws BusinessObjectException
      Sets the date this activity code was deleted.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

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

    • getDeleteUser

      public String getDeleteUser() throws BusinessObjectException
      Gets the name of the user that deleted the comment.
      Returns:
      the value in the field DeleteUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDeleteUser

      public void setDeleteUser(String s) throws BusinessObjectException
      Sets the name of the user that deleted the comment.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsRejected

      public boolean getIsRejected() throws BusinessObjectException
      Gets this field indicated whether activity is rejected or Not.
      Returns:
      the value in the field IsRejected
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsRejected

      public void setIsRejected(boolean b) throws BusinessObjectException
      Sets this field indicated whether activity is rejected or Not.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRejectionComments

      public String getRejectionComments() throws BusinessObjectException
      Gets the job data for the job service.
      Returns:
      the value in the field RejectionComments
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setRejectionComments

      public void setRejectionComments(String s) throws BusinessObjectException
      Sets the job data for the job service.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAssignmentObjectId

      public ObjectId getAssignmentObjectId() throws BusinessObjectException
      Gets the unique ID of the Assignment to which this comment is added.
      Returns:
      the value in the field AssignmentObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAssignmentObjectId

      public void setAssignmentObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the Assignment to which this comment is added.
      Parameters:
      o - the value to set this field to
      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 activity code.
      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 ActivityComment object in the database.
      Returns:
      ObjectId the unique ID of the newly created ActivityComment 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, ActivityComment[] activitycomments) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple ActivityComment objects in the database.
      Parameters:
      session - the Session object
      activitycomments - array of ActivityComment objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created ActivityComment 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 ActivityComment load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single ActivityComment object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the ActivityComment object
      Returns:
      ActivityComment the ActivityComment 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<ActivityComment> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple ActivityComment objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the ActivityComment 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 ActivityComment 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, ActivityComment[] activitycomments) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple ActivityComment objects in the database.
      Parameters:
      session - the Session object
      activitycomments - array of ActivityComment 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