# Uses of Class
com.ads.api.beans.common.Document

Packages that use Document
Package
Description
com.ads.api.beans.common
Contains Collection Classes,Java Bean Classes which are common to all the modules like AMMObjectTypes, APIConstants, ImportHelper etc.
com.ads.api.beans.mm
Contains Collection Classes,Java Bean Classes which are specific to Mappings, MappingSpecifications, Project and Subject.
com.ads.api.util
Contains Utility Classes, Collection Classes, Java Bean Classes which are specific to System, Environment, Table, Column, Mappings, Subject, KeyValue Pairs, ROle, Business Glossary Catalog, Document etc...

- ## Uses of Document in com.ads.api.beans.common

  Methods in com.ads.api.beans.common that return Document
  Modifier and Type
  Method
  Description
  `Document`
  Document.`setApprovalRequired(boolean approvalRequired)`
  Method sets the approvalRequired as specified.
  `Document`
  Document.`setAuditHistory(AuditHistory auditHistory)`
  Method sets the documentStatus as specified.
  `Document`
  Document.`setDocumentApprovedBy(String documentApprovedBy)`
  Method sets the documentApprovedBy as specified.
  `Document`
  Document.`setDocumentApprovedDate(Date documentApprovedDate)`
  Method sets the documentApprovedDate as specified.
  `Document`
  Document.`setDocumentId(int documentId)`
  Method to set the documentId as specified.
  `Document`
  Document.`setDocumentIntendedPurpose(String documentIntendedPurpose)`
  Sets the documentIntendedPurpose as specified.
  `Document`
  Document.`setDocumentLink(String documentLink)`
  Sets the documentLink as specified.
  `Document`
  Document.`setDocumentName(String documentName)`
  Method sets the documentName as specified.
  `Document`
  Document.`setDocumentObject(String documentObject)`
  Method sets the documentObject as specified.
  `Document`
  Document.`setDocumentOwner(String documentOwner)`
  Method sets the documentOwner as specified.
  `Document`
  Document.`setDocumentReference(String documentReference)`
  Method sets the documentReference as specified.
  `Document`
  Document.`setDocumentReferenceNumber(String documentReferenceNumber)`
  Method sets the documentReferenceNumber as specified.
  `Document`
  Document.`setDocumentStatus(String documentStatus)`
  Method sets the documentStatus as specified.
  `Document`
  Document.`setDocumentType(String documentType)`
  Method sets the type of the Document.
  `Document`
  Document.`setUserData(String key, String val)`
  Method sets the userData as specified.
  `Document`
  Document.`setUserData(HashMap<String,String> userData)`
  Method sets the userData as specified.

- ## Uses of Document in com.ads.api.beans.mm

  Methods in com.ads.api.beans.mm that return types with arguments of type Document
  Modifier and Type
  Method
  Description
  `ArrayList<Document>`
  Mapping.`getMappingDocuments()`
  Returns the mappingDocuments Details i.e DocumentName, DocumentType, DocumentObject etc...
  `ArrayList<Document>`
  Project.`getProjectDocuments()`
  Returns the projectDocuments associated with the Project.
  Methods in com.ads.api.beans.mm with parameters of type Document
  Modifier and Type
  Method
  Description
  `void`
  Project.`addDocument(Document doc)`
  Adds a Document to the Project.
  Method parameters in com.ads.api.beans.mm with type arguments of type Document
  Modifier and Type
  Method
  Description
  `void`
  Mapping.`setMappingDocuments(ArrayList<Document> mappingDocuments)`
  Method sets the mappingDocuments as specified.
  `void`
  Project.`setProjectDocuments(ArrayList<Document> projectDocuments)`
  Method sets the projectDocuments as specified.

- ## Uses of Document in com.ads.api.util

  Methods in com.ads.api.util that return Document
  Modifier and Type
  Method
  Description
  `Document`
  DocumentUtil.`getDocument(int documentId)`
  Returns the Document Details with the specified documentId.
  `Document`
  DocumentUtil.`getDocument(Node.NodeType nodeType, int nodeId, String documentName)`
  Returns the document Details with the given documentName of the specified nodeId of nodeType.
  `Document`
  SystemManagerUtil.`getDocument(Node.NodeType nodeType, int docId)`
  Returns the Document object for the specified docId of nodeType.
  Methods in com.ads.api.util that return types with arguments of type Document
  Modifier and Type
  Method
  Description
  `List<Document>`
  DocumentUtil.`getDocuments(Node.NodeType nodeType, int nodeId)`
  Returns the documents of the specified nodeId of nodeType.
  `List<Document>`
  DocumentUtil.`getDocuments(List<Integer> documentIds)`
  Returns the Documents of the specified List of DocumentIds.
  `ArrayList<Document>`
  SystemManagerUtil.`getDocuments(Node.NodeType nodeType, List<Integer> docIds)`
  Returns the List of Document object for the specified List of docId's of the nodeType.
  `ArrayList<Document>`
  SystemManagerUtil.`getEnvironmentDocuments(int environmentId)`
  Returns the List of Document objects for the specified environmentId.
  `ArrayList<Document>`
  MappingManagerUtil.`getMappingDocuments(int mappingId)`
  Returns the List of Mapping Document objects for the specified mappingId.
  `ArrayList<Document>`
  MappingManagerUtil.`getProjectDocuments(int projectId)`
  Returns the List of project documents for the specified projectId.
  `ArrayList<Document>`
  SystemManagerUtil.`getSystemDocuments(int systemId)`
  Returns the list of systemDocuments for the specified systemId.
  Methods in com.ads.api.util with parameters of type Document
  Modifier and Type
  Method
  Description
  `RequestStatus`
  DocumentUtil.`addDocument(Node.NodeType nodeType, int nodeId, Document document)`
  Document is added at the NodeId of the given nodeType with the document details.
  `RequestStatus`
  SystemManagerUtil.`addDocument(int nodeId, Node.NodeType nodeType, Document document)`
  Document is added for the specified nodeId of nodeType.
  `RequestStatus`
  SystemManagerUtil.`addDocument(String nodeName, int parentNodeId, Node.NodeType parentNodeType, Document document)`
  Document is added for the specified nodeName, parentNodeId of parentNodeType.
  `RequestStatus`
  MappingManagerUtil.`addMappingDocument(int mapId, Document document)`
  MappingDocument is added for the specified mapId.
  `RequestStatus`
  MappingManagerUtil.`addMappingDocument(int nodeId, Node.NodeType nodeType, String mapName, Document document)`
  MappingDocument is added for the specified mapName.
  `RequestStatus`
  DocumentUtil.`updateDocument(Document document)`
  Updates Document with the specified document Object.
  `RequestStatus`
  DocumentUtil.`updateDocument(Node.NodeType nodeType, int nodeId, String documentName, Document document)`
  Specified documentName is updated with the document Details, of the given nodeId of nodeType.
  `RequestStatus`
  SystemManagerUtil.`updateDocument(Node.NodeType nodeType, Document document)`
  Document is updated as specified in Document Object of the given nodeType.
  Method parameters in com.ads.api.util with type arguments of type Document
  Modifier and Type
  Method
  Description
  `RequestStatus`
  DocumentUtil.`addDocuments(Node.NodeType nodeType, int nodeId, List<Document> documents)`
  Documents are added at the NodeId of the given nodeType with the documentsObjJson details.
  `RequestStatus`
  DocumentUtil.`updateDocuments(List<Document> documents)`
  Documents are updated with the specified Document Objects.