com.saperion.connector.documents

Class RmiClientDocumentService

java.lang.Object

com.saperion.connector.service.AbstractRmiClientService

com.saperion.connector.documents.RmiClientDocumentService

All Implemented Interfaces:

DocumentService

public class RmiClientDocumentService
extends AbstractRmiClientService
implements DocumentService

This DocumentService provides document functionality by delegating to a remote saperion system via RMI.

Author:

jschwarz

Field Summary

Fields inherited from class com.saperion.connector.service.AbstractRmiClientService

connection

Constructor Summary

Constructors

Constructor and Description
RmiClientDocumentService(Connection connection)

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 definitionName, QueryExpression<Boolean> filter) Loads all documents for which the given filter holds
com.lexmark.saperion.document.DocumentRevisionType	searchUniqueDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionName, QueryExpression<Boolean> filter, com.lexmark.saperion.document.LoadKindEnumeration loadKind) Loads the unique document for which the given filter holds.

Methods inherited from class com.saperion.connector.service.AbstractRmiClientService

mapSystemException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RmiClientDocumentService

public RmiClientDocumentService(Connection connection)

Method Detail

getLatestRevisionId

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

Description copied from interface: DocumentService

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

Specified by:

getLatestRevisionId in interface DocumentService

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

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

Description copied from interface: DocumentService

Loads a complete document revision given its revision id.

Specified by:

loadDocument in interface DocumentService

Parameters:

revisionId - the revision id of the document to load

Returns:

the document with the given id

Throws:

SaBasicException

loadDocument

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

Description copied from interface: DocumentService

Loads the latest document revision with the given document id.

Specified by:

loadDocument in interface DocumentService

Parameters:

documentId - the id of the document

Returns:

the latest document with the given id

Throws:

SaBasicException

searchUniqueDocument

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

Description copied from interface: DocumentService

Loads the unique document for which the given filter holds.

Specified by:

searchUniqueDocument in interface DocumentService

Parameters:

definitionName - 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

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

Description copied from interface: DocumentService

Loads all documents for which the given filter holds

Specified by:

searchDocuments in interface DocumentService

Parameters:

definitionName - 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

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

Description copied from interface: DocumentService

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.

Specified by:

readDocumentElementContent in interface DocumentService

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

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

Description copied from interface: DocumentService

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

Specified by:

createDocument in interface DocumentService

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