edu.vt.middleware.ed.query
Interface GroupQuery

public interface GroupQuery

GroupQuery provides an interface for the searching of group records in the Enterprise Directory.

Version:

$Revision: 7928 $

Author:

David Hawes

Field Summary

static String	LOCAL_JNDI_NAME local jndi name
static String	REMOTE_JNDI_NAME remote jndi name

Method Summary

List<DirectoryObject>	getMembers(String uugid, boolean recursive) Returns the members of the supplied group.
String	searchGroup(Long uid) Returns the DSML for the group with the supplied sequence number.
String	searchGroupByUugid(String uugid) Returns the DSML for the group with the supplied uugid.
List<Group>	searchGroups(DirectSearchCriteria criteria) Search for Groups given the specified criteria.
List<Group>	searchGroups(GroupSearchCriteria criteria) Search for Groups given the specified criteria.

Field Detail

LOCAL_JNDI_NAME

static final String LOCAL_JNDI_NAME

local jndi name

See Also:

Constant Field Values

REMOTE_JNDI_NAME

static final String REMOTE_JNDI_NAME

remote jndi name

See Also:

Constant Field Values

Method Detail

searchGroups

List<Group> searchGroups(DirectSearchCriteria criteria)
                         throws ApplicationException

Search for Groups given the specified criteria.

Parameters:

criteria - DirectSearchCriteria to use for searching for groups

Returns:

List of the results produced by this search

Throws:

ApplicationException - when an error occurs

searchGroups

List<Group> searchGroups(GroupSearchCriteria criteria)
                         throws ApplicationException

Search for Groups given the specified criteria.

Parameters:

criteria - GroupSearchCriteria to use for searching for groups

Returns:

List of the results produced by this search

Throws:

ApplicationException - when an error occurs

searchGroup

String searchGroup(Long uid)
                   throws ApplicationException

Returns the DSML for the group with the supplied sequence number.

Parameters:

uid - Long to search for

Returns:

String

Throws:

ApplicationException - if the method fails

searchGroupByUugid

String searchGroupByUugid(String uugid)
                          throws ApplicationException

Returns the DSML for the group with the supplied uugid.

Parameters:

uugid - String to search for

Returns:

String

Throws:

ApplicationException - if the method fails

getMembers

List<DirectoryObject> getMembers(String uugid,
                                 boolean recursive)
                                 throws ApplicationException

Returns the members of the supplied group. If recursive is true, all child group members are returned as well.

Parameters:

uugid - String

recursive - boolean

Returns:

List of the results produced by this search

Throws:

ApplicationException - when an error occurs