Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class ProjectIssue

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.ProjectIssueBase
              extended by com.primavera.integration.client.bo.object.ProjectIssue

public class ProjectIssue
extends com.primavera.integration.client.bo.base.ProjectIssueBase

Issues are known problems within a project plan that require attention or corrective action. You can manually create issues, or you can generate issues in the Project Management application by defining project thresholds. You can associate these issues with work breakdown structure (WBS) elements, activities, or resources.

When you add an issue, you can assign a priority level, tracking layout, and responsible manager to the issue. An issue's tracking layout assignment is helpful when you want to quickly open the tracking layout that best displays the problem area. An issue's responsible manager assignment identifies the person responsible for addressing the issue. You can record historical details for the issue and e-mail issue details, along with your notes and the issue's history, to any member of the project's staff.

This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.

See Also:   Quick reference of ProjectIssue fields


Constructor Summary
ProjectIssue(Session session)
          Class constructor specifying the Session.
ProjectIssue(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ProjectIssue(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this ProjectIssue object in the database.
static ObjectId[] create(Session session, ProjectIssue[] projectissues)
          Creates multiple ProjectIssue objects in the database.
 void delete()
          Deletes this ProjectIssue object from the database.
static void delete(Session session, ProjectIssue[] projectissues)
          Deletes multiple ProjectIssue objects from the database.
 java.lang.String getActivityId()
          Gets the short ID that uniquely identifies the activity within the project.
 java.lang.String getActivityName()
          Gets the name of the activity.
 ObjectId getActivityObjectId()
          Gets the unique ID of the activity to which the project issue applies.
 double getActualValue()
          Gets the actual value of the threshold parameter for the project issue.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this project issue was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this project issue.
 java.util.Date getDateIdentified()
          Gets the date the project issue was identified.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 java.lang.String getIdentifiedBy()
          Gets the identifier of the project issue.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 java.util.Date getLastUpdateDate()
          Gets the date this project issue was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this project issue.
 double getLowerThreshold()
          Gets the lower value of the threshold parameter that triggered the project issue.
static java.lang.String[] getMainFields()
          Gets all fields in the main group for this business object.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the project issue.
 java.lang.String getNotes()
          Gets the notes associated with the project issue.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 java.lang.String getOBSName()
          Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".
 ObjectId getOBSObjectId()
          Gets the unique ID of the project manager from the project's OBS tree who is responsible for the project issue.
 IssuePriority getPriority()
          Gets the priority of the project issue.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 java.lang.String getProjectName()
          Gets the name of the associated project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 ObjectId getProjectThresholdObjectId()
          Gets the unique ID of the associated project threshold for the project issue.
 java.lang.String getRawTextNote()
          Gets the notes associated with the project issue.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 java.util.Date getResolutionDate()
          Gets the date the project issue was resolved.
 java.lang.String getResourceId()
          Gets the short code that uniquely identifies the resource.
 java.lang.String getResourceName()
          Gets the name of the resource.
 ObjectId getResourceObjectId()
          Gets the unique ID of the associated resource for this project issue.
 IssueStatus getStatus()
          Gets the current status of the project issue.
 ObjectId getThresholdParameterObjectId()
          Gets the unique ID of the associated threshold parameter for the project issue.
 ObjectId getUDFCode(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 Cost getUDFCost(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Double getUDFDouble(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 EndDate getUDFFinishDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 UDFIndicator getUDFIndicator(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.Integer getUDFInteger(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 BeginDate getUDFStartDate(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 java.lang.String getUDFText(ObjectId objId)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 ObjectId[] getUDFTypesAssigned()
          Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.
 double getUpperThreshold()
          Gets the upper value of the threshold parameter which triggered the project issue.
 java.lang.String getWBSCode()
          Gets the short code assigned to each WBS element for identification.
 java.lang.String getWBSName()
          Gets the name of the WBS element.
 ObjectId getWBSObjectId()
          Gets the unique ID of the WBS to which the project issue applies.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ProjectIssue load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ProjectIssue object from the database.
static BOIterator<ProjectIssue> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ProjectIssue objects from the database.
 Activity loadActivity(java.lang.String[] fields)
          Loads an associated Activity object from the database.
 IssueHistory loadIssueHistory(java.lang.String[] fields)
          Loads an associated IssueHistory object from the database.
 OBS loadOBS(java.lang.String[] fields)
          Loads an associated OBS object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 ProjectThreshold loadProjectThreshold(java.lang.String[] fields)
          Loads an associated ProjectThreshold object from the database.
 Resource loadResource(java.lang.String[] fields)
          Loads an associated Resource object from the database.
 ThresholdParameter loadThresholdParameter(java.lang.String[] fields)
          Loads an associated ThresholdParameter object from the database.
 BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UDFValue objects from the database.
 WBS loadWBS(java.lang.String[] fields)
          Loads an associated WBS object from the database.
 void setActivityObjectId(ObjectId o)
          Sets the unique ID of the activity to which the project issue applies.
 void setActualValue(double d)
          Sets the actual value of the threshold parameter for the project issue.
 void setDateIdentified(java.util.Date d)
          Sets the date the project issue was identified.
 void setIdentifiedBy(java.lang.String s)
          Sets the identifier of the project issue.
 void setLowerThreshold(double d)
          Sets the lower value of the threshold parameter that triggered the project issue.
 void setName(java.lang.String s)
          Sets the name of the project issue.
 void setNotes(java.lang.String s)
          Sets the notes associated with the project issue.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setOBSObjectId(ObjectId o)
          Sets the unique ID of the project manager from the project's OBS tree who is responsible for the project issue.
 void setPriority(IssuePriority enm)
          Sets the priority of the project issue.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setResolutionDate(java.util.Date d)
          Sets the date the project issue was resolved.
 void setResourceObjectId(ObjectId o)
          Sets the unique ID of the associated resource for this project issue.
 void setStatus(IssueStatus enm)
          Sets the current status of the project issue.
 void setUDFCode(ObjectId objId, ObjectId code)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFCost(ObjectId objId, Cost cost)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFDouble(ObjectId objId, java.lang.Double n)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFFinishDate(ObjectId objId, EndDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFIndicator(ObjectId objId, UDFIndicator ind)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFInteger(ObjectId objId, java.lang.Integer i)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFStartDate(ObjectId objId, BeginDate date)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUDFText(ObjectId objId, java.lang.String s)
          Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.
 void setUpperThreshold(double d)
          Sets the upper value of the threshold parameter which triggered the project issue.
 void setWBSObjectId(ObjectId o)
          Sets the unique ID of the WBS to which the project issue applies.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ProjectIssue object in the database.
static void update(Session session, ProjectIssue[] projectissues)
          Updates multiple ProjectIssue objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProjectIssue

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

ProjectIssue

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

ProjectIssue

public ProjectIssue(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 Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this ProjectIssue object in the database.

Returns:
ObjectId the unique ID of the newly created ProjectIssue 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,
                                ProjectIssue[] projectissues)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ProjectIssue objects in the database.

Parameters:
session - the Session object
projectissues - array of ProjectIssue objects to create
Returns:
ObjectId[] the array of unique IDs of newly created ProjectIssue 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 ProjectIssue load(Session session,
                                java.lang.String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Loads a single ProjectIssue object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ProjectIssue object
Returns:
ProjectIssue the ProjectIssue 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<ProjectIssue> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Loads multiple ProjectIssue objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ProjectIssue 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 ProjectIssue object in the database.

Overrides:
update in class BOBase
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,
                          ProjectIssue[] projectissues)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ProjectIssue objects in the database.

Parameters:
session - the Session object
projectissues - array of ProjectIssue 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 ProjectIssue object from the database.

Overrides:
delete in class BOBase
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,
                          ProjectIssue[] projectissues)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ProjectIssue objects from the database.

Parameters:
session - the Session object
projectissues - array of ProjectIssue 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

loadProject

public Project loadProject(java.lang.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

loadActivity

public Activity loadActivity(java.lang.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

loadResource

public Resource loadResource(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated Resource object from the database.

Parameters:
fields - fields to load
Returns:
Resource the Resource 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(java.lang.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(java.lang.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

loadIssueHistory

public IssueHistory loadIssueHistory(java.lang.String[] fields)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Loads an associated IssueHistory object from the database.

Parameters:
fields - fields to load
Returns:
IssueHistory the IssueHistory 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

loadProjectThreshold

public ProjectThreshold loadProjectThreshold(java.lang.String[] fields)
                                      throws ServerException,
                                             NetworkException,
                                             BusinessObjectException
Loads an associated ProjectThreshold object from the database.

Parameters:
fields - fields to load
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

loadThresholdParameter

public ThresholdParameter loadThresholdParameter(java.lang.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

loadUDFValues

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

getUDFTypesAssigned

@Deprecated
public ObjectId[] getUDFTypesAssigned()
                               throws BusinessObjectException
Deprecated. As of release 5.0 SP3, determine the UDF assignments using the UDFValue object.

Gets the ObjectIds of all UDFTypes for which UDFs are assigned to this project issue.

Overrides:
getUDFTypesAssigned in class com.primavera.integration.client.bo.base.ProjectIssueBase
Returns:
ObjectId array of UDFType
Throws:
BusinessObjectException

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

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.

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

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the 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

getResourceObjectId

public ObjectId getResourceObjectId()
                             throws BusinessObjectException
Gets the unique ID of the associated resource for this project issue. If a parent resource is selected, the issue applies to all child resources as well. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ResourceObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setResourceObjectId

public void setResourceObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the associated resource for this project issue. If a parent resource is selected, the issue applies to all child resources as well. 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

getResourceId

public java.lang.String getResourceId()
                               throws BusinessObjectException
Gets the short code that uniquely identifies the resource.

Returns:
the value in the field ResourceId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getResourceName

public java.lang.String getResourceName()
                                 throws BusinessObjectException
Gets the name of the resource.

Returns:
the value in the field ResourceName
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 the project issue applies. This field is automatically loaded by default whenever this type of business object is loaded from 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 the project issue applies. 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 project manager from the project's OBS tree who is responsible for the project issue. This field is automatically loaded by default whenever this type of business object is loaded from 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 project manager from the project's OBS tree who is responsible for the project issue. 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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the project issue. Issues which are automatically generated by the threshold monitor are named after the threshold parameter that triggered the project issue. 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 Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the project issue. Issues which are automatically generated by the threshold monitor are named after the threshold parameter that triggered the project issue. 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

getPriority

public IssuePriority getPriority()
                          throws BusinessObjectException
Gets the priority of the project issue. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'.

Returns:
the value in the field Priority
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setPriority

public void setPriority(IssuePriority enm)
                 throws BusinessObjectException
Sets the priority of the project issue. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'.

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getResolutionDate

public java.util.Date getResolutionDate()
                                 throws BusinessObjectException
Gets the date the project issue was resolved.

Returns:
the value in the field ResolutionDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setResolutionDate

public void setResolutionDate(java.util.Date d)
                       throws BusinessObjectException
Sets the date the project issue was resolved.

Parameters:
d - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getOBSName

public java.lang.String getOBSName()
                            throws BusinessObjectException
Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager".

Returns:
the value in the field OBSName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getWBSCode

public java.lang.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 java.lang.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

getProjectName

public java.lang.String getProjectName()
                                throws BusinessObjectException
Gets the name of the associated project.

Returns:
the value in the field ProjectName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getIdentifiedBy

public java.lang.String getIdentifiedBy()
                                 throws BusinessObjectException
Gets the identifier of the project issue. This may be the name of the user who created the project issue or Monitor, if the project issue was automatically generated by the threshold monitor.

Returns:
the value in the field IdentifiedBy
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setIdentifiedBy

public void setIdentifiedBy(java.lang.String s)
                     throws BusinessObjectException
Sets the identifier of the project issue. This may be the name of the user who created the project issue or Monitor, if the project issue was automatically generated by the threshold monitor.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDateIdentified

public java.util.Date getDateIdentified()
                                 throws BusinessObjectException
Gets the date the project issue was identified.

Returns:
the value in the field DateIdentified
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setDateIdentified

public void setDateIdentified(java.util.Date d)
                       throws BusinessObjectException
Sets the date the project issue was identified.

Parameters:
d - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNotes

public java.lang.String getNotes()
                          throws BusinessObjectException
Gets the notes associated with the project issue. 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 Notes
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setNotes

public void setNotes(java.lang.String s)
              throws BusinessObjectException
Sets the notes associated with the project issue. 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

getRawTextNote

public java.lang.String getRawTextNote()
                                throws BusinessObjectException
Gets the notes associated with the project issue. 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 RawTextNote
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActivityName

public java.lang.String getActivityName()
                                 throws BusinessObjectException
Gets the name of the activity. The activity name does not have to be unique.

Returns:
the value in the field ActivityName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActivityId

public java.lang.String getActivityId()
                               throws BusinessObjectException
Gets the short ID that uniquely identifies the activity within the project.

Returns:
the value in the field ActivityId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getStatus

public IssueStatus getStatus()
                      throws BusinessObjectException
Gets the current status of the project issue. Valid values are 'Open', 'On Hold', and 'Closed'.

Returns:
the value in the field Status
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setStatus

public void setStatus(IssueStatus enm)
               throws BusinessObjectException
Sets the current status of the project issue. Valid values are 'Open', 'On Hold', and 'Closed'.

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 WBS to which the project issue applies. If a parent WBS is selected, the project issue applies to all child elements as well. If the top WBS is selected, the project issue applies to the entire project. 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 WBS to which the project issue applies. If a parent WBS is selected, the project issue applies to all child elements as well. If the top WBS is selected, the project issue applies to the entire project. 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

getUpperThreshold

public double getUpperThreshold()
                         throws BusinessObjectException
Gets the upper value of the threshold parameter which triggered the project issue. Issues are triggered when the actual/observed parameters values are greater than or equal to the upper threshold.

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 the threshold parameter which triggered the project issue. Issues are triggered when the actual/observed parameters values are greater than or equal to the upper threshold.

Parameters:
d - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getActualValue

public double getActualValue()
                      throws BusinessObjectException
Gets the actual value of the threshold parameter for the project issue. Issues are automatically generated by the threshold monitor when actual values of threshold parameters exceed target values.

Returns:
the value in the field ActualValue
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setActualValue

public void setActualValue(double d)
                    throws BusinessObjectException
Sets the actual value of the threshold parameter for the project issue. Issues are automatically generated by the threshold monitor when actual values of threshold parameters exceed target values.

Parameters:
d - 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 the threshold parameter that triggered the project issue. Issues are triggered when the actual/observed parameters values are less than or equal to the lower threshold.

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 the threshold parameter that triggered the project issue. Issues are triggered when the actual/observed parameters values are less than or equal to the lower threshold.

Parameters:
d - 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 the project issue. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ThresholdParameterObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectThresholdObjectId

public ObjectId getProjectThresholdObjectId()
                                     throws BusinessObjectException
Gets the unique ID of the associated project threshold for the project issue. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ProjectThresholdObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this project issue was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this project issue was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this project issue.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this project issue.

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

getUDFCost

@Deprecated
public Cost getUDFCost(ObjectId objId)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Cost the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFCost

@Deprecated
public void setUDFCost(ObjectId objId,
                                  Cost cost)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Cost user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
cost - the Cost value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFDouble

@Deprecated
public java.lang.Double getUDFDouble(ObjectId objId)
                              throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Double the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFDouble

@Deprecated
public void setUDFDouble(ObjectId objId,
                                    java.lang.Double n)
                  throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Double user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
n - the Double value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFFinishDate

@Deprecated
public EndDate getUDFFinishDate(ObjectId objId)
                         throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
EndDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFFinishDate

@Deprecated
public void setUDFFinishDate(ObjectId objId,
                                        EndDate date)
                      throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular FinishDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the FinishDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFIndicator

@Deprecated
public UDFIndicator getUDFIndicator(ObjectId objId)
                             throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
com.primavera.integration.client.bo.enm.UDFIndicator the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFIndicator

@Deprecated
public void setUDFIndicator(ObjectId objId,
                                       UDFIndicator ind)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Indicator user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
ind - the Indicator value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFInteger

@Deprecated
public java.lang.Integer getUDFInteger(ObjectId objId)
                                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
Integer the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFInteger

@Deprecated
public void setUDFInteger(ObjectId objId,
                                     java.lang.Integer i)
                   throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Integer user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
i - the Integer value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFStartDate

@Deprecated
public BeginDate getUDFStartDate(ObjectId objId)
                          throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
BeginDate the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFStartDate

@Deprecated
public void setUDFStartDate(ObjectId objId,
                                       BeginDate date)
                     throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular StartDate user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
date - the StartDate value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFText

@Deprecated
public java.lang.String getUDFText(ObjectId objId)
                            throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
String the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFText

@Deprecated
public void setUDFText(ObjectId objId,
                                  java.lang.String s)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Text user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
s - the Text value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUDFCode

@Deprecated
public ObjectId getUDFCode(ObjectId objId)
                    throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Gets the value of a particular Code user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
Returns:
ObjectId the UDF value
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUDFCode

@Deprecated
public void setUDFCode(ObjectId objId,
                                  ObjectId code)
                throws BusinessObjectException
Deprecated. As of release 5.0 SP3, UDFValue objects should be used for user defined field assignments.

Sets the value of a particular Code user defined field.

Parameters:
objId - the ObjectId of the UDFType business object
code - the Code value to set
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.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 java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getMainFields

public static java.lang.String[] getMainFields()
Gets all fields in the main group for this business object.

Returns:
String[] an array of fields in this group

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.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 java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.