Package edu.internet2.middleware.grouperVoot.messages

Class VootResponse

java.lang.Object

edu.internet2.middleware.grouperVoot.messages.VootResponse

Direct Known Subclasses:

VootGetGroupsResponse, VootGetMembersResponse

public abstract class VootResponse
extends Object

Bean to respresent a valid VOOT response.

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	itemsPerPage	Number of items in a page
protected Integer	startIndex	Start index starts with 0
protected Integer	totalResults	Total number of results

Constructor Summary

Constructors

Constructor	Description
VootResponse()

Method Summary

Modifier and Type	Method	Description
Integer	getItemsPerPage()	Get the number of items in a page.
Integer	getStartIndex()	Get start index, starts with 0
Integer	getTotalResults()	Get the total number of results.
void	paginate(Object[] resultArray, int start, int count)	Paginate the results ad assign the values to pagination attributes.
void	setItemsPerPage(Integer itemsPerPage1)	Set the number of items in a page.
void	setStartIndex(Integer startIndex1)	Set start index, starts with 0
void	setTotalResults(Integer totalResults1)	Set the total number of results.

Methods inherited from class java.lang.Object

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

Field Details

startIndex

protected Integer startIndex

Start index starts with 0

totalResults

protected Integer totalResults

Total number of results

itemsPerPage

protected Integer itemsPerPage

Number of items in a page

Constructor Details

VootResponse

public VootResponse()

Method Details

paginate

public void paginate(Object[] resultArray,
 int start,
 int count)

Paginate the results ad assign the values to pagination attributes.

Parameters:

resultArray - the compelte resultset from Grouper

start - the index of the first element to be put into result

count - the number of elements to be put into result

getStartIndex

public Integer getStartIndex()

Get start index, starts with 0

Returns:

the start index

setStartIndex

public void setStartIndex(Integer startIndex1)

Set start index, starts with 0

Parameters:

startIndex1 - the start index

getTotalResults

public Integer getTotalResults()

Get the total number of results.

Returns:

the total number of results.

setTotalResults

public void setTotalResults(Integer totalResults1)

Set the total number of results.

Parameters:

totalResults1 - the total number of results.

getItemsPerPage

public Integer getItemsPerPage()

Get the number of items in a page.

Returns:

the number of items in a page.

setItemsPerPage

public void setItemsPerPage(Integer itemsPerPage1)

Set the number of items in a page.

Parameters:

itemsPerPage1 - the number of items in a page.