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

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

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

 results for the has member call.
 
 result code:
 code of the result for this group overall
 SUCCESS: means everything ok
 GROUP_DUPLICATE: found multiple groups
 etc
 

Author:
mchyzer

Nested Class Summary
static class WsHasMemberResults.WsHasMemberResultsCode
          result code of a request
 
Constructor Summary
WsHasMemberResults()
           
 
Method Summary
 void assignResultCode(WsHasMemberResults.WsHasMemberResultsCode hasMemberResultsCode)
          assign the code from the enum
 void assignResultCodeException(WsHasMemberResults.WsHasMemberResultsCode wsHasMembersResultsCodeOverride, java.lang.String theError, java.lang.Exception e)
          prcess an exception, log, etc
 WsResponseMeta getResponseMetadata()
          get the response metadata
 WsResultMeta getResultMetadata()
          get the result metadata
 WsHasMemberResult[] getResults()
          results for each assignment sent in
 java.lang.String[] getSubjectAttributeNames()
          attributes of subjects returned, in same order as the data
 WsGroup getWsGroup()
           
 WsHasMemberResults.WsHasMemberResultsCode retrieveResultCode()
          convert the result code back to enum
 void setResponseMetadata(WsResponseMeta responseMetadata1)
           
 void setResultMetadata(WsResultMeta resultMetadata1)
           
 void setResults(WsHasMemberResult[] results1)
          results for each assignment sent in
 void setSubjectAttributeNames(java.lang.String[] attributeNamesa)
          attributes of subjects returned, in same order as the data
 void setWsGroup(WsGroup wsGroup1)
           
 void tallyResults(java.lang.String theSummary)
          make sure if there is an error, to record that as an error
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsHasMemberResults

public WsHasMemberResults()
Method Detail

assignResultCode

public void assignResultCode(WsHasMemberResults.WsHasMemberResultsCode hasMemberResultsCode)
assign the code from the enum

Parameters:
hasMemberResultsCode -

retrieveResultCode

public WsHasMemberResults.WsHasMemberResultsCode retrieveResultCode()
convert the result code back to enum

Returns:
the enum code

getResults

public WsHasMemberResult[] getResults()
results for each assignment sent in

Returns:
the results

setResults

public void setResults(WsHasMemberResult[] results1)
results for each assignment sent in

Parameters:
results1 - the results to set

getWsGroup

public WsGroup getWsGroup()
Returns:
the wsGroup

setWsGroup

public void setWsGroup(WsGroup wsGroup1)
Parameters:
wsGroup1 - the wsGroup to set

assignResultCodeException

public void assignResultCodeException(WsHasMemberResults.WsHasMemberResultsCode wsHasMembersResultsCodeOverride,
                                      java.lang.String theError,
                                      java.lang.Exception e)
prcess an exception, log, etc

Parameters:
wsHasMembersResultsCodeOverride -
theError -
e -

tallyResults

public void tallyResults(java.lang.String theSummary)
make sure if there is an error, to record that as an error

Parameters:
theSummary - of entire request

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

getSubjectAttributeNames

public java.lang.String[] getSubjectAttributeNames()
attributes of subjects returned, in same order as the data

Returns:
the attributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(java.lang.String[] attributeNamesa)
attributes of subjects returned, in same order as the data

Parameters:
attributeNamesa - the attributeNames to set

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