com.saperion.document

Interface DocumentService

All Known Implementing Classes:

RmiClientDocumentService

public interface DocumentService

Holds core document functionality.

Author:

jschwarz

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.document.DocumentStoreInformationType	createDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definition, Map<String,Object> indexData, com.lexmark.saperion.document.DocumentElementType rootElement) This method stores a new document with the given data in the backend.
com.lexmark.saperion.document.DocumentRevisionReferenceType	getLatestRevisionId(com.lexmark.saperion.document.DocumentReferenceType documentId) This method returns the id of the latest revision of the document given by its id.
com.lexmark.saperion.document.DocumentRevisionType	loadDocument(com.lexmark.saperion.document.DocumentReferenceType documentId, com.lexmark.saperion.document.LoadKindEnumeration loadKind) Loads the latest document revision with the given document id.
com.lexmark.saperion.document.DocumentRevisionType	loadDocument(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionId, com.lexmark.saperion.document.LoadKindEnumeration loadKind) Loads a complete document revision given its revision id.
InputStream	readDocumentElementContent(com.lexmark.saperion.document.DocumentReferenceType documentId, com.lexmark.saperion.document.DocumentElementReferenceType documentElementId) Opens the content of the document element identified by the given id for reading and returns an input stream for that data.
List<com.lexmark.saperion.document.DocumentRevisionReferenceType>	searchDocuments(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference, QueryExpression<Boolean> filter) Loads all documents for which the given filter holds
com.lexmark.saperion.document.DocumentRevisionType	searchUniqueDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference, QueryExpression<Boolean> filter, com.lexmark.saperion.document.LoadKindEnumeration loadKind) Loads the unique document for which the given filter holds.

Method Detail

getLatestRevisionId

com.lexmark.saperion.document.DocumentRevisionReferenceType getLatestRevisionId(com.lexmark.saperion.document.DocumentReferenceType documentId)
                                                                                throws SaBasicException

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:

SaBasicException

loadDocument

com.lexmark.saperion.document.DocumentRevisionType loadDocument(com.lexmark.saperion.document.DocumentRevisionReferenceType revisionId,
                                                              com.lexmark.saperion.document.LoadKindEnumeration loadKind)
                                                                throws SaBasicException

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:

SaBasicException

loadDocument

com.lexmark.saperion.document.DocumentRevisionType loadDocument(com.lexmark.saperion.document.DocumentReferenceType documentId,
                                                              com.lexmark.saperion.document.LoadKindEnumeration loadKind)
                                                                throws SaBasicException

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:

SaBasicException

searchUniqueDocument

com.lexmark.saperion.document.DocumentRevisionType searchUniqueDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference,
                                                                      QueryExpression<Boolean> filter,
                                                                      com.lexmark.saperion.document.LoadKindEnumeration loadKind)
                                                                        throws SaBasicException

Loads the unique document for which the given filter holds.

Parameters:

definitionReference - reference to the document definition to search in.

filter - a QueryExpression of type boolean that uniquely identifies the document

Returns:

the unique document that matches the given filter

Throws:

SaBasicException

searchDocuments

List<com.lexmark.saperion.document.DocumentRevisionReferenceType> searchDocuments(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference,
                                                                                QueryExpression<Boolean> filter)
                                                                                  throws SaBasicException

Loads all documents for which the given filter holds

Parameters:

definitionReference - the document definition to search in.

filter - a QueryExpression of type boolean that is true for all wanted documents

Returns:

the list revision ids of documents that match the given filter

Throws:

SaBasicException

readDocumentElementContent

InputStream readDocumentElementContent(com.lexmark.saperion.document.DocumentReferenceType documentId,
                                     com.lexmark.saperion.document.DocumentElementReferenceType documentElementId)
                                       throws SaBasicException

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:

SaBasicException

createDocument

com.lexmark.saperion.document.DocumentStoreInformationType createDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definition,
                                                                        Map<String,Object> indexData,
                                                                        com.lexmark.saperion.document.DocumentElementType rootElement)
                                                                          throws SaBasicException

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

Parameters:

definition - a reference to the definition 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:

SaBasicException