fuego.papi
Class SearchScope

java.lang.Object
  fuego.papi.SearchScope

All Implemented Interfaces:

Serializable

public class SearchScope

extends Object

implements Serializable

Restricts the set of instances returned in a Filter by specifying the process instance status (StatusScope) and participant roles (ParticipantScope).

Example:

    //Include all instances of the process.
    SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.ALL,
                                              fuego.papi.StatusScope.ALL);

    // Include all instances in the process for a particular participant.
    SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.PARTICIPANT,
                                              fuego.papi.StatusScope.ALL);

    // Include all running instances in the process.
    SearchScope searchScope = new SearchScope(fuego.papi.ParticipantScope.ALL,
                                              fuego.papi.StatusScope.ONLY_INPROCESS);
 

See Also:

Filter, fuego.papi.ParticipantScope, fuego.papi.StatusScope, Serialized Form

Constructor Summary

SearchScope(ParticipantScope participantScope, StatusScope statusScope)
Creates a new SearchScope with the specified participant and status scopes and an empty activity scope.

SearchScope(ParticipantScope participantScope, StatusScope statusScope, String activityScope)
Deprecated. do not use activity scope

Method Summary

String	getActivityScope() Deprecated. do not use activity scope
ParticipantScope	getParticipantScope() Gets the participant scope of this search.
StatusScope	getStatusScope() Gets the status scope of this search.
void	setActivityScope(String activityScope) Deprecated. do not use 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)

Creates a new SearchScope with the specified participant and status scopes and an empty activity scope.

Parameters:

participantScope - the participant scope to search

statusScope - the status scope to search

See Also:

fuego.papi.ParticipantScope, fuego.papi.StatusScope

SearchScope

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

Deprecated. do not use activity scope

Creates a new SearchScope with the specified participant, status, and activity scopes.

Parameters:

participantScope - the participant scope to search

statusScope - the status scope to search

activityScope - the activity scope (activity name)

See Also:

fuego.papi.ParticipantScope, fuego.papi.StatusScope

Method Detail

setActivityScope

public void setActivityScope(String activityScope)

Deprecated. do not use activity scope

Sets a new activity scope.

Parameters:

activityScope - activity name to refine the search

getActivityScope

public String getActivityScope()

Deprecated. do not use activity scope

Gets the activity scope of this search.

Returns:

the activity name or null if no activity is found

setParticipantScope

public void setParticipantScope(ParticipantScope participantScope)

Sets a new participant scope.

Parameters:

participantScope - the participant scope to refine the search

See Also:

fuego.papi.ParticipantScope

getParticipantScope

public ParticipantScope getParticipantScope()

Gets the participant scope of this search.

Returns:

the participant scope

See Also:

fuego.papi.ParticipantScope

setStatusScope

public void setStatusScope(StatusScope statusScope)

Sets a new status scope.

Parameters:

statusScope - the status scope to refine the search

See Also:

fuego.papi.StatusScope

getStatusScope

public StatusScope getStatusScope()

Gets the status scope of this search.

Returns:

the status scope

See Also:

fuego.papi.StatusScope