com.sssw.fw.directory.api
Interface EbiDirectoryGroupsQuery

public interface EbiDirectoryGroupsQuery

This provides an interface for querying directory realm groups. It's used to return a selected set of realm groups.

Method Summary

String	getGroupIDStartsWith() Returns the group name pattern for the query
String	getParentGroupID() Returns the parent group name for the query
String	getRealmName() Returns the realm name for the query
void	whereGroupIDStartsWith(String pattern) Specify a search condition for "where groupID starts with"
void	whereParentGroupID(String parentID) Specify a parent group to limit the query to groups having a selected parent.
void	whereRealmName(String realmName) Specify a realm name to limit the query to a single realm

Method Detail

whereGroupIDStartsWith

public void whereGroupIDStartsWith(String pattern)

Specify a search condition for "where groupID starts with"

Parameters:

pattern - the string value for the "starts with" pattern

whereRealmName

public void whereRealmName(String realmName)

Specify a realm name to limit the query to a single realm

Parameters:

realmName - the string value for the realm name

whereParentGroupID

public void whereParentGroupID(String parentID)

Specify a parent group to limit the query to groups having a selected parent. Specify a null value to select root groups only.

Parameters:

parentID - the string value for the parent group name

getGroupIDStartsWith

public String getGroupIDStartsWith()

Returns the group name pattern for the query

Returns:

a string representing the group name pattern or null if no pattern specified.

getRealmName

public String getRealmName()

Returns the realm name for the query

Returns:

a string representing the realm name or null if no realm specified.

getParentGroupID

public String getParentGroupID()

Returns the parent group name for the query

Returns:

a string representing the parent group or null if no parent specified.