Primavera Integration API 7.0

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

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.DocumentBase
              extended by com.primavera.integration.client.bo.object.Document

public class Document
extends com.primavera.integration.client.bo.base.DocumentBase

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 java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.lang.String getAuthor()
          Gets the person who created the work product or document.
 java.util.Date getCreateDate()
          Gets the date this document was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this document.
static java.lang.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.
 java.lang.String getDescription()
          Gets the narrative description of the work product or document.
 java.lang.String getDocumentCategoryName()
          Gets the name of the associated document category.
 ObjectId getDocumentCategoryObjectId()
          Gets the unique ID of the associated document category.
 java.lang.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 java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 java.lang.String getGUID()
          Gets the globally unique ID generated by the system.
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 document was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this document.
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
 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.
 java.lang.String getPrivateLocation()
          Gets the work product or document's private file location.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 java.lang.String getPublicLocation()
          Gets the work product or document's publicly-accessible file location.
 java.lang.String getReferenceNumber()
          Gets the work product or document's reference or catalog number.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 java.lang.String getResourceId()
          Gets the short code that uniquely identifies the associated resource.
 java.lang.String getResourceName()
          Gets the name of the associated resource.
 ObjectId getResourceObjectId()
          Gets the unique ID of the associated resource.
 java.util.Date getRevisionDate()
          Gets the date of the work product or document's last update.
 int getSequenceNumber()
          Gets the sequence number for sorting.
 java.lang.String getTitle()
          Gets the title or name of a project work product or document.
 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.
 java.lang.String getVersion()
          Gets the work product or document's version number.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Document load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Document object from the database.
static BOIterator<Document> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Document objects from the database.
 DocumentCategory loadDocumentCategory(java.lang.String[] fields)
          Loads an associated DocumentCategory object from the database.
 BOIterator<Document> loadDocumentChildren(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Document objects from the database.
 DocumentStatusCode loadDocumentStatusCode(java.lang.String[] fields)
          Loads an associated DocumentStatusCode object from the database.
 Document loadParentDocument(java.lang.String[] fields)
          Loads an associated Document object from the database.
 Project loadProject(java.lang.String[] fields)
          Loads an associated Project object from the database.
 BOIterator<ProjectDocument> loadProjectDocuments(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectDocument objects from the database.
 Resource loadResource(java.lang.String[] fields)
          Loads an associated Resource object from the database.
static BOIterator<Document> loadRootDocuments(Session session, java.lang.String[] fields)
          Loads the root Document objects 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.
 void setAuthor(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String s)
          Sets the work product or document's publicly-accessible file location.
 void setReferenceNumber(java.lang.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(java.util.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(java.lang.String s)
          Sets the title or name of a project work product or document.
 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 setVersion(java.lang.String s)
          Sets the work product or document's version number.
 java.lang.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

Document

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

Document

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

Document

public Document(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 Document object in the database.

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

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

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

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the Document 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 Document 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,
                          Document[] documents)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Document objects in the database.

Parameters:
session - the Session object
documents - array of Document 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 Document 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,
                          Document[] documents)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple Document objects from the database.

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

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

loadRootDocuments

public static BOIterator<Document> loadRootDocuments(Session session,
                                                     java.lang.String[] fields)
                                              throws ServerException,
                                                     NetworkException,
                                                     BusinessObjectException
Loads the root Document objects from the database.

Parameters:
session - the Session object
fields - fields to load
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

loadParentDocument

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

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

createDocumentChild

public ObjectId createDocumentChild(Document documentchild)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Creates an associated Document object in the database.

Parameters:
documentchild - DocumentChild object to create
Returns:
ObjectId unique ID of the newly created Document 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

createDocumentChildren

public ObjectId[] createDocumentChildren(Document[] documentchildren)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Creates multiple associated Document objects in the database.

Parameters:
documentchildren - array of DocumentChild objects to create
Returns:
ObjectId[] array of object ids of newly created Document 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

loadDocumentChildren

public BOIterator<Document> loadDocumentChildren(java.lang.String[] fields,
                                                 java.lang.String sWhereClause,
                                                 java.lang.String sOrderBy)
                                          throws ServerException,
                                                 NetworkException,
                                                 BusinessObjectException
Loads multiple associated Document 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

loadDocumentStatusCode

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

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

loadDocumentCategory

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

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

loadProjectDocuments

public BOIterator<ProjectDocument> loadProjectDocuments(java.lang.String[] fields,
                                                        java.lang.String sWhereClause,
                                                        java.lang.String sOrderBy)
                                                 throws ServerException,
                                                        NetworkException,
                                                        BusinessObjectException
Loads multiple associated ProjectDocument 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

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

Overrides:
getUDFTypesAssigned in class com.primavera.integration.client.bo.base.DocumentBase
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

getParentObjectId

public ObjectId getParentObjectId()
                           throws BusinessObjectException
Gets the unique ID of the parent document of this document in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setParentObjectId

public void setParentObjectId(ObjectId o)
                       throws BusinessObjectException
Sets the unique ID of the parent document of this document in the hierarchy. 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

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

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

getTitle

public java.lang.String getTitle()
                          throws BusinessObjectException
Gets the title or name of a project work product or document.

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

setTitle

public void setTitle(java.lang.String s)
              throws BusinessObjectException
Sets the title or name of a project work product or document.

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

getReferenceNumber

public java.lang.String getReferenceNumber()
                                    throws BusinessObjectException
Gets the work product or document's reference or catalog number.

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

setReferenceNumber

public void setReferenceNumber(java.lang.String s)
                        throws BusinessObjectException
Sets the work product or document's reference or catalog number.

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

getDocumentStatusCodeObjectId

public ObjectId getDocumentStatusCodeObjectId()
                                       throws BusinessObjectException
Gets the unique ID of the associated document status code. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setDocumentStatusCodeObjectId

public void setDocumentStatusCodeObjectId(ObjectId o)
                                   throws BusinessObjectException
Sets the unique ID of the associated document status code. 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

getDocumentStatusCodeName

public java.lang.String getDocumentStatusCodeName()
                                           throws BusinessObjectException
Gets the name of the associated document status code.

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

getDocumentCategoryObjectId

public ObjectId getDocumentCategoryObjectId()
                                     throws BusinessObjectException
Gets the unique ID of the associated document category. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setDocumentCategoryObjectId

public void setDocumentCategoryObjectId(ObjectId o)
                                 throws BusinessObjectException
Sets the unique ID of the associated document category. 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

getDocumentCategoryName

public java.lang.String getDocumentCategoryName()
                                         throws BusinessObjectException
Gets the name of the associated document category.

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

getAuthor

public java.lang.String getAuthor()
                           throws BusinessObjectException
Gets the person who created the work product or document.

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

setAuthor

public void setAuthor(java.lang.String s)
               throws BusinessObjectException
Sets the person who created the work product or document.

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

getVersion

public java.lang.String getVersion()
                            throws BusinessObjectException
Gets the work product or document's version number.

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

setVersion

public void setVersion(java.lang.String s)
                throws BusinessObjectException
Sets the work product or document's version number.

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

getRevisionDate

public java.util.Date getRevisionDate()
                               throws BusinessObjectException
Gets the date of the work product or document's last update.

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

setRevisionDate

public void setRevisionDate(java.util.Date d)
                     throws BusinessObjectException
Sets the date of the work product or document's last update.

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

getDeliverable

public boolean getDeliverable()
                       throws BusinessObjectException
Gets the flag that indicates that the work product or document is a project deliverable.

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

setDeliverable

public void setDeliverable(boolean b)
                    throws BusinessObjectException
Sets the flag that indicates that the work product or document is a project deliverable.

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

getPrivateLocation

public java.lang.String getPrivateLocation()
                                    throws BusinessObjectException
Gets the work product or document's private file location.

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

setPrivateLocation

public void setPrivateLocation(java.lang.String s)
                        throws BusinessObjectException
Sets the work product or document's private file location.

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

getPublicLocation

public java.lang.String getPublicLocation()
                                   throws BusinessObjectException
Gets the work product or document's publicly-accessible file location.

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

setPublicLocation

public void setPublicLocation(java.lang.String s)
                       throws BusinessObjectException
Sets the work product or document's publicly-accessible file location.

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

getSequenceNumber

public int getSequenceNumber()
                      throws BusinessObjectException
Gets the sequence number for sorting.

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

setSequenceNumber

public void setSequenceNumber(int i)
                       throws BusinessObjectException
Sets the sequence number for sorting.

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

getDescription

public java.lang.String getDescription()
                                throws BusinessObjectException
Gets the narrative description of the work product or document. 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 Description
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setDescription

public void setDescription(java.lang.String s)
                    throws BusinessObjectException
Sets the narrative description of the work product or document. 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

getDocumentType

public DocumentType getDocumentType()
                             throws BusinessObjectException
Gets the type of document: 'Non-Collaboration' or 'Collaboration'.

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

setDocumentType

public void setDocumentType(DocumentType enm)
                     throws BusinessObjectException
Sets the type of document: 'Non-Collaboration' or 'Collaboration'.

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

getGUID

public java.lang.String getGUID()
                         throws BusinessObjectException
Gets the globally unique ID generated by the system.

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

setGUID

public void setGUID(java.lang.String s)
             throws BusinessObjectException
Sets the globally unique ID generated by the system.

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

getCreateDate

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

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

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

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.