edu.internet2.middleware.grouper.ws.coresoap

Class WsStemSaveResults

java.lang.Object

edu.internet2.middleware.grouper.ws.coresoap.WsStemSaveResults

All Implemented Interfaces:

WsResponseBean, ResultMetadataHolder

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

 results for the stems save call.
 
 result code:
 code of the result for this stem overall
 SUCCESS: means everything ok
 STEM_NOT_FOUND: cant find the stem
 STEM_DUPLICATE: found multiple stems
 

Author:

mchyzer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WsStemSaveResults.WsStemSaveResultsCode result code of a request

Constructor Summary

Constructors

Constructor and Description
WsStemSaveResults()

Method Summary

Modifier and Type	Method and Description
void	assignResultCode(WsStemSaveResults.WsStemSaveResultsCode stemSaveResultsCode, GrouperVersion clientVersion) assign the code from the enum
void	assignResultCodeException(WsStemSaveResults.WsStemSaveResultsCode wsStemSaveResultsCodeOverride, java.lang.String theError, java.lang.Exception e, GrouperVersion clientVersion) prcess an exception, log, etc
WsResponseMeta	getResponseMetadata() get the response metadata
WsResultMeta	getResultMetadata() get the result metadata
WsStemSaveResult[]	getResults() results for each deletion sent in
WsStemSaveResults.WsStemSaveResultsCode	retrieveResultCode() convert the result code back to enum
void	setResponseMetadata(WsResponseMeta responseMetadata1)
void	setResultMetadata(WsResultMeta resultMetadata1)
void	setResults(WsStemSaveResult[] results1) results for each deletion sent in
boolean	tallyResults(GrouperTransactionType grouperTransactionType, java.lang.String theSummary, GrouperVersion clientVersion) 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

WsStemSaveResults

public WsStemSaveResults()

Method Detail

assignResultCode

public void assignResultCode(WsStemSaveResults.WsStemSaveResultsCode stemSaveResultsCode,
                             GrouperVersion clientVersion)

assign the code from the enum

Parameters:

stemSaveResultsCode -

clientVersion -

retrieveResultCode

public WsStemSaveResults.WsStemSaveResultsCode retrieveResultCode()

convert the result code back to enum

Returns:

the enum code

getResults

public WsStemSaveResult[] getResults()

results for each deletion sent in

Returns:

the results

setResults

public void setResults(WsStemSaveResult[] results1)

results for each deletion sent in

Parameters:

results1 - the results to set

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

tallyResults

public boolean tallyResults(GrouperTransactionType grouperTransactionType,
                            java.lang.String theSummary,
                            GrouperVersion clientVersion)

make sure if there is an error, to record that as an error

Parameters:

grouperTransactionType - for request

theSummary -

clientVersion -

Returns:

true if success, false if not

assignResultCodeException

public void assignResultCodeException(WsStemSaveResults.WsStemSaveResultsCode wsStemSaveResultsCodeOverride,
                                      java.lang.String theError,
                                      java.lang.Exception e,
                                      GrouperVersion clientVersion)

prcess an exception, log, etc

Parameters:

wsStemSaveResultsCodeOverride -

theError -

e -

clientVersion -

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