com.memberwebs.ldapxml
Class LXSpecs

java.lang.Object
  com.memberwebs.ldapxml.LXSpecs

public class LXSpecs

extends java.lang.Object

Additional specifications for retrieving data from an LDAP directory.

Version:

0.5

Author:

stef@memberwebs.com

Field Summary

static int	DEPTH_BASE Don't retrieve any sub entries.
static int	DEPTH_INFINITE Retrieve all sub entries.
static int	DEPTH_SINGLE Retrive only direct children of the referenced entry.

Constructor Summary

LXSpecs()
Construct a new LXSpecs object.

Method Summary

java.lang.Object	getData()
int	getDepth() Returns the depth to which entries are recursively retrieved from the LDAP directory.
java.lang.String	getFilter() Gets the additional filter when searching for entries.
java.lang.String	getFilter(java.lang.String prevFilter) Gets the filter when searching for entries, combining it with another filter.
java.lang.String	getLanguage() Get preferred language.
int	getLimit()
java.lang.String[]	getSort() Get the requested sort order.
boolean[]	getSortDirection() Get the sort directions (ascending, descending) for the sort order.
int	getStart()
void	setData(java.lang.Object data)
void	setDepth(int depth) Sets the depth to which entries are recursively retrieved from the LDAP directory.
void	setFilter(java.lang.String filter) Set an additional filter used when searching for entries.
void	setLanguage(java.lang.String language) Set preferred language for LDAP retrieval.
void	setLimit(int limit)
void	setSort(java.lang.String[] sort) Set the sort order.
void	setStart(int start)

Methods inherited from class java.lang.Object

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

Field Detail

DEPTH_BASE

public static final int DEPTH_BASE

Don't retrieve any sub entries.

See Also:

Constant Field Values

DEPTH_SINGLE

public static final int DEPTH_SINGLE

Retrive only direct children of the referenced entry.

See Also:

Constant Field Values

DEPTH_INFINITE

public static final int DEPTH_INFINITE

Retrieve all sub entries.

See Also:

Constant Field Values

Constructor Detail

LXSpecs

public LXSpecs()

Construct a new LXSpecs object.

Method Detail

getStart

public final int getStart()

getLimit

public final int getLimit()

setStart

public final void setStart(int start)

setLimit

public final void setLimit(int limit)

getLanguage

public final java.lang.String getLanguage()

Get preferred language.

Returns:

The language or null if none set.

setLanguage

public final void setLanguage(java.lang.String language)

Set preferred language for LDAP retrieval.

Parameters:

language - The language or null for no preference.

getDepth

public final int getDepth()

Returns the depth to which entries are recursively retrieved from the LDAP directory.

Returns:

The depth.

setDepth

public final void setDepth(int depth)

Sets the depth to which entries are recursively retrieved from the LDAP directory.

Returns:

The depth.

getFilter

public final java.lang.String getFilter()

Gets the additional filter when searching for entries.

Returns:

The filter.

getFilter

public final java.lang.String getFilter(java.lang.String prevFilter)

Gets the filter when searching for entries, combining it with another filter.

Parameters:

prevFilter - The other filter.

Returns:

The combined filter.

setFilter

public final void setFilter(java.lang.String filter)

Set an additional filter used when searching for entries.

Parameters:

filter - The filter.

getSort

public final java.lang.String[] getSort()

Get the requested sort order.

Returns:

The sort order, or null if none present.

getSortDirection

public final boolean[] getSortDirection()

Get the sort directions (ascending, descending) for the sort order.

Returns:

An array of sort directions.

setSort

public final void setSort(java.lang.String[] sort)

Set the sort order. Attribute names prefixed with '-' are treated as descending.

Parameters:

sort - The sort order.

getData

public final java.lang.Object getData()

setData

public final void setData(java.lang.Object data)