com.lexmark.saperion.document

Interface DocumentService

public interface DocumentService

Holds core document functionality.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
DocumentElementStoreInformationType	appendChildElement(DocumentRevisionReferenceType revisionReference, DocumentElementReferenceType elementReference, DocumentElementType child) This method appends a child element to the document element given by its id and the id of the document the element resides in.
DocumentStoreInformationType	createDocument(ArchiveReferenceType archiveReference, Map<String,PropertyType> indexData, DocumentElementType rootElement) This method stores a new document with the given data in the backend.
DocumentStoreInformationType	createDocument(CreateDocumentInputType properties) This method stores a new document with the given data in the backend.
void	deleteDocument(DocumentRevisionReferenceType revisionReferenceType) This method deletes the document referenced to by the given reference.
DocumentStoreInformationType	deleteDocumentElement(DocumentRevisionReferenceType revisionReference, DocumentElementReferenceType elementReference) This method deletes the document element given by its reference and a reference to the latest revision of the element it resides in.
List<AclReferenceType>	getACLs(DocumentReferenceType documentReference) This method returns the ACLs set on the current revision of the specified document.
DocumentRevisionReferenceType	getLatestRevisionId(DocumentReferenceType documentId) This method returns the id of the latest revision of the document given by its id.
DocumentRevisionType	loadDocument(DocumentReferenceType documentId, LoadKindEnumeration loadKind) Loads the latest document revision with the given document id.
DocumentRevisionType	loadDocument(DocumentRevisionReferenceType revisionId, LoadKindEnumeration loadKind) Loads a complete document revision given its revision id.
void	lockDocument(DocumentReferenceType documentReference) This method locks a document for the current user..
SearchExecutionService<PropertyType>	newMultiValueFieldSearchService(DocumentRevisionReferenceType document, String fieldName) This method creates a new search service that searches in the values that are set on the given multi value field for the given document.
InputStream	readDocumentElementContent(DocumentRevisionReferenceType documentId, DocumentElementReferenceType documentElementId) Opens the content of the document element identified by the given id for reading and returns an input stream for that data.
SearchExecutionService<DocumentRevisionListItemType>	searchServiceForDefinition(ArchiveReferenceType definitionReference) This method returns a search service for the given definition.
void	unlockDocument(DocumentReferenceType documentReference) This method unlocks a document.
DocumentStoreInformationType	updateDocument(DocumentRevisionReferenceType reference, Map<String,PropertyType> indexData, DocumentElementType rootElement) This method updates a document given by its revision reference with the given data.
DocumentStoreInformationType	updateDocument(DocumentRevisionReferenceType reference, UpdateDocumentInputType properties) This method updates a document given by its revision reference with the given data.
DocumentElementStoreInformationType	updateDocumentElement(DocumentRevisionReferenceType revisionReference, DocumentElementReferenceType elementReference, DocumentElementType element) This method replaces the document element given by its reference and a reference to the latest revision of the element it resides in.

Method Detail

getLatestRevisionId

DocumentRevisionReferenceType getLatestRevisionId(DocumentReferenceType documentId)
                                           throws EcmException

This method returns the id of the latest revision of the document given by its id.

Parameters:

documentId - the id of the document to get the latest revision id for

Returns:

id of the latest revision of the document given by its id

Throws:

EcmException

loadDocument

DocumentRevisionType loadDocument(DocumentRevisionReferenceType revisionId,
                                  LoadKindEnumeration loadKind)
                           throws EcmException

Loads a complete document revision given its revision id.

Parameters:

revisionId - the revision id of the document to load

Returns:

the document with the given id

Throws:

EcmException

loadDocument

DocumentRevisionType loadDocument(DocumentReferenceType documentId,
                                  LoadKindEnumeration loadKind)
                           throws EcmException

Loads the latest document revision with the given document id.

Parameters:

documentId - the id of the document

Returns:

the latest document with the given id

Throws:

EcmException

readDocumentElementContent

InputStream readDocumentElementContent(DocumentRevisionReferenceType documentId,
                                       DocumentElementReferenceType documentElementId)
                                throws EcmException

Opens the content of the document element identified by the given id for reading and returns an input stream for that data. If the element is chunked the resulting stream will stream over all the chunks.

Parameters:

documentId - the id of the document the element to read belongs to

documentElementId - the id of the document element to read from

Returns:

an input stream for the content of the given document element

Throws:

EcmException

createDocument

DocumentStoreInformationType createDocument(ArchiveReferenceType archiveReference,
                                            Map<String,PropertyType> indexData,
                                            DocumentElementType rootElement)
                                     throws EcmException

This method stores a new document with the given data in the backend.

Parameters:

archiveReference - a reference to the archive to store the document in

indexData - the index data the document will hold.

rootElement - the documents root element

Returns:

the document reference and revision reference of the newly created document

Throws:

EcmException

createDocument

DocumentStoreInformationType createDocument(CreateDocumentInputType properties)
                                     throws EcmException

This method stores a new document with the given data in the backend.

Parameters:

properties - the properties of the new document

Returns:

the document reference and revision reference of the newly created document

Throws:

EcmException

updateDocument

DocumentStoreInformationType updateDocument(DocumentRevisionReferenceType reference,
                                            Map<String,PropertyType> indexData,
                                            DocumentElementType rootElement)
                                     throws EcmException

This method updates a document given by its revision reference with the given data.

Parameters:

reference - a reference to the latest revision of the document

indexData - the index data to change

rootElement - the new root element

Returns:

store information of the new revision

Throws:

EcmException

updateDocument

DocumentStoreInformationType updateDocument(DocumentRevisionReferenceType reference,
                                            UpdateDocumentInputType properties)
                                     throws EcmException

This method updates a document given by its revision reference with the given data.

Parameters:

reference - a reference to the latest revision of the document

properties - the properties to update

Returns:

store information of the new revision

Throws:

EcmException

appendChildElement

DocumentElementStoreInformationType appendChildElement(DocumentRevisionReferenceType revisionReference,
                                                       DocumentElementReferenceType elementReference,
                                                       DocumentElementType child)
                                                throws EcmException

This method appends a child element to the document element given by its id and the id of the document the element resides in. The element does not need to be the root element of the given document revision. However, it must be an descendant of its root element. Also it must be of the type DocumentNodeType.STRUCTURE.

Parameters:

revisionReference - a reference to the document revision the element resides in

elementReference - a reference to the structure element to add a child to

child - the data of the child to add

Returns:

the document, revision and element references of the new document element

Throws:

EcmException

updateDocumentElement

DocumentElementStoreInformationType updateDocumentElement(DocumentRevisionReferenceType revisionReference,
                                                          DocumentElementReferenceType elementReference,
                                                          DocumentElementType element)
                                                   throws EcmException

This method replaces the document element given by its reference and a reference to the latest revision of the element it resides in. The element does not need to be the root element of the given document revision. However, it must be an descendant of its root element.

Parameters:

revisionReference - a reference to the latest revision the element resides in

elementReference - a reference to the element to replace

element - the data to replace the element with

Returns:

the document, revision and element references of the new document element

Throws:

EcmException

deleteDocumentElement

DocumentStoreInformationType deleteDocumentElement(DocumentRevisionReferenceType revisionReference,
                                                   DocumentElementReferenceType elementReference)
                                            throws EcmException

This method deletes the document element given by its reference and a reference to the latest revision of the element it resides in. The element does not need to be the root element of the given document revision. However, it must be an descendant of its root element.

Parameters:

revisionReference - a reference to the revision the element resides in

elementReference - a reference to the element to delete

Returns:

a store information for the new revision of the document the element resided in

Throws:

EcmException

searchServiceForDefinition

SearchExecutionService<DocumentRevisionListItemType> searchServiceForDefinition(ArchiveReferenceType definitionReference)
                                                                         throws EcmException

This method returns a search service for the given definition.

Parameters:

definitionReference - a reference to the definition to search in

Returns:

a search service for the given definition

Throws:

EcmException

deleteDocument

void deleteDocument(DocumentRevisionReferenceType revisionReferenceType)
             throws EcmException

This method deletes the document referenced to by the given reference. The reference must reference the latest revision, otherwise a ConcurrentWriteException is thrown.

Parameters:

revisionReferenceType - a reference to the document revision to delete

Throws:

EcmException - on general errors

ConcurrentWriteException - when the given revision reference references an outdated revision

newMultiValueFieldSearchService

SearchExecutionService<PropertyType> newMultiValueFieldSearchService(DocumentRevisionReferenceType document,
                                                                     String fieldName)
                                                              throws EcmException

This method creates a new search service that searches in the values that are set on the given multi value field for the given document.

Parameters:

document - the document to search in

fieldName - the multi value field to search in

Returns:

a new search execution service

Throws:

EcmException - when the service could not be created

lockDocument

void lockDocument(DocumentReferenceType documentReference)
           throws EcmException

This method locks a document for the current user..

Parameters:

documentReference - the reference to the document to lock

Throws:

EcmException - when locking the document failed

unlockDocument

void unlockDocument(DocumentReferenceType documentReference)
             throws EcmException

This method unlocks a document. Only the user owning the lock or an administrator are allowed to remove a lock.

Parameters:

documentReference - the reference to the document to unlock

Throws:

EcmException - when unlocking the document failed

getACLs

List<AclReferenceType> getACLs(DocumentReferenceType documentReference)
                        throws EcmException

This method returns the ACLs set on the current revision of the specified document.

Parameters:

documentReference - the document to load the ACLs for

Returns:

a list of ACLs set on the document

Throws:

EcmException - when loading the ACLs failed