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

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

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

returned from the stem find query, if none found, return none

Author:
mchyzer

Nested Class Summary
static class WsFindStemsResults.WsFindStemsResultsCode
          result code of a request
 
Constructor Summary
WsFindStemsResults()
           
 
Method Summary
 void assignResultCode(WsFindStemsResults.WsFindStemsResultsCode wsFindStemsResultsCode)
          assign the code from the enum
 void assignResultCodeException(WsFindStemsResults.WsFindStemsResultsCode wsFindStemsResultsCodeOverride, java.lang.String theError, java.lang.Exception e)
          prcess an exception, log, etc
 void assignStemResult(java.util.Set<Stem> stemSet)
          put a stem in the results
 void assignStemResult(Stem stem)
          put a stem in the results
 WsResponseMeta getResponseMetadata()
          get the response metadata
 WsResultMeta getResultMetadata()
          get the result metadata
 WsStem[] getStemResults()
          has 0 to many stems that match the query by example
 void setResponseMetadata(WsResponseMeta responseMetadata1)
           
 void setResultMetadata(WsResultMeta resultMetadata1)
           
 void setStemResults(WsStem[] stemResults1)
          has 0 to many stems that match the query by example
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsFindStemsResults

public WsFindStemsResults()
Method Detail

assignResultCode

public void assignResultCode(WsFindStemsResults.WsFindStemsResultsCode wsFindStemsResultsCode)
assign the code from the enum

Parameters:
wsFindStemsResultsCode - the code

assignStemResult

public void assignStemResult(Stem stem)
put a stem in the results

Parameters:
stem -

assignStemResult

public void assignStemResult(java.util.Set<Stem> stemSet)
put a stem in the results

Parameters:
stemSet -

getStemResults

public WsStem[] getStemResults()
has 0 to many stems that match the query by example

Returns:
the stemResults

setStemResults

public void setStemResults(WsStem[] stemResults1)
has 0 to many stems that match the query by example

Parameters:
stemResults1 - the stemResults to set

assignResultCodeException

public void assignResultCodeException(WsFindStemsResults.WsFindStemsResultsCode wsFindStemsResultsCodeOverride,
                                      java.lang.String theError,
                                      java.lang.Exception e)
prcess an exception, log, etc

Parameters:
wsFindStemsResultsCodeOverride -
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