@MTOM
public class DocumentsService
extends java.lang.Object
Constructor and Description |
---|
DocumentsService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addDocument(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentObjJson)
Document is added at the NodeId of the given nodeType with the
documentObjJson details.
|
java.lang.String |
addDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentsObjJsonArray)
Documents are added at the NodeId of the given nodeType with the
documentsObjJsonArray details.
|
java.lang.String |
deleteDocument(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
int documentId)
Deletes the Document with the specified documentId.
|
java.lang.String |
deleteDocumentByName(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentName)
Deletes the document with the given documentName of the specified nodeId
of nodeType.
|
java.lang.String |
deleteDocuments(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId)
Deletes the documents of the specified nodeId of nodeType.
|
java.lang.String |
deleteDocumentsByDocIds(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
java.lang.String documentIdsArray)
Documents are deleted for the specified List of DocumentIds.
|
java.lang.String |
getDocument(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
int documentId)
Returns the Document Details with the specified documentId.
|
java.lang.String |
getDocumentByName(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentName)
Returns the document Details with the given documentName of the specified
nodeId of nodeType.The filePath in the returned document object is RELATIVE.
|
java.lang.String |
getDocuments(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId)
Returns the documents of the specified nodeId of nodeType.
|
java.lang.String |
getDocumentsByDocIds(java.lang.String userName,
java.lang.String passWord,
java.lang.String outputFormat,
java.lang.String documentIdsArray)
Returns the Documents of the specified List of DocumentIds.The filePath
in the returned document object is RELATIVE.
|
java.lang.String |
updateDocumentByJSON(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String documentObjJson)
Updates Document with the specified document Object.
|
java.lang.String |
updateDocumentByNodeType(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentName,
java.lang.String documentObjJson)
Document File with the given documentName will be updated with the
filePath and filePathType specified, of the specified nodeId of nodeType.
|
java.lang.String |
updateDocumentFile(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentName,
java.lang.String filePath)
Deprecated.
|
java.lang.String |
updateDocumentFileByType(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String nodeType,
int nodeId,
java.lang.String documentName,
java.lang.String filePath,
java.lang.String filePathType)
Document will update with the given documentName and with the filePath
and filePathType specified, of the specified nodeId of nodeType.
|
java.lang.String |
updateDocuments(java.lang.String userName,
java.lang.String password,
java.lang.String outputFormat,
java.lang.String documentObjsJsonArray)
Documents are updated with the specified Document Objects.
|
public java.lang.String addDocument(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentObjJson)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentObjJson
- String
Sample 'documentObjJson' JSON :
{
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"filePathType" : "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
public java.lang.String addDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentsObjJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentsObjJsonArray
- String
Sample 'documentsObjJsonArray' JSON :
[
{
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"filePathType" : "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
},
{
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
]
public java.lang.String updateDocumentByJSON(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String documentObjJson)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLdocumentObjJson
-
Sample 'documentObjJson' JSON :
{
"documentId": 0,
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"filePathType" : "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
public java.lang.String updateDocumentByNodeType(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentName, java.lang.String documentObjJson)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentName
- StringdocumentObjJson
- String
Sample 'documentObjJson' JSON :
{
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"filePathType" : "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
public java.lang.String updateDocumentFile(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentName, java.lang.String filePath)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentName
- StringfilePath
- Stringpublic java.lang.String updateDocuments(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String documentObjsJsonArray)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLdocumentObjsJsonArray
- String
Sample 'documentObjsJsonArray' JSON :
[
{
"documentId": 0,
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"filePathType" : "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
},
{
"documentId": 0,
"documentName": "",
"documentIntendedPurpose": "",
"documentReferenceNumber": "",
"documentType": "",
"documentApprovedBy": "",
"documentObject": "",
"filePathType" : "",
"approvalRequired": true,
"documentOwner": "",
"documentLink": "",
"documentReference": "",
"documentStatus": "",
"documentApprovedDate": 1460701213000
}
]
public java.lang.String getDocument(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, int documentId)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLdocumentId
- intpublic java.lang.String getDocumentByName(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentName)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentName
- Stringpublic java.lang.String getDocuments(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, java.lang.String nodeType, int nodeId)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intpublic java.lang.String getDocumentsByDocIds(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, java.lang.String documentIdsArray)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLdocumentIdsArray
- Stringpublic java.lang.String deleteDocument(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, int documentId)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLdocumentId
- intpublic java.lang.String deleteDocumentByName(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentName)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentName
- Stringpublic java.lang.String deleteDocuments(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, java.lang.String nodeType, int nodeId)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intpublic java.lang.String deleteDocumentsByDocIds(java.lang.String userName, java.lang.String passWord, java.lang.String outputFormat, java.lang.String documentIdsArray)
userName
- StringpassWord
- StringoutputFormat
- String - Valid values: JSON or XMLdocumentIdsArray
- Stringpublic java.lang.String updateDocumentFileByType(java.lang.String userName, java.lang.String password, java.lang.String outputFormat, java.lang.String nodeType, int nodeId, java.lang.String documentName, java.lang.String filePath, java.lang.String filePathType)
userName
- Stringpassword
- StringoutputFormat
- String - Valid values: JSON or XMLnodeType
- StringnodeId
- intdocumentName
- StringfilePath
- StringfilePathType
- String - Valid values: ABSOLUTE,RELATIVE.