Package edu.internet2.middleware.grouper.ws.coresoap

Class WsFindGroupsResults

java.lang.Object

edu.internet2.middleware.grouper.ws.coresoap.WsFindGroupsResults

All Implemented Interfaces:

WsResponseBean, ResultMetadataHolder

public class WsFindGroupsResults
extends Object
implements WsResponseBean, ResultMetadataHolder

returned from the group find query

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WsFindGroupsResults.WsFindGroupsResultsCode	result code of a request

Constructor Summary

Constructors

Constructor	Description
WsFindGroupsResults()

Method Summary

Modifier and Type	Method	Description
void	assignGroupResult(Group group, boolean includeDetail)	put a group in the results
void	assignGroupResult(Set<Group> groupSet, boolean includeDetail)	put a group in the results
void	assignResultCode(WsFindGroupsResults.WsFindGroupsResultsCode wsFindGroupsResultsCode)	assign the code from the enum
void	assignResultCodeException(WsFindGroupsResults.WsFindGroupsResultsCode wsFindGroupsResultsCodeOverride, String theError, Exception e)	prcess an exception, log, etc
WsGroup[]	getGroupResults()	has 0 to many groups that match the query by example
WsResponseMeta	getResponseMetadata()	get the response metadata
WsResultMeta	getResultMetadata()	get the result metadata
void	setGroupResults(WsGroup[] groupResults1)	basic results to the query
void	setResponseMetadata(WsResponseMeta responseMetadata1)
void	setResultMetadata(WsResultMeta resultMetadata1)

Methods inherited from class java.lang.Object

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

Constructor Details

WsFindGroupsResults

public WsFindGroupsResults()

Method Details

assignResultCode

public void assignResultCode(WsFindGroupsResults.WsFindGroupsResultsCode wsFindGroupsResultsCode)

assign the code from the enum

Parameters:

wsFindGroupsResultsCode -

assignGroupResult

public void assignGroupResult(Group group,
 boolean includeDetail)

put a group in the results

Parameters:

includeDetail - true if the detail for each group should be included

group -

assignGroupResult

public void assignGroupResult(Set<Group> groupSet,
 boolean includeDetail)

put a group in the results

Parameters:

includeDetail - true if the detail for each group should be included

groupSet -

getGroupResults

public WsGroup[] getGroupResults()

has 0 to many groups that match the query by example

Returns:

the groupResults

setGroupResults

public void setGroupResults(WsGroup[] groupResults1)

basic results to the query

Parameters:

groupResults1 - the groupResults to set

assignResultCodeException

public void assignResultCodeException(WsFindGroupsResults.WsFindGroupsResultsCode wsFindGroupsResultsCodeOverride,
 String theError,
 Exception e)

prcess an exception, log, etc

Parameters:

wsFindGroupsResultsCodeOverride -

wsAddMemberResultsCodeOverride -

theError -

e -

getResultMetadata

public WsResultMeta getResultMetadata()

Description copied from interface: WsResponseBean

get the result metadata

Specified by:

getResultMetadata in interface ResultMetadataHolder

Specified by:

getResultMetadata in interface WsResponseBean

Returns:

the resultMetadata

getResponseMetadata

public WsResponseMeta getResponseMetadata()

Description copied from interface: WsResponseBean

get the response metadata

Specified by:

getResponseMetadata in interface WsResponseBean

Returns:

the response metadata

See Also:

• WsResponseBean.getResponseMetadata()

setResponseMetadata

public void setResponseMetadata(WsResponseMeta responseMetadata1)

Parameters:

responseMetadata1 - the responseMetadata to set

setResultMetadata

public void setResultMetadata(WsResultMeta resultMetadata1)

Parameters:

resultMetadata1 - the resultMetadata to set