com.saperion.operations.workflow

Class CountTasks

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<Long>

com.saperion.operations.workflow.CountTasks

All Implemented Interfaces:

Operation<Long>, Serializable

public class CountTasks
extends AbstractOperation<Long>

This operation counts the tasks that are contained in one or more workflow inboxes. Unlike GetBoxCount, it allows to define a custom filter-expression. On the backend, the same queries are used as in SaRMIServerCommand.getTaskList(int, int[], String, Map). The operation is meant to be used to get a count before invoking getTaskList. The filter expression will be added to the where-clause of the HQL query using 'and <filter-expression>'.

Author:

cmerkel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CountTasks(String filter, Map<String,Object> filterParameters, int boxId) Constructor.
CountTasks(String filter, Map<String,Object> filterParameters, int[] boxIds) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Long	invoke() The method that will be called on the server side.

Methods inherited from class com.saperion.operations.AbstractOperation

afterInvoke, getResult, toArrayList, toString

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

Constructor Detail

CountTasks

public CountTasks(String filter,
          Map<String,Object> filterParameters,
          int[] boxIds)

Constructor.

Parameters:

filter - optional filter-expression in HQL that will be added to the WHERE-clause. Can be null or empty if not required.

filterParameters - parameters for the filter-expression. Can be null or empty if not required

boxIds - IDs of the inboxes to count the tasks for

CountTasks

public CountTasks(String filter,
          Map<String,Object> filterParameters,
          int boxId)

Constructor.

Parameters:

filter - optional filter-expression in HQL that will be added to the WHERE-clause. Can be null or empty if not required.

filterParameters - parameters for the filter-expression. Can be null or empty if not required

boxId - ID of the inboxes to count the tasks for

Method Detail

invoke

public Long invoke()
            throws SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation