com.saperion.operations.document

Class SearchUniqueDocument

java.lang.Object

com.lexmark.saperion.remote.common.operations.AbstractOperation<ResultType,EcmExceptionType,com.lexmark.saperion.remote.common.Connection>

com.lexmark.saperion.remote.common.operations.EcmOperation<com.lexmark.saperion.document.DocumentRevisionType,com.lexmark.saperion.exceptions.EcmException>

com.saperion.operations.document.SearchUniqueDocument

All Implemented Interfaces:

com.lexmark.saperion.remote.common.operations.Operation<com.lexmark.saperion.document.DocumentRevisionType,com.lexmark.saperion.exceptions.EcmException,com.lexmark.saperion.remote.common.Connection>, Serializable

public class SearchUniqueDocument
extends com.lexmark.saperion.remote.common.operations.EcmOperation<com.lexmark.saperion.document.DocumentRevisionType,com.lexmark.saperion.exceptions.EcmException>

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.archive.ArchiveReferenceType archiveReference, 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

Modifier and Type	Method and Description
com.lexmark.saperion.archive.ArchiveReferenceType	geArchiveReference()
QueryExpression<Boolean>	getFilter()
com.lexmark.saperion.document.LoadKindEnumeration	getLoadKind()
com.lexmark.saperion.document.DocumentRevisionType	invoke()
String	toString()

Methods inherited from class com.lexmark.saperion.remote.common.operations.AbstractOperation

afterInvoke, beforeInvoke, getResult, toArrayList, toCaseInsensitiveMap, toHashMap

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchUniqueDocument

public SearchUniqueDocument(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                            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:

archiveReference - The archive 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 com.lexmark.saperion.exceptions.EcmException

Throws:

com.lexmark.saperion.exceptions.EcmException

geArchiveReference

public com.lexmark.saperion.archive.ArchiveReferenceType geArchiveReference()

getFilter

public QueryExpression<Boolean> getFilter()

getLoadKind

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

toString

public String toString()

Overrides:

toString in class com.lexmark.saperion.remote.common.operations.AbstractOperation<com.lexmark.saperion.document.DocumentRevisionType,com.lexmark.saperion.exceptions.EcmException,com.lexmark.saperion.remote.common.Connection>