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

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

public class WsGetGroupsResult
extends Object
implements ResultMetadataHolder

 results for the get groups call.
 
 result code:
 code of the result for this group overall
 SUCCESS: means everything ok
 SUBJECT_NOT_FOUND: cant find the subject
 SUBJECT_DUPLICATE: found multiple groups
 EXCEPTION
 

Author:
mchyzer

Nested Class Summary
static class WsGetGroupsResult.WsGetGroupsResultCode
          result code of a request
 
Constructor Summary
WsGetGroupsResult()
           
 
Method Summary
 void assignGroupResult(Set<Group> groupSet, boolean includeDetail)
          put a group in the results
 void assignGroupResult(Set<PITGroup> pitGroupSet)
          put pit groups in the results
 void assignResultCode(WsGetGroupsResult.WsGetGroupsResultCode wsGetGroupsResultsCode)
          assign the code from the enum
 void assignResultCodeException(WsGetGroupsResult.WsGetGroupsResultCode wsGetGroupsResultsCodeOverride, String theError, WsSubjectLookup wsSubjectLookup, Exception e)
          prcess an exception, log, etc
 WsResultMeta getResultMetadata()
          get the result metadata
 WsGroup[] getWsGroups()
          results for each assignment sent in
 WsSubject getWsSubject()
          subject that was added
 WsGetGroupsResult.WsGetGroupsResultCode resultCode()
          convert string to result code
 WsGetGroupsResult.WsGetGroupsResultCode retrieveResultCode()
          convert the result code back to enum
 void setResultMetadata(WsResultMeta resultMetadata1)
           
 void setWsGroups(WsGroup[] results1)
          results for each assignment sent in
 void setWsSubject(WsSubject wsSubject1)
          subject that was added
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsGetGroupsResult

public WsGetGroupsResult()
Method Detail

assignResultCode

public void assignResultCode(WsGetGroupsResult.WsGetGroupsResultCode wsGetGroupsResultsCode)
assign the code from the enum

Parameters:
wsGetGroupsResultsCode -

retrieveResultCode

public WsGetGroupsResult.WsGetGroupsResultCode retrieveResultCode()
convert the result code back to enum

Returns:
the enum code

getWsGroups

public WsGroup[] getWsGroups()
results for each assignment sent in

Returns:
the results

setWsGroups

public void setWsGroups(WsGroup[] results1)
results for each assignment sent in

Parameters:
results1 - the results to set

assignResultCodeException

public void assignResultCodeException(WsGetGroupsResult.WsGetGroupsResultCode wsGetGroupsResultsCodeOverride,
                                      String theError,
                                      WsSubjectLookup wsSubjectLookup,
                                      Exception e)
prcess an exception, log, etc

Parameters:
wsGetGroupsResultsCodeOverride -
wsAddMemberResultsCodeOverride -
theError -
wsSubjectLookup - is current subject
e -

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 -

assignGroupResult

public void assignGroupResult(Set<PITGroup> pitGroupSet)
put pit groups in the results

Parameters:
pitGroupSet -

getResultMetadata

public WsResultMeta getResultMetadata()
Description copied from interface: ResultMetadataHolder
get the result metadata

Specified by:
getResultMetadata in interface ResultMetadataHolder
Returns:
the resultMetadata

getWsSubject

public WsSubject getWsSubject()
subject that was added

Returns:
the subjectId

setWsSubject

public void setWsSubject(WsSubject wsSubject1)
subject that was added

Parameters:
wsSubject1 - the wsSubject1 to set

setResultMetadata

public void setResultMetadata(WsResultMeta resultMetadata1)
Parameters:
resultMetadata1 - the resultMetadata to set

resultCode

public WsGetGroupsResult.WsGetGroupsResultCode resultCode()
convert string to result code

Returns:
the result code