org.eclipse.stardust.engine.api.query

Class PerformingParticipantFilter

java.lang.Object

org.eclipse.stardust.engine.api.query.PerformingParticipantFilter

All Implemented Interfaces:

Serializable, FilterCriterion

public class PerformingParticipantFilter
extends Object
implements FilterCriterion

Class for filtering participants

Version:

$Revision$

Author:

rsauer

See Also:

ParticipantInfo, Participant, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PerformingParticipantFilter.Kind Enumeration for participant filter kind definitions.

Field Summary

Fields

Modifier and Type	Field and Description
static PerformingParticipantFilter	ANY_FOR_USER Filter for retrieving items performed by any participant (roles, organizations or user groups) associated with the calling user.
static PerformingParticipantFilter.Kind	FILTER_KIND_ANY_FOR_USER Constant marking the special ANY_FOR_USER filter.
static PerformingParticipantFilter.Kind	FILTER_KIND_MODEL_PARTICIPANT Constant marking a model participant filter.
static PerformingParticipantFilter.Kind	FILTER_KIND_USER_GROUP Constant marking a user group filter.
static PerformingParticipantFilter	USER_ROLES_AND_ORGANIZATIONS Deprecated. Replaced by ANY_FOR_USER.

Constructor Summary

Constructors

Constructor and Description
PerformingParticipantFilter(String participantID) Deprecated. Use forModelParticipant(String) instead.
PerformingParticipantFilter(String participantID, boolean recursively) Deprecated. Use forModelParticipant(String, boolean) instead.

Method Summary

Methods

Modifier and Type	Method and Description
Object	accept(FilterEvaluationVisitor visitor, Object context) Visitor dispatch callback used for evaluating filter criteria.
static PerformingParticipantFilter	forModelParticipant(String participantID) Deprecated. Superseded by #forModelParticipant(ParticipantInfo)
static PerformingParticipantFilter	forModelParticipant(String participantID, boolean recursively) Deprecated. Superseded by #forModelParticipant(ParticipantInfo, boolean)
static PerformingParticipantFilter	forParticipant(ParticipantInfo participant) Gets the PerformingParticipantFilter for the given arguments.
static PerformingParticipantFilter	forParticipant(ParticipantInfo participant, boolean recursively) Gets the PerformingParticipantFilter for the given arguments
static PerformingParticipantFilter	forUserGroup(String groupID) Deprecated. Superseded by #forModelParticipant(ParticipantInfo)
PerformingParticipantFilter.Kind	getFilterKind() Gets the PerformingParticipantFilter.Kind of the filter Also see
ParticipantInfo	getParticipant() Returns the ParticipantInfo for the participant
String	getParticipantID() Returns the id for the participant
boolean	isRecursively() Returns if this filter should include all sub participants

Methods inherited from class java.lang.Object

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

Field Detail

FILTER_KIND_ANY_FOR_USER

public static final PerformingParticipantFilter.Kind FILTER_KIND_ANY_FOR_USER

Constant marking the special ANY_FOR_USER filter.

FILTER_KIND_MODEL_PARTICIPANT

public static final PerformingParticipantFilter.Kind FILTER_KIND_MODEL_PARTICIPANT

Constant marking a model participant filter.

FILTER_KIND_USER_GROUP

public static final PerformingParticipantFilter.Kind FILTER_KIND_USER_GROUP

Constant marking a user group filter.

ANY_FOR_USER

public static final PerformingParticipantFilter ANY_FOR_USER

Filter for retrieving items performed by any participant (roles, organizations or user groups) associated with the calling user. Finding such participants will perform a deep search.

USER_ROLES_AND_ORGANIZATIONS

public static final PerformingParticipantFilter USER_ROLES_AND_ORGANIZATIONS

Deprecated. Replaced by ANY_FOR_USER.

Constructor Detail

PerformingParticipantFilter

public PerformingParticipantFilter(String participantID)

Deprecated. Use forModelParticipant(String) instead.

PerformingParticipantFilter

public PerformingParticipantFilter(String participantID,
                           boolean recursively)

Deprecated. Use forModelParticipant(String, boolean) instead.

Method Detail

forModelParticipant

public static PerformingParticipantFilter forModelParticipant(String participantID)

Deprecated. Superseded by #forModelParticipant(ParticipantInfo)

forModelParticipant

public static PerformingParticipantFilter forModelParticipant(String participantID,
                                              boolean recursively)

Deprecated. Superseded by #forModelParticipant(ParticipantInfo, boolean)

forUserGroup

public static PerformingParticipantFilter forUserGroup(String groupID)

Deprecated. Superseded by #forModelParticipant(ParticipantInfo)

forParticipant

public static PerformingParticipantFilter forParticipant(ParticipantInfo participant)

Gets the PerformingParticipantFilter for the given arguments. All sub participants are also included.

Parameters:

participant - - the participant for which the filter should be constructed

Returns:

the constructed PerformingParticipantFilter

forParticipant

public static PerformingParticipantFilter forParticipant(ParticipantInfo participant,
                                         boolean recursively)

Gets the PerformingParticipantFilter for the given arguments

Parameters:

participant - - the participant for which the filter should be constructed

recursively - - if sub participant should be included

Returns:

the constructed PerformingParticipantFilter

getFilterKind

public PerformingParticipantFilter.Kind getFilterKind()

Gets the PerformingParticipantFilter.Kind of the filter Also see

Returns:

the filters PerformingParticipantFilter.Kind

See Also:

FILTER_KIND_ANY_FOR_USER, FILTER_KIND_USER_GROUP, FILTER_KIND_MODEL_PARTICIPANT

getParticipantID

public String getParticipantID()

Returns the id for the participant

Returns:

the id for the participant, can be null

getParticipant

public ParticipantInfo getParticipant()

Returns the ParticipantInfo for the participant

Returns:

the ParticipantInfo for the participant, can be null

isRecursively

public boolean isRecursively()

Returns if this filter should include all sub participants

Returns:

true if all sub participant should be considered, false otherwise

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.