com.lexmark.saperion.client.implementation.document

Class DocumentRevisionClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.document.DocumentRevisionClientImpl

All Implemented Interfaces:

DocumentRevisionClient

public class DocumentRevisionClientImpl
extends Object
implements DocumentRevisionClient

This is the default implementation of DocumentRevisionClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
DocumentRevisionClientImpl(DocumentService documentService, DocumentRevisionReferenceType reference)

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the specified document.
DocumentElementClient	getElement(DocumentElementReferenceType elementReference) This method returns the document element client for the given document element id.
DocumentRevisionType	load() This method loads a document revision with its content.
DocumentRevisionType	loadMetadata() This method loads a document revision without its content.
SearchClient<PropertyType>	searchMultiValueField(String fieldName) This method returns a search client for the content of the given multi value field of the given document revision.
DocumentStoreInformationType	update(DocumentElementType documentElement) This is a shorthand for update(Collections.<String, PropertyType> emptyMap(), documentElement) updating only the document element and leaving the index data untouched.
DocumentStoreInformationType	update(Map<String,PropertyType> indexData) This is a shorthand for update(indexData, null) updating only the index data and leaving the document structure untouched.
DocumentStoreInformationType	update(Map<String,PropertyType> indexData, DocumentElementType documentElement) This method updates the document instance and replaces the document with the given entity.
DocumentStoreInformationType	update(UpdateDocumentInputType properties) This method updates the document with the given properties containing index-data, structure-data and ACLs.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentRevisionClientImpl

public DocumentRevisionClientImpl(DocumentService documentService,
                                  DocumentRevisionReferenceType reference)

Method Detail

loadMetadata

public DocumentRevisionType loadMetadata()
                                  throws EcmException

Description copied from interface: DocumentRevisionClient

This method loads a document revision without its content.

Specified by:

loadMetadata in interface DocumentRevisionClient

Returns:

the document revision without its content

Throws:

EcmException - indicates that a system exception occurred

load

public DocumentRevisionType load()
                          throws EcmException

Description copied from interface: DocumentRevisionClient

This method loads a document revision with its content.

Specified by:

load in interface DocumentRevisionClient

Returns:

the complete document revision

Throws:

EcmException - indicates that a system exception occurred

delete

public void delete()
            throws EcmException

Description copied from interface: DocumentRevisionClient

This method deletes the specified document.

Specified by:

delete in interface DocumentRevisionClient

Throws:

EcmException - indicates that a system exception occurred

update

public DocumentStoreInformationType update(Map<String,PropertyType> indexData,
                                           DocumentElementType documentElement)
                                    throws EcmException

Description copied from interface: DocumentRevisionClient

This method updates the document instance and replaces the document with the given entity.

Specified by:

update in interface DocumentRevisionClient

Parameters:

indexData - the index data changes of the document

documentElement - the new document root structure

Throws:

EcmException - indicates that a system exception occurred

update

public DocumentStoreInformationType update(DocumentElementType documentElement)
                                    throws EcmException

Description copied from interface: DocumentRevisionClient

This is a shorthand for update(Collections.<String, PropertyType> emptyMap(), documentElement) updating only the document element and leaving the index data untouched.

Specified by:

update in interface DocumentRevisionClient

Parameters:

documentElement - the new document root structure

Throws:

EcmException

update

public DocumentStoreInformationType update(Map<String,PropertyType> indexData)
                                    throws EcmException

Description copied from interface: DocumentRevisionClient

This is a shorthand for update(indexData, null) updating only the index data and leaving the document structure untouched.

Specified by:

update in interface DocumentRevisionClient

Parameters:

indexData - the index data changes of the document

Throws:

EcmException

update

public DocumentStoreInformationType update(UpdateDocumentInputType properties)
                                    throws EcmException

Description copied from interface: DocumentRevisionClient

This method updates the document with the given properties containing index-data, structure-data and ACLs.

Specified by:

update in interface DocumentRevisionClient

Parameters:

properties - the properties to update

Returns:

information about the new revision

Throws:

EcmException - when updating the document failed

searchMultiValueField

public SearchClient<PropertyType> searchMultiValueField(String fieldName)
                                                 throws EcmException

Description copied from interface: DocumentRevisionClient

This method returns a search client for the content of the given multi value field of the given document revision.

Specified by:

searchMultiValueField in interface DocumentRevisionClient

Parameters:

fieldName - the name of the multi value field

Returns:

a search client for the content of the given multi value field of the given document revision

Throws:

EcmException

getElement

public DocumentElementClient getElement(DocumentElementReferenceType elementReference)
                                 throws EcmException

Description copied from interface: DocumentRevisionClient

This method returns the document element client for the given document element id.

Specified by:

getElement in interface DocumentRevisionClient

Parameters:

elementReference - the document element reference

Returns:

the document element client for the given document element id

Throws:

EcmException