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

Class ProjectThreshold

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

Project thresholds are used as a project management technique to monitor values within a specified tolerance range so that project issues can be identified and reported. For example, a threshold could be used to monitor Start Date variance or Total Float values.

See Also:   Quick reference of ProjectThreshold fields

  • Constructor Details

    • ProjectThreshold

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

    • ProjectThreshold

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

    • ProjectThreshold

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

    • 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

    • loadOBS

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

    • loadWBS

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

    • loadThresholdParameter

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

    • loadProjectIssues

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

    • 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

    • getProjectObjectId

      public ObjectId getProjectObjectId() throws BusinessObjectException
      Gets the unique ID of the associated project for this project threshold. 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 the unique ID of the associated project for this project threshold. 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

    • getOBSObjectId

      public ObjectId getOBSObjectId() throws BusinessObjectException
      Gets the unique ID of the associated OBS for this project threshold. 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 OBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOBSObjectId

      public void setOBSObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated OBS for this project threshold. 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

    • getThresholdParameterObjectId

      public ObjectId getThresholdParameterObjectId() throws BusinessObjectException
      Gets the unique ID of the associated threshold parameter for this project threshold. 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 ThresholdParameterObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setThresholdParameterObjectId

      public void setThresholdParameterObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated threshold parameter for this project threshold. 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

    • getStatus

      public ThresholdStatus getStatus() throws BusinessObjectException
      Gets the current status of the project threshold.
      Returns:
      the value in the field Status
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStatus

      public void setStatus(ThresholdStatus enm) throws BusinessObjectException
      Sets the current status of the project threshold.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIssuePriority

      public IssuePriority getIssuePriority() throws BusinessObjectException
      Gets the priority of any issues generated from the project threshold.
      Returns:
      the value in the field IssuePriority
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIssuePriority

      public void setIssuePriority(IssuePriority enm) throws BusinessObjectException
      Sets the priority of any issues generated from the project threshold.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDetailToMonitor

      public ThresholdMonitorDetail getDetailToMonitor() throws BusinessObjectException
      Gets the level of detail to monitor, either Activity or WBS. The project threshold is calculated at the activity level or at the WBS level, whichever is selected.
      Returns:
      the value in the field DetailToMonitor
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDetailToMonitor

      public void setDetailToMonitor(ThresholdMonitorDetail enm) throws BusinessObjectException
      Sets the level of detail to monitor, either Activity or WBS. The project threshold is calculated at the activity level or at the WBS level, whichever is selected.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSObjectId

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

    • setWBSObjectId

      public void setWBSObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated WBS for this project threshold. 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

    • getLowerThreshold

      public double getLowerThreshold() throws BusinessObjectException
      Gets the lower value of a project threshold that will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be less than or equal to the lower project threshold value. If the lower project threshold value is null, it is ignored. Example: The Total Float lower project threshold is set to one day. Whenever the observed total float is less than or equal to one day, a project issue is raised.
      Returns:
      the value in the field LowerThreshold
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLowerThreshold

      public void setLowerThreshold(double d) throws BusinessObjectException
      Sets the lower value of a project threshold that will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be less than or equal to the lower project threshold value. If the lower project threshold value is null, it is ignored. Example: The Total Float lower project threshold is set to one day. Whenever the observed total float is less than or equal to one day, a project issue is raised.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUpperThreshold

      public double getUpperThreshold() throws BusinessObjectException
      Gets the upper value of a project threshold parameter which will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be greater than or equal to the upper project threshold value. If the upper project threshold value is null, it is ignored. Example: The Cost % of Planned upper project threshold is set to 120%. Whenever the actual cost is greater than or equal to 120% of planned, an issue is raised.
      Returns:
      the value in the field UpperThreshold
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUpperThreshold

      public void setUpperThreshold(double d) throws BusinessObjectException
      Sets the upper value of a project threshold parameter which will trigger an issue. An issue is identified by the project threshold monitor when the actual/observed value of the project threshold parameter is found to be greater than or equal to the upper project threshold value. If the upper project threshold value is null, it is ignored. Example: The Cost % of Planned upper project threshold is set to 120%. Whenever the actual cost is greater than or equal to 120% of planned, an issue is raised.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFromDate

      public Date getFromDate() throws BusinessObjectException
      Gets the starting custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored. 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 FromDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFromDate

      public void setFromDate(Date d) throws BusinessObjectException
      Sets the starting custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getToDate

      public Date getToDate() throws BusinessObjectException
      Gets the ending custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored. 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 ToDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setToDate

      public void setToDate(Date d) throws BusinessObjectException
      Sets the ending custom date of the time window that is monitored against a project threshold. Any activities or WBS elements with start/finish dates which intersect this time window are monitored. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFromDateExpression

      public String getFromDateExpression() throws BusinessObjectException
      Gets the expression for the starting date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5D, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the FromDate and FromDateExpression fields, the FromDateExpression will be ignored.
      Returns:
      the value in the field FromDateExpression
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFromDateExpression

      public void setFromDateExpression(String s) throws BusinessObjectException
      Sets the expression for the starting date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5D, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the FromDate and FromDateExpression fields, the FromDateExpression will be ignored.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getToDateExpression

      public String getToDateExpression() throws BusinessObjectException
      Gets the expression for the ending date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5d, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the ToDate and ToDateExpression fields, the ToDateExpression will be ignored.
      Returns:
      the value in the field ToDateExpression
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setToDateExpression

      public void setToDateExpression(String s) throws BusinessObjectException
      Sets the expression for the ending date of the time window that is monitored against a project threshold. Valid values are PS (the project StartDate), PF (the project FinishDate), DD (the project Data Date), CD (Current Date), CW (Current Week), or CM (Current Month). All values can be combined with arithmetic operators + or - and a numerical calendar value. For example, PS+5d, DD-1M. The calendar abbreviation specified in the expression (H, D, W, M, Y) must match the value of the corresponding GlobalPreferences field: HourChar, DayChar, WeekChar, MonthChar, or YearChar. You could specify a custom date by setting a date value for the FromDate field. If you set values for both the ToDate and ToDateExpression fields, the ToDateExpression will be ignored.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSCode

      public String getWBSCode() throws BusinessObjectException
      Gets the short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.
      Returns:
      the value in the field WBSCode
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSName

      public String getWBSName() throws BusinessObjectException
      Gets the name of the WBS element.
      Returns:
      the value in the field WBSName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProjectId

      public String getProjectId() throws BusinessObjectException
      Gets the Project short code that uniquely identifies the project.
      Returns:
      the value in the field ProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCreateDate

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

    • 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

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