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

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.coresoap.WsFindGroupsResults
All Implemented Interfaces:
WsResponseBean, ResultMetadataHolder

public class WsFindGroupsResults
extends java.lang.Object
implements WsResponseBean, ResultMetadataHolder

returned from the group find query

Author:
mchyzer

Nested Class Summary
static class WsFindGroupsResults.WsFindGroupsResultsCode
          result code of a request
 
Constructor Summary
WsFindGroupsResults()
           
 
Method Summary
 void assignGroupResult(Group group, boolean includeDetail)
          put a group in the results
 void assignGroupResult(java.util.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, java.lang.String theError, java.lang.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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsFindGroupsResults

public WsFindGroupsResults()
Method Detail

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(java.util.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,
                                      java.lang.String theError,
                                      java.lang.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 WsResponseBean
Specified by:
getResultMetadata in interface ResultMetadataHolder
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