com.saperion.operations.document

Class SearchDocuments

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>>

com.saperion.operations.document.SearchDocuments

All Implemented Interfaces:

Operation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>>, Serializable

public class SearchDocuments
extends AbstractOperation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>>
implements Operation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>>

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.document.DocumentDefinitionReferenceType definitionName, 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

Methods

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

SearchDocuments

public SearchDocuments(com.lexmark.saperion.document.DocumentDefinitionReferenceType 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.

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 SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Specified by:

invoke in interface Operation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>>

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation

toString

public String toString()

Overrides:

toString in class AbstractOperation<ArrayList<com.lexmark.saperion.document.DocumentRevisionReferenceType>>

getDefinitionName

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

getFilter

public QueryExpression<Boolean> getFilter()