Package edu.internet2.middleware.grouperVoot

Class VootLogic

java.lang.Object

edu.internet2.middleware.grouperVoot.VootLogic

public class VootLogic
extends Object

Business logic to implement the VOOT protocol.

Constructor Summary

Constructors

Constructor	Description
VootLogic()

Method Summary

Modifier and Type	Method	Description
static VootGetGroupsResponse	getGroups(Subject subject, String sortBy, int start, int count)	Get the groups that a person is in.
static VootGetGroupsResponse	getGroups(String search, String sortBy, int start, int count)	Get the groups that a person is in, searching by their name.
static VootGetMembersResponse	getMembers(Subject subject, VootGroup vootGroup, String sortBy, int start, int count)	Get the members for a group based on the VOOT group.

Methods inherited from class java.lang.Object

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

Constructor Details

VootLogic

public VootLogic()

Method Details

getMembers

public static VootGetMembersResponse getMembers(Subject subject,
 VootGroup vootGroup,
 String sortBy,
 int start,
 int count)

Get the members for a group based on the VOOT group.

Parameters:

subject - the subject querying the VOOT interface.

vootGroup - the group to be looked to find members.

sortBy - the field name to be used for sorting or null of no sorting.

start - the first element in the result set (0 means start from beginning).

count - the number of elements in the result set (-1 or 0 means find all).

Returns:

the response to be sent back to user in JSON format.

getGroups

public static VootGetGroupsResponse getGroups(Subject subject,
 String sortBy,
 int start,
 int count)

Get the groups that a person is in.

Parameters:

subject - the subject representing the person used for search.

sortBy - the field name to be used for sorting or null of no sorting.

start - the first element in the result set (0 means start from beginning).

count - the number of elements in the result set (-1 or 0 means find all).

Returns:

the groups the subject passed as a parameter is part of.

getGroups

public static VootGetGroupsResponse getGroups(String search,
 String sortBy,
 int start,
 int count)

Get the groups that a person is in, searching by their name.

Parameters:

search - the search term to be searched in group name.

sortBy - the field name to be used for sorting or null of no sorting.

start - the first element in the result set (0 means start from beginning).

count - the number of elements in the result set (-1 or 0 means find all).

Returns:

the groups found satisfying search criteria.