Package net.bluemind.directory.api

Class DirEntryQuery

java.lang.Object

net.bluemind.directory.api.DirEntryQuery

public class DirEntryQuery
extends Object

Class representing DirEntry search parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DirEntryQuery.Dir
static class	DirEntryQuery.Order
static enum	DirEntryQuery.OrderBy
static enum	DirEntryQuery.StateFilter

Field Summary

Fields

Modifier and Type	Field	Description
BaseDirEntry.AccountType	accountTypeFilter	Filter by Account Type
String	dataLocation	Filter by data location
String	emailFilter	Filter by email
List<String>	entries	Filter by UID
List<String>	entryUidFilter	Filter by UID
int	from	Search offset
boolean	hiddenFilter	True, if the search should ignore hidden DirEntrys.
List<BaseDirEntry.Kind>	kindsFilter	Filter by Kind (USER, GROUP, RESOURCE, MAILSHARE, CALENDAR, ADDRESSBOOK, DOMAIN, ORG_UNIT, EXTERNALUSER)
boolean	lightResults	Set to true to prevent loading of dependent objects (pictures, org unit infos, etc)
String	nameFilter	Filter by name
String	nameOrEmailFilter	Filter by name or email
boolean	onlyManagable	True if the search returns only manageable DirEntrys (entries where the executing user owns the role MANAGE)
DirEntryQuery.Order	order	Search direction, ascending by default
List<Long>	orgUnitIds	Filter by Org Unit Item ids
int	size	Maximal result size, -1 if there is no limit.
DirEntryQuery.StateFilter	stateFilter	Filter by State (Archived, Active, All)
boolean	systemFilter	True, if the search should ignore internal(system) DirEntrys.

Constructor Summary

Constructors

Constructor	Description
DirEntryQuery()

Method Summary

Modifier and Type	Method	Description
static DirEntryQuery	all()	Creates a query which returns all DirEntrys
static DirEntryQuery.Order	defaultOrder()	Returns the default sort order
static DirEntryQuery	entries(String... uid)	Creates a query which filters by the given UIDs
static DirEntryQuery	entries(List<String> uids)	Creates a query which filters by the given UIDs
static DirEntryQuery	filterEmail(String email)	Creates a query which filters by email
static DirEntryQuery	filterEntryUid(String... entryUids)	Creates a query which filters by the UID parameter
static DirEntryQuery	filterKind(BaseDirEntry.Kind... kinds)	Creates a query which filters by the kind parameter
static DirEntryQuery	filterName(String name)	Creates a query which filters by name
static DirEntryQuery	filterNameOrEmail(String string)	Creates a query which filters by name or email
static DirEntryQuery.Order	order(DirEntryQuery.OrderBy by, DirEntryQuery.Dir dir)	Sets the sort order

Methods inherited from class java.lang.Object

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

Field Details

order

public DirEntryQuery.Order order

Search direction, ascending by default

nameFilter

public String nameFilter

Filter by name

hiddenFilter

public boolean hiddenFilter

True, if the search should ignore hidden DirEntrys. Default value is True

emailFilter

public String emailFilter

Filter by email

nameOrEmailFilter

public String nameOrEmailFilter

Filter by name or email

stateFilter

public DirEntryQuery.StateFilter stateFilter

Filter by State (Archived, Active, All)

systemFilter

public boolean systemFilter

True, if the search should ignore internal(system) DirEntrys. Default value is True

kindsFilter

public List<BaseDirEntry.Kind> kindsFilter

Filter by Kind (USER, GROUP, RESOURCE, MAILSHARE, CALENDAR, ADDRESSBOOK, DOMAIN, ORG_UNIT, EXTERNALUSER)

entries

public List<String> entries

Filter by UID

orgUnitIds

public List<Long> orgUnitIds

Filter by Org Unit Item ids

accountTypeFilter

public BaseDirEntry.AccountType accountTypeFilter

Filter by Account Type

from

public int from

Search offset

size

public int size

Maximal result size, -1 if there is no limit. The default value is -1

entryUidFilter

public List<String> entryUidFilter

Filter by UID

onlyManagable

public boolean onlyManagable

True if the search returns only manageable DirEntrys (entries where the executing user owns the role MANAGE)

dataLocation

public String dataLocation

Filter by data location

lightResults

public boolean lightResults

Set to true to prevent loading of dependent objects (pictures, org unit infos, etc)

Constructor Details

DirEntryQuery

public DirEntryQuery()

Method Details

all

public static DirEntryQuery all()

Creates a query which returns all DirEntrys

Returns:

DirEntryQuery

entries

public static DirEntryQuery entries(List<String> uids)

Creates a query which filters by the given UIDs

Parameters:

uids - List of UIDs

Returns:

DirEntryQuery

entries

public static DirEntryQuery entries(String... uid)

Creates a query which filters by the given UIDs

Parameters:

uids - Array of UIDs

Returns:

DirEntryQuery

defaultOrder

public static DirEntryQuery.Order defaultOrder()

Returns the default sort order

Returns:

the default sort order

order

public static DirEntryQuery.Order order(DirEntryQuery.OrderBy by,
 DirEntryQuery.Dir dir)

Sets the sort order

Parameters:

by - Defines the property used by the order statement

dir - The sort order

Returns:

the Order object

filterKind

public static DirEntryQuery filterKind(BaseDirEntry.Kind... kinds)

Creates a query which filters by the kind parameter

Parameters:

kinds - The requested kinds

Returns:

DirEntryQuery

filterName

public static DirEntryQuery filterName(String name)

Creates a query which filters by name

Parameters:

name - The name

Returns:

DirEntryQuery

filterEmail

public static DirEntryQuery filterEmail(String email)

Creates a query which filters by email

Parameters:

email - The email address

Returns:

DirEntryQuery

filterEntryUid

public static DirEntryQuery filterEntryUid(String... entryUids)

Creates a query which filters by the UID parameter

Parameters:

entryUids - Array of UIDs

Returns:

DirEntryQuery

filterNameOrEmail

public static DirEntryQuery filterNameOrEmail(String string)

Creates a query which filters by name or email

Parameters:

string - search value

Returns:

DirEntryQuery