org.eclipse.stardust.engine.api.query

Class UserStateFilter

java.lang.Object

org.eclipse.stardust.engine.api.query.UserStateFilter

All Implemented Interfaces:

Serializable, FilterCriterion

public class UserStateFilter
extends Object
implements FilterCriterion

Filter that reduces the query result to users with the given status.

Version:

$Revision$

Author:

sborn

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
Object	accept(FilterEvaluationVisitor visitor, Object context) Visitor dispatch callback used for evaluating filter criteria.
static UserStateFilter	forLoggedInUsers() Creates a filter matching currently logged in users.
boolean	isLoggedInOnly()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forLoggedInUsers

public static UserStateFilter forLoggedInUsers()

Creates a filter matching currently logged in users.

Returns:

The readily configured user state filter.

isLoggedInOnly

public boolean isLoggedInOnly()

Returns:

true if the filter filters currently logged in users.

accept

public Object accept(FilterEvaluationVisitor visitor,
            Object context)

Description copied from interface: FilterCriterion

Visitor dispatch callback used for evaluating filter criteria. Usually implemented as return visitor.visit(this, context), thus calling the appropriately overloaded visitation method.

Specified by:

accept in interface FilterCriterion

Parameters:

visitor - The visitor performing the evaluation.

context - Information used by the visitor during the visitation process.

Returns:

Visitor specific result of the visitation.