com.primavera.integration.client.bo.object

Class IssueHistory

java.lang.Object

com.primavera.integration.client.BOBase

com.primavera.integration.client.bo.BusinessObject

com.primavera.integration.client.bo.object.IssueHistory

public class IssueHistory
extends BusinessObject

Issue histories represent the commentary recorded for a project issue. Separate entry comments are referenced by date and user who recorded the comment. Issue histories may only be added in the Project Management application.

See Also: Quick reference of IssueHistory fields

Constructor Summary

Constructors

Constructor and Description
IssueHistory(Session session) Class constructor specifying the Session.
IssueHistory(Session session, ObjectId objId) Class constructor specifying the Session and ObjectId of the object.
IssueHistory(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) Class constructor called internally after objects are retrieved from the server.

Method Summary

Modifier and Type	Method and Description
static String[]	getAllFields() Gets all fields for this business object.
Date	getCreateDate() Gets the date this issue history was created.
String	getCreateUser() Gets the name of the user that created this issue history.
static String[]	getDefaultXMLExportFields() Deprecated.
static String[]	getFilterableFields() Gets all fields that can be filtered.
static String[]	getInternalAllFields() An internal method that should not be called directly by client code.
static Set<String>	getInternalAllFieldsSet() An internal method that should not be called directly by client code.
static 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.
boolean	getIsTemplate() Gets the boolean value indicating if this business object is related to a template Project.
Date	getLastUpdateDate() Gets the date this issue history was last updated.
String	getLastUpdateUser() Gets the name of the user that last updated this issue history.
static String[]	getMinimumXMLExportFields() Gets all fields that are always exported at a minimum by the new flat XML exporter
String	getNotes() Gets the notes associated with the issue history.
ObjectId	getProjectIssueObjectId() Gets the unique ID of the associated project issue for this issue history.
ObjectId	getProjectObjectId() Gets the unique ID of the associated project for this issue history.
static String[]	getWritableFields() Gets all writable fields for this business object.
static IssueHistory	load(Session session, String[] fields, ObjectId objId) Loads a single IssueHistory object from the database.
static BOIterator<IssueHistory>	load(Session session, String[] fields, ObjectId[] objIds) Loads multiple IssueHistory objects from the database.
Project	loadProject(String[] fields) Loads an associated Project object from the database.
ProjectIssue	loadProjectIssue(String[] fields) Loads an associated ProjectIssue object from the database.
String	toString() Returns a string representation of the object.

Methods inherited from class com.primavera.integration.client.bo.BusinessObject

equals, getObjectId, getValue, getValue, hashCode, isNull, setNull, setObjectId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IssueHistory

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

IssueHistory

public IssueHistory(Session session,
                    ObjectId objId)
             throws BusinessObjectException

Class constructor specifying the Session and ObjectId of the object.

Parameters:

session - the Session

objId - the ObjectId

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

IssueHistory

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

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

loadProjectIssue

public ProjectIssue loadProjectIssue(String[] fields)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException

Loads an associated ProjectIssue object from the database.

Parameters:

fields - fields to load

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

getNotes

public String getNotes()
                throws BusinessObjectException

Gets the notes associated with the issue history. 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

getProjectIssueObjectId

public ObjectId getProjectIssueObjectId()
                                 throws BusinessObjectException

Gets the unique ID of the associated project issue for this issue history. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:

the value in the field ProjectIssueObjectId

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

getCreateDate

public Date getCreateDate()
                   throws BusinessObjectException

Gets the date this issue history 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 issue history 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 issue history.

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

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

getFilterableFields

public static String[] getFilterableFields()

Gets all fields that can be filtered.

Returns:

String[] an array of filterable fields

getInternalDefaultLoadFields

public static String[] getInternalDefaultLoadFields()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getAllFields

public static String[] getAllFields()

Gets all fields for this business object.

Returns:

String[] an array of all fields

getInternalAllFields

public static String[] getInternalAllFields()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getInternalAllFieldsSet

public static Set<String> getInternalAllFieldsSet()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getWritableFields

public static String[] getWritableFields()

Gets all writable fields for this business object.

Returns:

String[] an array of writable fields

getDefaultXMLExportFields

@Deprecated
public static String[] getDefaultXMLExportFields()

Deprecated.

Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.

Returns:

String[] an array of field names

getMinimumXMLExportFields

public static String[] getMinimumXMLExportFields()

Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:

String[] an array of exported fields

toString

public String toString()

Returns a string representation of the object. The output is in XML.

Overrides:

toString in class Object

Returns:

String a string representation of the object.

load

public static IssueHistory load(Session session,
                                String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException

Loads a single IssueHistory object from the database.

Parameters:

session - the Session object

fields - fields to load

objId - unique ID of the IssueHistory object

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

load

public static BOIterator<IssueHistory> load(Session session,
                                            String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException

Loads multiple IssueHistory objects from the database.

Parameters:

session - the Session object

fields - fields to load

objIds - object ids of the IssueHistory 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