com.ecircleag.webservices

Class GroupLookupParams

Object

GroupLookupParams

All Implemented Interfaces:

Serializable

public class GroupLookupParams
extends Object
implements Serializable

Helper class wrapping a collection of parameters used to express search criteria for group lookup.

Author:

mhelff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GroupLookupParams() Creates new, empty GroupLookupParams.

Method Summary

Modifier and Type	Method and Description
Integer	getBatchOffset()
Integer	getBatchSize()
String	getGroupName()
String	getSortProperty()
Boolean	isSortAscending()
void	setBatchOffset(Integer batchOffset) Sets the batch offset for the returned data.
void	setBatchSize(Integer batchSize) Sets the batch size for the returned data.
void	setGroupName(String groupName) Sets the group name/email search criterion.
void	setSortAscending(Boolean sortAscending) Sets the sort direction of the result.
void	setSortProperty(String sortProperty) Sets the sort column name for the result.

Methods inherited from class Object

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

Constructor Detail

GroupLookupParams

public GroupLookupParams()

Creates new, empty GroupLookupParams.

Method Detail

getGroupName

public String getGroupName()

Returns:

the group name search criterion.

See Also:

setGroupName(String)

setGroupName

public void setGroupName(String groupName)

Sets the group name/email search criterion. A substring search is performed for the group name/email.

Parameters:

groupName - the group name/email, or a part of the name/email.

See Also:

#setGroupId(String)

getBatchSize

public Integer getBatchSize()

Returns:

the batch size.

See Also:

setBatchSize(Integer)

setBatchSize

public void setBatchSize(Integer batchSize)

Sets the batch size for the returned data. The maximum value for this parameter is 250.

Parameters:

batchSize - the batch size.

getBatchOffset

public Integer getBatchOffset()

Returns:

the batch offset.

See Also:

setBatchOffset(Integer)

setBatchOffset

public void setBatchOffset(Integer batchOffset)

Sets the batch offset for the returned data. Must be a positive number.

Parameters:

batchOffset - the batch offset.

getSortProperty

public String getSortProperty()

Returns:

the sort property name.

See Also:

setSortProperty(String)

setSortProperty

public void setSortProperty(String sortProperty)

Sets the sort column name for the result. One of:

• group.PK
• group.Name

Parameters:

sortProperty - the sort property name.

isSortAscending

public Boolean isSortAscending()

Returns:

the sort ascending flag.

See Also:

setSortAscending(Boolean)

setSortAscending

public void setSortAscending(Boolean sortAscending)

Sets the sort direction of the result. If set to true, the returned result is sorted in ascending order, otherwise in descending order.

Parameters:

sortAscending - the sort ascending flag.