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

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

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

 results for the external subjects delete call.
 
 result code:
 code of the result for this externalSubject overall
 SUCCESS: means everything ok
 EXTERNAL_SUBJECT_NOT_FOUND: cant find the externalSubject
 EXTERNAL_SUBJECT_DUPLICATE: found multiple externalSubjects
 

Author:
mchyzer

Nested Class Summary
static class WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode
          result code of a request
 
Constructor Summary
WsExternalSubjectDeleteResults()
           
 
Method Summary
 void assignResultCode(WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode externalSubjectsDeleteResultsCode)
          assign the code from the enum
 void assignResultCodeException(WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode wsExternalSubjectDeleteResultsCodeOverride, 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
 WsExternalSubjectDeleteResult[] getResults()
          results for each deletion sent in
 WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode retrieveResultCode()
          convert the result code back to enum
 void setResponseMetadata(WsResponseMeta responseMetadata1)
           
 void setResultMetadata(WsResultMeta resultMetadata1)
           
 void setResults(WsExternalSubjectDeleteResult[] results1)
          results for each deletion sent in
 boolean tallyResults(GrouperTransactionType grouperTransactionType, 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

WsExternalSubjectDeleteResults

public WsExternalSubjectDeleteResults()
Method Detail

assignResultCode

public void assignResultCode(WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode externalSubjectsDeleteResultsCode)
assign the code from the enum

Parameters:
externalSubjectsDeleteResultsCode - should not be null

retrieveResultCode

public WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode retrieveResultCode()
convert the result code back to enum

Returns:
the enum code

getResults

public WsExternalSubjectDeleteResult[] getResults()
results for each deletion sent in

Returns:
the results

setResults

public void setResults(WsExternalSubjectDeleteResult[] results1)
results for each deletion sent in

Parameters:
results1 - the results to set

assignResultCodeException

public void assignResultCodeException(WsExternalSubjectDeleteResults.WsExternalSubjectDeleteResultsCode wsExternalSubjectDeleteResultsCodeOverride,
                                      java.lang.String theError,
                                      java.lang.Exception e)
prcess an exception, log, etc

Parameters:
wsExternalSubjectDeleteResultsCodeOverride -
theError -
e -

tallyResults

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

Parameters:
grouperTransactionType - for request
theSummary - of entire request
Returns:
true if not need to rollback, and false if so

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