com.saperion.operations.document

Class SearchUniqueDocument

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType>

com.saperion.operations.document.SearchUniqueDocument

All Implemented Interfaces:

Operation<com.lexmark.saperion.document.DocumentRevisionType>, Serializable

public class SearchUniqueDocument
extends AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType>
implements Operation<com.lexmark.saperion.document.DocumentRevisionType>

Filters the given ddc with the given filter query and expects to find at most one DocumentRevisionType. If it exists it will be loaded and returned.

Author:

jschwarz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchUniqueDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionName, QueryExpression<Boolean> filter, com.lexmark.saperion.document.LoadKindEnumeration loadKind) This creates a new operation that expects to find at most one document in the given definition for which the filter holds.

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.document.DocumentDefinitionReferenceType	getDefinitionName()
QueryExpression<Boolean>	getFilter()
com.lexmark.saperion.document.LoadKindEnumeration	getLoadKind()
com.lexmark.saperion.document.DocumentRevisionType	invoke() The method that will be called on the server side.
String	toString()

Methods inherited from class com.saperion.operations.AbstractOperation

afterInvoke, getResult, toArrayList

Methods inherited from class com.saperion.operations.BaseOperation

beforeInvoke, getClientToken, mapException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.saperion.operations.Operation

afterInvoke, beforeInvoke, getResult

Constructor Detail

SearchUniqueDocument

public SearchUniqueDocument(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionName,
                    QueryExpression<Boolean> filter,
                    com.lexmark.saperion.document.LoadKindEnumeration loadKind)

This creates a new operation that expects to find at most one document in the given definition for which the filter holds. If it does not exist, null will be returned. Otherwise the document will be loaded according to the given load kind and returned.

Parameters:

definitionName - The definition to search in. Must not be null.

filter - The condition the uniquely identifies the document searched. Must not be null.

loadKind - Whether to completely load the document or to omit the content. Must not be null.

Method Detail

invoke

public com.lexmark.saperion.document.DocumentRevisionType invoke()
                                                          throws SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Specified by:

invoke in interface Operation<com.lexmark.saperion.document.DocumentRevisionType>

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation

getDefinitionName

public com.lexmark.saperion.document.DocumentDefinitionReferenceType getDefinitionName()

getFilter

public QueryExpression<Boolean> getFilter()

getLoadKind

public com.lexmark.saperion.document.LoadKindEnumeration getLoadKind()

toString

public String toString()

Overrides:

toString in class AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType>