|
Oracle® WebCenter Content Java API Reference for Imaging 11g Release 1 (11.1.1) E12853-03 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentService
The service for interacting with imaging documents. The methods on this service interact primarily with the Document
data structure object.
Method Summary | |
---|---|
java.lang.String |
copyDocument(java.lang.String documentId, NameId applicationId, java.util.List<Document.FieldValue> fieldValues, boolean copyAnnotations) Copies a document in the imaging system. |
java.lang.String |
createDocument(java.lang.String uploadToken, NameId applicationId, java.util.List<Document.FieldValue> fieldValues, boolean submitToWorkflow) Adds a new document to the imaging system. |
void |
deleteDocument(java.lang.String documentId) Deletes a document from the Imaging system. |
void |
deleteDocuments(java.lang.String[] documentIds) Deletes multiple documents from the Imaging system. |
javax.activation.DataHandler |
getAnnotations(java.lang.String documentId) This method is reserved for Oracle internal use only. |
Document |
getDocument(java.lang.String documentId, Document.SectionSet sectionSet) Gets a Document data structure containing the detail sections for latest version of a given imaging document. |
java.util.List<Document> |
getDocuments(java.lang.String[] documentIds, Document.SectionSet sectionSet) Gets multiple Document data structures containing the requested detail sections for a list of Imaging document ids. |
Document |
getDocumentVersion(java.lang.String documentId, long version, Document.SectionSet sectionSet) Gets a Document data structure containing the detail sections for a specific version of a given Imaging document. |
javax.activation.DataHandler |
getSupportingContent(java.lang.String documentId, java.lang.String key) Retrieves the supporting content for a document. |
Application |
getTargetApplication(NameId appNameId) |
boolean |
hasStatusChanged(java.lang.String documentId, java.lang.String status) Determines if a document's status has changed. |
java.util.List<NameId> |
listTargetApplications(Document.Ability ability) |
Document |
lockDocument(java.lang.String documentId, Document.SectionSet sectionSet) Locks a document to the requesting user. |
void |
modifyPageOrder(java.lang.String documentId, java.util.List<PageChange> pageChanges) Affects the page changes described by the collection of PageChange objects in the supplied collection. |
java.lang.String |
moveDocument(java.lang.String documentId, NameId applicationId, java.util.List<Document.FieldValue> fieldValues) Moves a document in the imaging system from one application to another. |
void |
setAnnotations(java.lang.String documentId, javax.activation.DataHandler annotData) This method is reserved for Oracle internal use only. |
void |
setSupportingContent(java.lang.String documentId, java.lang.String key, java.lang.String fileName, javax.activation.DataHandler data) Adds supporting content to a document. |
void |
submitToWorkflow(java.lang.String documentId) Triggers the creation of a workflow process instance for a given document. |
void |
unlockDocument(java.lang.String documentId) Unlocks a document from the requesting user. |
java.lang.String |
updateDocument(java.lang.String documentId, java.lang.String uploadToken, java.util.List<Document.FieldValue> fieldValues, boolean reserved) Updates a document in the imaging system. |
Method Detail |
---|
java.lang.String createDocument(java.lang.String uploadToken, NameId applicationId, java.util.List<Document.FieldValue> fieldValues, boolean submitToWorkflow) throws ImagingException, ValidationException
uploadToken
- A unique identifer to a document uploaded with the DocumentContentService uploadDocument operation.applicationId
- The guid of the application into which the document is to be stored. The NameId can consist of just Name, just Id, or both. Referencing by Id will make the operation execute faster.fieldValues
- A list of Document FieldValue data structures supplying the primary application metadata for the document. The Document.FieldValues in the list must match valid Application.FieldDefinitions in the application specified by the application parameter. used to detect the mime type.submitToWorkflow
- Indicates whether the newly created document should trigger the creation of a workflow process instance for the document. If true, a workflow process instance is created only if the application in which the document is create is configured for workflow and the configuration is enabled. If false, no process instance is triggered. A process instance may be triggered at a later time using the submitToWorkflow method.ImagingException
ValidationException
Document getDocument(java.lang.String documentId, Document.SectionSet sectionSet) throws ImagingException
documentId
- The guid of the document being requested.sectionSet
- An array representing which sections of the document to return. If only the FieldValues are needed, then pass in an array of 1 containing Document.SectionFlag.FIELDVALUES. It is suggested to only return what is needed for best performance.ImagingException
Document getDocumentVersion(java.lang.String documentId, long version, Document.SectionSet sectionSet) throws ImagingException
documentId
- The guid of the document being requested.version
- The version of the document being requestedsectionSet
- An array representing which sections of the document to return. If only the FieldValues are needed, then pass in an array of 1 containing Document.SectionFlag.FIELDVALUES. It is suggested to only return what is needed for best performance.ImagingException
java.util.List<Document> getDocuments(java.lang.String[] documentIds, Document.SectionSet sectionSet) throws ImagingException
documentIds
- An array of document ids to be retrievedsectionSet
- An array representing which sections of the document to return. If only the FieldValues are needed, then pass in an array of 1 containing Document.SectionFlag.FIELDVALUES. It is suggested to only return what is needed for best performance.ImagingException
void deleteDocument(java.lang.String documentId) throws ImagingException
documentId
- The document guid of the document to be deletedImagingException
void deleteDocuments(java.lang.String[] documentIds) throws ImagingException
documentIds
- An array of document ids specifying the documents to be deletedImagingException
Document lockDocument(java.lang.String documentId, Document.SectionSet sectionSet) throws ImagingException
When a document is locked, the versionDocument, replaceDocument, modifyDocumentFieldValues, and deleteDocument operation will fail for any user other than the user who has the document locked. These operations will succeed it either no user has the document locked or if the user requesting the operation has the document locked. Once a user locks a document, it will remain locked to the user until the user either calls the unlockDocument operation or the Application defined LockTimeOut period expires.
The operation will throw and ImagingException if the document is already locked to another user.
documentId
- The document guid of the document to be lockedsectionSet
- An array representing which sections of the document to return. If only the FieldValues are needed, then pass in an array of 1 containing Document.SectionFlag.FIELDVALUES. It is suggested to only return what is needed for best performance.ImagingException
void unlockDocument(java.lang.String documentId) throws ImagingException
The operation will throw and ImagingException if the document is not locked to the requesting user, or if the user does not have rights to unlock documents.
documentId
- The document guid of the document to be unlockedImagingException
java.lang.String updateDocument(java.lang.String documentId, java.lang.String uploadToken, java.util.List<Document.FieldValue> fieldValues, boolean reserved) throws ImagingException, ValidationException
Throws an exception if the document is not locked to the requesting user, or if the requesting user doesn't have the rights to Modify Content.
documentId
- The unique identifier of the document to modify.uploadToken
- A unique identifer to a document uploaded with the DocumentContentService uploadDocument operation, or null if only updating a documents field values.fieldValues
- The fieldValues for the targetItemId application definition used to detect the mime type.reserved
- Reserved for future use.ImagingException
- The exception code may be one of the following values:ValidationException
java.lang.String copyDocument(java.lang.String documentId, NameId applicationId, java.util.List<Document.FieldValue> fieldValues, boolean copyAnnotations) throws ImagingException, ValidationException
documentId
- The guid of the document to be copied.applicationId
- The guid of the application into which the document is to be copied.fieldValues
- The fieldValues for the targetItemId application definitioncopyAnnotations
- A flag to indicate that existing annotations should be copied with the documentImagingException
ValidationException
java.lang.String moveDocument(java.lang.String documentId, NameId applicationId, java.util.List<Document.FieldValue> fieldValues) throws ImagingException, ValidationException
documentId
- The guid of the document to be moved.applicationId
- The guid of the application into which the document is to be moved.fieldValues
- The fieldValues for the targetItemId application definitionImagingException
ValidationException
@ResponseWrapper(targetNamespace="http://imaging.oracle/",
classname="imaging_oracle_proxy_types_GetAnnotationsResponse",
localname="getAnnotationsResponse")
javax.activation.DataHandler getAnnotations(java.lang.String documentId)
throws ImagingException
ImagingException
@RequestWrapper(targetNamespace="http://imaging.oracle/",
classname="oracle_imaging_proxy_types_SetAnnotations",
localname="setAnnotations")
void setAnnotations(java.lang.String documentId,
javax.activation.DataHandler annotData)
throws ImagingException
ImagingException
void modifyPageOrder(java.lang.String documentId, java.util.List<PageChange> pageChanges) throws ImagingException
PageChange
objects in the supplied collection. Pages may be deleted from a document, moved within a document, appended to the document, or inserted into the document. Any insert or append operation is performed first, then all page delete operations are performed before any page move operations. Each operation specified in the pageChanges collection are performed independently of the others. Because of this, each PageChange object must set the currentPageNumber and newPageNumber fields according to the document state at the time of that operation. For example, if a single page is to be inserted at page position 2, the original page 2 is now page 3. A subsequent request to move page 4 to page 1 will move the document's original page 3 (now page 4 because of the previous insert). Additionally, the previously inserted page 2 will become page three after the move. This method is only valid for TIFF document combinations.documentId
- The ID of the document to which the changes are to be appliedpageChanges
- A List of PageChange objects indicating the operations to be performed on the documentImagingException
@RequestWrapper(targetNamespace="http://imaging.oracle/",
classname="oracle_imaging_proxy_types_SetSupportingContent",
localname="setSupportingContent")
void setSupportingContent(java.lang.String documentId,
java.lang.String key,
java.lang.String fileName,
javax.activation.DataHandler data)
throws ImagingException
documentId
- The guid of the document to add supporting content to.key
- The supporting content key to be added. If there is already content associated with this key, the content will be overwritten.fileName
- The name of the supporting content file being added.data
- A DataHandler object representing the document to add as supporting content. If null, removes any entry for the matching key.ImagingException
@ResponseWrapper(targetNamespace="http://imaging.oracle/",
classname="imaging_oracle_oracle_proxy_types_GetSupportingContentResponse",
localname="getSupportingContentResponse")
javax.activation.DataHandler getSupportingContent(java.lang.String documentId,
java.lang.String key)
throws ImagingException
documentId
- The guid of the document to get the supporting content for.key
- The supporting content key for the content to be retrieved.ImagingException
java.util.List<NameId> listTargetApplications(Document.Ability ability) throws ImagingException
ImagingException
Application getTargetApplication(NameId appNameId) throws ImagingException
ImagingException
boolean hasStatusChanged(java.lang.String documentId, java.lang.String status) throws ImagingException
documentId
- The guid of the document to check.status
- Current document status.true
if document status has changed, otherwise false
ImagingException
void submitToWorkflow(java.lang.String documentId) throws ImagingException
documentId
- The id of the document that is to be submitted to workflowImagingException
|
Oracle® WebCenter Content Java API Reference for Imaging 11g Release 1 (11.1.1) E12853-03 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |