fuego.papi
Class SearchScope

java.lang.Object
  fuego.papi.SearchScope

All Implemented Interfaces:

Serializable

public class SearchScope
extends Object
implements Serializable

This class represent the scope to execute a search over the instances. The SearchScope limits the context where the filter will be executed.
For example:
If you want to execute a filter over all instances of the process.
SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.ALL, fuego.papi.StatusScope.ALL, null);

If you want to execute a filter over all instances in an specific activity.
SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.ALL, fuego.papi.StatusScope.ALL, activityName);

If you want to execute a filter over all instances in the process for a particular participant.
SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.PARTICIPANT, fuego.papi.StatusScope.ALL, activityName);

If you want to execute a filter over all running instances in the process.
SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.ALL, fuego.papi.StatusScope.ONLY_INPROCESS, activityName);

See Also:

Filter, ParticipantScope, StatusScope, Serialized Form

Constructor Summary

SearchScope(ParticipantScope participantScope, StatusScope statusScope)
This constructor create a new SearchScope with a specific participant and status scope and empty activity scope.

SearchScope(ParticipantScope participantScope, StatusScope statusScope, String activityScope)
This constructor create a new SearchScope with a specific participant and status and activity scope.

Method Summary

static SearchScope	create()
String	getActivityScope() Returns the activity scope of this search.
ParticipantScope	getParticipantScope() Returns the participant scope of this search.
StatusScope	getStatusScope() Returns the status scope of this search.
void	setActivityScope(String activityScope) Sets a new activity scope
void	setParticipantScope(ParticipantScope participantScope) Sets a new participant scope.
void	setStatusScope(StatusScope statusScope) Sets a new status scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchScope

public SearchScope(ParticipantScope participantScope,
                   StatusScope statusScope)

This constructor create a new SearchScope with a specific participant and status scope and empty activity scope.

Parameters:

participantScope - The participant scope to search

statusScope - The status scope to search

See Also:

ParticipantScope, StatusScope

SearchScope

public SearchScope(ParticipantScope participantScope,
                   StatusScope statusScope,
                   String activityScope)

This constructor create a new SearchScope with a specific participant and status and activity scope.

Parameters:

participantScope - The participant scope to search

statusScope - The status scope to search

activityScope - The activity scope (activity name)

See Also:

ParticipantScope, StatusScope

Method Detail

create

public static SearchScope create()

setActivityScope

public void setActivityScope(String activityScope)

Sets a new activity scope

Parameters:

activityScope - Activity name to refine the search

getActivityScope

public String getActivityScope()

Returns the activity scope of this search.

Returns:

The activity name or null if not has activity.

setParticipantScope

public void setParticipantScope(ParticipantScope participantScope)

Sets a new participant scope.

Parameters:

participantScope - The participant scope to refine the search.

See Also:

ParticipantScope

getParticipantScope

public ParticipantScope getParticipantScope()

Returns the participant scope of this search.

Returns:

The participant scope.

See Also:

ParticipantScope

setStatusScope

public void setStatusScope(StatusScope statusScope)

Sets a new status scope.

Parameters:

statusScope - The status scope to refine the search.

See Also:

StatusScope

getStatusScope

public StatusScope getStatusScope()

Returns the status scope of this search.

Returns:

The status scope.

See Also:

StatusScope