|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.query.ParticipantAssociationFilter
public class ParticipantAssociationFilter
Filter criterion for restricting UserQuerys producing users having granted
specific roles/organizations or being members of specific user groups.
| Nested Class Summary | |
|---|---|
static class |
ParticipantAssociationFilter.Kind
Enumeration for participant grant filter kind definitions. |
| Field Summary | |
|---|---|
static ParticipantAssociationFilter.Kind |
FILTER_KIND_DEPARTMENT
Constant marking a department filter. |
static ParticipantAssociationFilter.Kind |
FILTER_KIND_MODEL_PARTICIPANT
Constant marking a model participant grant filter. |
static ParticipantAssociationFilter.Kind |
FILTER_KIND_TEAM_LEADER
Constant marking a team leader filter. |
static ParticipantAssociationFilter.Kind |
FILTER_KIND_USER
Constant marking a user filter. |
static ParticipantAssociationFilter.Kind |
FILTER_KIND_USER_GROUP
Constant marking a user group membership filter. |
| Method Summary | |
|---|---|
Object |
accept(FilterEvaluationVisitor visitor,
Object context)
Visitor dispatch callback used for evaluating filter criteria. |
static ParticipantAssociationFilter |
forDepartment(DepartmentInfo department)
Constructs a filter criterion matching the department identified by the given DepartmentInfo instance. |
static ParticipantAssociationFilter |
forModelParticipant(String participantID)
Deprecated. Superseded by forParticipant(ParticipantInfo) |
static ParticipantAssociationFilter |
forModelParticipant(String participantID,
boolean recursively)
Deprecated. Superseded by forParticipant(ParticipantInfo, boolean) |
static ParticipantAssociationFilter |
forParticipant(ParticipantInfo participant)
Constructs a filter criterion matching the participant identified by the given ParticipantInfo. |
static ParticipantAssociationFilter |
forParticipant(ParticipantInfo participant,
boolean recursively)
Constructs a filter criterion matching the participant identified by the given ParticipantInfo. |
static ParticipantAssociationFilter |
forTeamLeader(RoleInfo role)
Constructs a filter criterion matching the team leader role identified by the given RoleInfo. |
static ParticipantAssociationFilter |
forTeamLeader(String roleId)
Deprecated. Superseded by forTeamLeader(RoleInfo) |
static ParticipantAssociationFilter |
forUser(String account)
Deprecated. Superseded by forParticipant(ParticipantInfo) |
ParticipantAssociationFilter.Kind |
getFilterKind()
Retrieves the ParticipantAssociationFilter.Kind of the filter. |
ParticipantInfo |
getParticipant()
Retrieves the ParticipantInfo to filter for. |
String |
getParticipantID()
Retrieves the ID of the participant to filter for. |
static ParticipantAssociationFilter |
inUserGroup(String groupID)
Deprecated. Superseded by forParticipant(ParticipantInfo) |
boolean |
isRecursively()
Retrieves whether this filter will match a participant hierarchy or just a specific participant. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final ParticipantAssociationFilter.Kind FILTER_KIND_MODEL_PARTICIPANT
public static final ParticipantAssociationFilter.Kind FILTER_KIND_USER_GROUP
public static final ParticipantAssociationFilter.Kind FILTER_KIND_USER
public static final ParticipantAssociationFilter.Kind FILTER_KIND_TEAM_LEADER
public static final ParticipantAssociationFilter.Kind FILTER_KIND_DEPARTMENT
| Method Detail |
|---|
public static ParticipantAssociationFilter forModelParticipant(String participantID)
forParticipant(ParticipantInfo)
participantID - The ID of the model participant to filter for.
public static ParticipantAssociationFilter forModelParticipant(String participantID,
boolean recursively)
forParticipant(ParticipantInfo, boolean)
participantID - The ID of the model participant to filter for.public static ParticipantAssociationFilter inUserGroup(String groupID)
forParticipant(ParticipantInfo)
groupID - The ID of the user group to filter for.public static ParticipantAssociationFilter forUser(String account)
forParticipant(ParticipantInfo)
account - The account of the user to filter for.public static ParticipantAssociationFilter forTeamLeader(String roleId)
forTeamLeader(RoleInfo)
roleId - The id of the team leader role to filter for.public static ParticipantAssociationFilter forParticipant(ParticipantInfo participant)
ParticipantInfo.
participant - The participant to filter for.
public static ParticipantAssociationFilter forParticipant(ParticipantInfo participant,
boolean recursively)
ParticipantInfo.
participant - The participant to filter for.recursively - Flag to determine if evaluation of this filter
should traverse the participant hierarchy.public static ParticipantAssociationFilter forTeamLeader(RoleInfo role)
RoleInfo.
role - The team leader role to filter for.public static ParticipantAssociationFilter forDepartment(DepartmentInfo department)
DepartmentInfo instance.
department - The department users have to assigned to. May be null which means the default department.public ParticipantAssociationFilter.Kind getFilterKind()
ParticipantAssociationFilter.Kind of the filter.
public String getParticipantID()
public ParticipantInfo getParticipant()
ParticipantInfo to filter for.
public boolean isRecursively()
true if this filter matches a participant hierarchy,
false otherwise.
public Object accept(FilterEvaluationVisitor visitor,
Object context)
FilterCriterionreturn visitor.visit(this, context), thus calling the appropriately
overloaded visitation method.
accept in interface FilterCriterionvisitor - The visitor performing the evaluation.context - Information used by the visitor during the visitation process.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||