Package com.primavera.integration.client.bo.object

Class Document

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.Document
public class Document extends BusinessObject

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 Details

    • 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 Details

    • loadProject

      public Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadResource

      public Resource loadResource(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, 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(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(String[] fields, String sWhereClause, 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(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(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(String[] fields, String sWhereClause, 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(String[] fields, String sWhereClause, 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

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the activity to which the activity document applies.
      Returns:
      the value in the field ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityObjectId

      public void setActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the activity to which the activity document applies.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      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. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      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 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 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 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 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(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 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(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

    • getDocumentStatusName

      public DocumentStatusName getDocumentStatusName() throws BusinessObjectException
      Gets the description of the document status name. 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 DocumentStatusName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDocumentStatusName

      public void setDocumentStatusName(DocumentStatusName enm) throws BusinessObjectException
      Sets the description of the document status name. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDocumentStatusCodeName

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

    • getContentRepositoryDocumentInternalId

      public String getContentRepositoryDocumentInternalId() throws BusinessObjectException
      Gets the internal ID of the content repository document.
      Returns:
      the value in the field ContentRepositoryDocumentInternalId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setContentRepositoryDocumentInternalId

      public void setContentRepositoryDocumentInternalId(String s) throws BusinessObjectException
      Sets the internal ID of the content repository document.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getGUID

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

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

      public static 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 String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields

    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields

    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array

    • getMainFields

      public static 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 String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields

    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names

    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields

    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.

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