com.saperion.operations.document

Class SearchDocuments

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<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>,com.lexmark.saperion.exceptions.EcmException>

com.saperion.operations.document.SearchDocuments

All Implemented Interfaces:

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

public class SearchDocuments
extends com.lexmark.saperion.remote.common.operations.EcmOperation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>,com.lexmark.saperion.exceptions.EcmException>

Filters the given ddc with the given filter query and returns the ids of the documents that match.

Author:

jschwarz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchDocuments(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, QueryExpression<Boolean> filter) This creates a new operation that searches the given definition for documents that match the given filter (i.e.
SearchDocuments(String definitionName, QueryExpression<Boolean> filter) This creates a new operation that searches the given definition for documents that match the given filter (i.e.

Method Summary

Modifier and Type	Method and Description
com.lexmark.saperion.archive.ArchiveReferenceType	geArchiveReference()
QueryExpression<Boolean>	getFilter()
ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>	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

SearchDocuments

public SearchDocuments(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                       QueryExpression<Boolean> filter)

This creates a new operation that searches the given definition for documents that match the given filter (i.e. documents for which the filter holds) and lists their ids.

Parameters:

archiveReference - The name of the archive to search in. Must not be null.

filter - The condition that must hold for each document returned. Must not be null.

SearchDocuments

public SearchDocuments(String definitionName,
                       QueryExpression<Boolean> filter)

This creates a new operation that searches the given definition for documents that match the given filter (i.e. documents for which the filter holds) and lists their ids.

Parameters:

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

filter - The condition that must hold for each document returned. Must not be null.

Method Detail

invoke

public ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType> invoke()
                                                                              throws com.lexmark.saperion.exceptions.EcmException

Throws:

com.lexmark.saperion.exceptions.EcmException

toString

public String toString()

Overrides:

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

geArchiveReference

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

getFilter

public QueryExpression<Boolean> getFilter()