|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.query.Query
org.eclipse.stardust.engine.api.query.UserQuery
public class UserQuery
Query for fetching workflow users matching specific criteria. Most common filter criteria will be the user's attributes.
A more advanced use case is retrieving users having a specific role or organization membership by usingParticipantGrantFilter.
| Nested Class Summary | |
|---|---|
static class |
UserQuery.Attribute
User attribute supporting filter operations. |
| Field Summary | |
|---|---|
static UserQuery.Attribute |
ACCOUNT
|
static UserQuery.Attribute |
DESCRIPTION
|
static UserQuery.Attribute |
EMAIL
|
static UserQuery.Attribute |
FAILED_LOGIN_COUNT
|
static UserQuery.Attribute |
FIRST_NAME
|
static UserQuery.Attribute |
LAST_LOGIN_TIME
|
static UserQuery.Attribute |
LAST_NAME
|
static UserQuery.Attribute |
OID
|
static FilterableAttribute |
REALM_ID
|
static UserQuery.Attribute |
VALID_FROM
|
static UserQuery.Attribute |
VALID_TO
|
| Constructor Summary | |
|---|---|
UserQuery()
Initializes the query to find all users. |
|
| Method Summary | |
|---|---|
static UserQuery |
findActive()
Creates a query for finding active users. |
static UserQuery |
findActiveForUserGroup(String id)
Creates a query for finding active users associated to a given user group. |
static UserQuery |
findAll()
Creates a query for finding all users. |
static UserQuery |
findAllForUserGroup(String id)
Creates a query for finding users associated to a given user group. |
| Methods inherited from class org.eclipse.stardust.engine.api.query.Query |
|---|
getFilter, getOrderCriteria, getPolicy, orderBy, orderBy, orderBy, removePolicy, setPolicy, toString, where |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final UserQuery.Attribute OID
public static final UserQuery.Attribute ACCOUNT
public static final UserQuery.Attribute FIRST_NAME
public static final UserQuery.Attribute LAST_NAME
public static final UserQuery.Attribute EMAIL
public static final UserQuery.Attribute VALID_FROM
public static final UserQuery.Attribute VALID_TO
public static final UserQuery.Attribute DESCRIPTION
public static final UserQuery.Attribute FAILED_LOGIN_COUNT
public static final UserQuery.Attribute LAST_LOGIN_TIME
public static final FilterableAttribute REALM_ID
| Constructor Detail |
|---|
public UserQuery()
findAll()| Method Detail |
|---|
public static UserQuery findAll()
public static UserQuery findActive()
Active means having no expired VALID_TO attribute.
public static UserQuery findAllForUserGroup(String id)
public static UserQuery findActiveForUserGroup(String id)
Active means having no expired VALID_TO attribute.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||