|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.ProjectDocument
public class ProjectDocument
Project documents are a specific assignment of an individual document to a WBS or activity. Documents can be guidelines, procedures, standards, plans, design templates, worksheets, or other information related to a project.
See Also: Quick reference of ProjectDocument fields
Constructor Summary | |
---|---|
ProjectDocument(Session session)
Class constructor specifying the Session. |
|
ProjectDocument(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectDocument(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 ProjectDocument object in the database. |
static ObjectId[] |
create(Session session,
ProjectDocument[] projectdocuments)
Creates multiple ProjectDocument objects in the database. |
void |
delete()
Deletes this ProjectDocument object from the database. |
static void |
delete(Session session,
ProjectDocument[] projectdocuments)
Deletes multiple ProjectDocument objects from the database. |
String |
getActivityId()
Gets the short ID that uniquely identifies the activity within the project. |
String |
getActivityName()
Gets the name of the activity. |
ObjectId |
getActivityObjectId()
Gets the unique ID of the activity to which the activity document applies. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this document was created. |
String |
getCreateUser()
Gets the name of the user that created this document. |
static String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
ObjectId |
getDocumentObjectId()
Gets the unique ID of the document to which the activity document applies. |
String |
getDocumentTitle()
Gets the title or name of a document assigned to a WBS or activity within a project. |
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. |
boolean |
getIsWorkProduct()
Gets the flag that indicates whether the document is a work product. |
Date |
getLastUpdateDate()
Gets the date this document was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this document. |
static String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
String |
getProjectId()
Gets the short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the project to which the activity document applies. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
String |
getWBSCode()
Gets the short code assigned to each WBS element for identification. |
String |
getWBSName()
Gets the name of the WBS element. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the WBS to which the activity document applies. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ProjectDocument |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single ProjectDocument object from the database. |
static BOIterator<ProjectDocument> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple ProjectDocument objects from the database. |
Activity |
loadActivity(String[] fields)
Loads an associated Activity object from the database. |
Document |
loadDocument(String[] fields)
Loads an associated Document object from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
WBS |
loadWBS(String[] fields)
Loads an associated WBS object from the database. |
void |
setActivityObjectId(ObjectId o)
Sets the unique ID of the activity to which the activity document applies. |
void |
setDocumentObjectId(ObjectId o)
Sets the unique ID of the document to which the activity document applies. |
void |
setIsWorkProduct(boolean b)
Sets the flag that indicates whether the document is a work product. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the project to which the activity document applies. |
void |
setWBSObjectId(ObjectId o)
Sets the unique ID of the WBS to which the activity document applies. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectDocument object in the database. |
static void |
update(Session session,
ProjectDocument[] projectdocuments)
Updates multiple ProjectDocument 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 |
---|
public ProjectDocument(Session session)
session
- the Sessionpublic ProjectDocument(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectDocument(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public Document loadDocument(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Activity loadActivity(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic WBS loadWBS(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
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 objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActivityObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getDocumentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDocumentObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsWorkProduct() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsWorkProduct(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDocumentTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getWBSCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getWBSName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getActivityName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getActivityId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsTemplate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static String[] getRequiredCreateFields()
public static String[] getFilterableFields()
public static String[] getInternalDefaultLoadFields()
public static String[] getAllFields()
public static String[] getInternalAllFields()
public static Set<String> getInternalAllFieldsSet()
public static String[] getWritableFields()
public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
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 objectspublic static ObjectId[] create(Session session, ProjectDocument[] projectdocuments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectdocuments
- array of ProjectDocument objects to create
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 objectspublic static ProjectDocument load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectDocument object
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 objectspublic static BOIterator<ProjectDocument> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectDocument objects
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 objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class com.primavera.integration.client.BOBase
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 objectspublic static void update(Session session, ProjectDocument[] projectdocuments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectdocuments
- array of ProjectDocument objects to update
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 objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class com.primavera.integration.client.BOBase
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 objectspublic static void delete(Session session, ProjectDocument[] projectdocuments) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectdocuments
- array of ProjectDocument objects to delete
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
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |