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

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.coresoap.WsResultMeta

public class WsResultMeta
extends java.lang.Object

result metadata (if success, result code, etc) for one result (each ws call can have one or many result metadatas)

See Also:
for all implementations of responses

Constructor Summary
WsResultMeta()
           
 
Method Summary
 void appendResultMessage(java.lang.String errorMessage)
          append error message to list of error messages
 void assignHttpStatusCode(int statusCode1)
          status code for http lite / rest .
 void assignResultCode(java.lang.String resultCode1)
           code of the result for this subject SUCCESS: means everything ok SUBJECT_NOT_FOUND: cant find the subject SUBJECT_DUPLICATE: found multiple subjects
 void assignResultCode(WsResultCode wsResultCode1)
          set result code which includes the success and http status code
 void assignResultCode(WsResultCode wsResultCode1, GrouperVersion clientVersion)
          set result code which includes the success and http status code
 void assignSuccess(java.lang.String success1)
          T or F as to whether it was a successful assignment
 void copyFields(WsResultMeta wsResultMeta)
          copy fields from another result meta.
 WsParam[] getParams()
           
 java.lang.String getResultCode()
           code of the result for this subject SUCCESS: means everything ok SUBJECT_NOT_FOUND: cant find the subject SUBJECT_DUPLICATE: found multiple subjects
 java.lang.String getResultCode2()
           reserved for future purpose
 java.lang.String getResultMessage()
          error message if there is an error
 java.lang.String getSuccess()
          T or F as to whether it was a successful assignment
 int retrieveHttpStatusCode()
          status code for http lite / rest .
 void setParams(WsParam[] params1)
           
 void setResultCode(java.lang.String resultCode1)
           
 void setResultCode2(java.lang.String resultCode1)
           
 void setResultMessage(java.lang.String errorMessage)
          error message if there is an error
 void setSuccess(java.lang.String theSuccess)
          T or F as to whether it was a successful assignment
 java.lang.String toString()
          make sure this is an explicit toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsResultMeta

public WsResultMeta()
Method Detail

toString

public java.lang.String toString()
make sure this is an explicit toString

Overrides:
toString in class java.lang.Object

copyFields

public void copyFields(WsResultMeta wsResultMeta)
copy fields from another result meta. will append warnings and errors

Parameters:
wsResultMeta -

appendResultMessage

public void appendResultMessage(java.lang.String errorMessage)
append error message to list of error messages

Parameters:
errorMessage -

getResultCode

public java.lang.String getResultCode()
 code of the result for this subject
 SUCCESS: means everything ok
 SUBJECT_NOT_FOUND: cant find the subject
 SUBJECT_DUPLICATE: found multiple subjects
  
 

Returns:
the resultCode

getResultCode2

public java.lang.String getResultCode2()
 reserved for future purpose
 

Returns:
the resultCode

getResultMessage

public java.lang.String getResultMessage()
error message if there is an error

Returns:
the errorMessage

getSuccess

public java.lang.String getSuccess()
T or F as to whether it was a successful assignment

Returns:
the success

setResultCode

public void setResultCode(java.lang.String resultCode1)
Parameters:
resultCode1 - the resultCode to set

setResultCode2

public void setResultCode2(java.lang.String resultCode1)
Parameters:
resultCode1 - the resultCode2 to set

setSuccess

public void setSuccess(java.lang.String theSuccess)
T or F as to whether it was a successful assignment

Parameters:
theSuccess - T | F

assignResultCode

public void assignResultCode(java.lang.String resultCode1)
 code of the result for this subject
 SUCCESS: means everything ok
 SUBJECT_NOT_FOUND: cant find the subject
 SUBJECT_DUPLICATE: found multiple subjects
  
 

Parameters:
resultCode1 - the resultCode to set

assignResultCode

public void assignResultCode(WsResultCode wsResultCode1)
set result code which includes the success and http status code

Parameters:
wsResultCode1 - bean
grouperWsVersion -

assignResultCode

public void assignResultCode(WsResultCode wsResultCode1,
                             GrouperVersion clientVersion)
set result code which includes the success and http status code

Parameters:
wsResultCode1 - bean
clientVersion -

setResultMessage

public void setResultMessage(java.lang.String errorMessage)
error message if there is an error

Parameters:
errorMessage - the errorMessage to set

assignSuccess

public void assignSuccess(java.lang.String success1)
T or F as to whether it was a successful assignment

Parameters:
success1 - the success to set

retrieveHttpStatusCode

public int retrieveHttpStatusCode()
status code for http lite / rest . not a getter so isnt in soap/lite response

Returns:
the status code e.g. 200, if 500, then not initted

assignHttpStatusCode

public void assignHttpStatusCode(int statusCode1)
status code for http lite / rest . not a setter so isnt in soap/lite response

Parameters:
statusCode1 - the status code e.g. 200, if 500, then not initted

getParams

public WsParam[] getParams()
Returns:
the params

setParams

public void setParams(WsParam[] params1)
Parameters:
params1 - the params to set