|
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.Document
public class Document
Documents are guidelines, procedures, standards, plans, design templates, worksheets, or other information related to a project. A document, or work product, can provide standards and guidelines for performing project work, or it can be formally identified as a project standard. Documents can be identified as project deliverables that will be given to the end user or customer at the end of the project. Documents can be assigned to activities and to work breakdown structure (WBS) elements. You can maintain general information about documents, such as revision date, location, and author. Documents are hierarchical objects.
This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.
See Also: Quick reference of Document fields
Constructor Summary | |
---|---|
Document(Session session)
Class constructor specifying the Session. |
|
Document(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
Document(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 Document object in the database. |
static ObjectId[] |
create(Session session,
Document[] documents)
Creates multiple Document objects in the database. |
ObjectId |
createDocumentChild(Document documentchild)
Creates an associated Document object in the database. |
ObjectId[] |
createDocumentChildren(Document[] documentchildren)
Creates multiple associated Document objects in the database. |
void |
delete()
Deletes this Document object from the database. |
static void |
delete(Session session,
Document[] documents)
Deletes multiple Document objects from the database. |
static String[] |
getAllFields()
Gets all fields for this business object. |
String |
getAuthor()
Gets the person who created the work product or document. |
String |
getContentRepositoryDocumentInternalId()
Gets the internal ID of the content repository document. |
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. |
boolean |
getDeliverable()
Gets the flag that indicates that the work product or document is a project deliverable. |
String |
getDescription()
Gets the narrative description of the work product or document. |
String |
getDocumentCategoryName()
Gets the name of the associated document category. |
ObjectId |
getDocumentCategoryObjectId()
Gets the unique ID of the associated document category. |
String |
getDocumentStatusCodeName()
Gets the name of the associated document status code. |
ObjectId |
getDocumentStatusCodeObjectId()
Gets the unique ID of the associated document status code. |
DocumentType |
getDocumentType()
Gets the type of document: 'Non-Collaboration' or 'Collaboration'. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
String |
getGUID()
Gets the globally unique ID generated by the system. |
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 document was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this document. |
static String[] |
getMainFields()
Gets all fields in the main group for this business object. |
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. |
ObjectId |
getParentObjectId()
Gets the unique ID of the parent document of this document in the hierarchy. |
String |
getPrivateLocation()
Gets the work product or document's private file location. |
String |
getProjectId()
Gets the short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
String |
getPublicLocation()
Gets the work product or document's publicly-accessible file location. |
String |
getReferenceNumber()
Gets the work product or document's reference or catalog number. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
String |
getResourceId()
Gets the short code that uniquely identifies the associated resource. |
String |
getResourceName()
Gets the name of the associated resource. |
ObjectId |
getResourceObjectId()
Gets the unique ID of the associated resource. |
Date |
getRevisionDate()
Gets the date of the work product or document's last update. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
String |
getTitle()
Gets the title or name of a project work product or document. |
String |
getVersion()
Gets the work product or document's version number. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static Document |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single Document object from the database. |
static BOIterator<Document> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple Document objects from the database. |
DocumentCategory |
loadDocumentCategory(String[] fields)
Loads an associated DocumentCategory object from the database. |
BOIterator<Document> |
loadDocumentChildren(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated Document objects from the database. |
DocumentStatusCode |
loadDocumentStatusCode(String[] fields)
Loads an associated DocumentStatusCode object from the database. |
Document |
loadParentDocument(String[] fields)
Loads an associated Document object from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
BOIterator<ProjectDocument> |
loadProjectDocuments(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated ProjectDocument objects from the database. |
Resource |
loadResource(String[] fields)
Loads an associated Resource object from the database. |
static BOIterator<Document> |
loadRootDocuments(Session session,
String[] fields)
Loads the root Document objects from the database. |
BOIterator<UDFValue> |
loadUDFValues(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated UDFValue objects from the database. |
void |
setAuthor(String s)
Sets the person who created the work product or document. |
void |
setDeliverable(boolean b)
Sets the flag that indicates that the work product or document is a project deliverable. |
void |
setDescription(String s)
Sets the narrative description of the work product or document. |
void |
setDocumentCategoryObjectId(ObjectId o)
Sets the unique ID of the associated document category. |
void |
setDocumentStatusCodeObjectId(ObjectId o)
Sets the unique ID of the associated document status code. |
void |
setDocumentType(DocumentType enm)
Sets the type of document: 'Non-Collaboration' or 'Collaboration'. |
void |
setGUID(String s)
Sets the globally unique ID generated by the system. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setParentObjectId(ObjectId o)
Sets the unique ID of the parent document of this document in the hierarchy. |
void |
setPrivateLocation(String s)
Sets the work product or document's private file location. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project. |
void |
setPublicLocation(String s)
Sets the work product or document's publicly-accessible file location. |
void |
setReferenceNumber(String s)
Sets the work product or document's reference or catalog number. |
void |
setResourceObjectId(ObjectId o)
Sets the unique ID of the associated resource. |
void |
setRevisionDate(Date d)
Sets the date of the work product or document's last update. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
void |
setTitle(String s)
Sets the title or name of a project work product or document. |
void |
setVersion(String s)
Sets the work product or document's version number. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this Document object in the database. |
static void |
update(Session session,
Document[] documents)
Updates multiple Document 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 Document(Session session)
session
- the Sessionpublic Document(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Document(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 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 Resource loadResource(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 static BOIterator<Document> loadRootDocuments(Session session, String[] fields) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- 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 Document loadParentDocument(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 createDocumentChild(Document documentchild) throws ServerException, NetworkException, BusinessObjectException
documentchild
- DocumentChild object 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 ObjectId[] createDocumentChildren(Document[] documentchildren) throws ServerException, NetworkException, BusinessObjectException
documentchildren
- array of DocumentChild 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 BOIterator<Document> loadDocumentChildren(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 DocumentStatusCode loadDocumentStatusCode(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 DocumentCategory loadDocumentCategory(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 BOIterator<ProjectDocument> loadProjectDocuments(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 getParentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setParentObjectId(ObjectId o) throws BusinessObjectException
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 String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getResourceObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setResourceObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getResourceName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setTitle(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getReferenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setReferenceNumber(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getDocumentStatusCodeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDocumentStatusCodeObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDocumentStatusCodeName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getDocumentCategoryObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDocumentCategoryObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDocumentCategoryName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getAuthor() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setAuthor(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getVersion() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setVersion(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getRevisionDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRevisionDate(Date d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getDeliverable() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDeliverable(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getPrivateLocation() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPrivateLocation(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getPublicLocation() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPublicLocation(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic DocumentType getDocumentType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDocumentType(DocumentType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getContentRepositoryDocumentInternalId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getGUID() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setGUID(String s) throws BusinessObjectException
s
- the value to set this field to
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[] getMainFields()
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, Document[] documents) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectdocuments
- array of Document 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 Document load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the Document 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<Document> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the Document 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, Document[] documents) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectdocuments
- array of Document 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, Document[] documents) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectdocuments
- array of Document 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 |