com.sssw.fw.directory.api
Interface EbiDirectoryUsersQuery

public interface EbiDirectoryUsersQuery

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

Method Summary

String	getGroupID() Returns the group name for the query
String	getRealmName() Returns the realm name for the query
String	getUserIDStartsWith() Returns the user name pattern for the query
void	whereGroupID(String groupID) Specify a group name to limit the query to a single group
void	whereRealmName(String realmName) Specify a realm name to limit the query to a single realm
void	whereUserIDStartsWith(String pattern) Specify a search condition for "where userID starts with"

Method Detail

whereUserIDStartsWith

public void whereUserIDStartsWith(String pattern)

Specify a search condition for "where userID 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

whereGroupID

public void whereGroupID(String groupID)

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

Parameters:

groupID - the string value for the group name

getUserIDStartsWith

public String getUserIDStartsWith()

Returns the user name pattern for the query

Returns:

a string representing the user 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.

getGroupID

public String getGroupID()

Returns the group name for the query

Returns:

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