org.eclipse.stardust.engine.api.query

Class UserQuery

java.lang.Object

org.eclipse.stardust.engine.api.query.Query

org.eclipse.stardust.engine.api.query.UserQuery

All Implemented Interfaces:

Serializable

public class UserQuery
extends Query

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 using ParticipantGrantFilter.

Version:

$Revision$

Author:

rsauer

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserQuery.Attribute User attribute supporting filter operations.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
UserQuery() Initializes the query to find all users.

Method Summary

Methods

Modifier and Type	Method and Description
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

OID

public static final UserQuery.Attribute OID

ACCOUNT

public static final UserQuery.Attribute ACCOUNT

FIRST_NAME

public static final UserQuery.Attribute FIRST_NAME

LAST_NAME

public static final UserQuery.Attribute LAST_NAME

EMAIL

public static final UserQuery.Attribute EMAIL

VALID_FROM

public static final UserQuery.Attribute VALID_FROM

VALID_TO

public static final UserQuery.Attribute VALID_TO

DESCRIPTION

public static final UserQuery.Attribute DESCRIPTION

FAILED_LOGIN_COUNT

public static final UserQuery.Attribute FAILED_LOGIN_COUNT

LAST_LOGIN_TIME

public static final UserQuery.Attribute LAST_LOGIN_TIME

REALM_ID

public static final FilterableAttribute REALM_ID

Constructor Detail

UserQuery

public UserQuery()

Initializes the query to find all users.

See Also:

findAll()

Method Detail

findAll

public static UserQuery findAll()

Creates a query for finding all users.

Returns:

The readily configured query.

findActive

public static UserQuery findActive()

Creates a query for finding active users.

Active means having no expired VALID_TO attribute.

Returns:

The readily configured query.

findAllForUserGroup

public static UserQuery findAllForUserGroup(String id)

Creates a query for finding users associated to a given user group.

Returns:

The readily configured query.

findActiveForUserGroup

public static UserQuery findActiveForUserGroup(String id)

Creates a query for finding active users associated to a given user group.

Active means having no expired VALID_TO attribute.

Returns:

The readily configured query.