Package edu.internet2.middleware.grouper.ws.coresoap

Class WsResultMeta

java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsResultMeta
public class WsResultMeta extends Object
result metadata (if success, result code, etc) for one result (each ws call can have one or many result metadatas)
See Also:

  • Constructor Details

    • WsResultMeta

      public WsResultMeta()

  • Method Details

    • toString

      public String toString()
      make sure this is an explicit toString
      Overrides:
      toString in class Object

    • copyFields

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

    • appendResultMessageError

      public void appendResultMessageError(Throwable t)
      append result stack if configured to send stack to client. or just send exception message if configured. or nothing
      Parameters:
      error -

    • appendResultMessageError

      public void appendResultMessageError(String error)
      append result message error if configured to send errors to client
      Parameters:
      error -

    • appendResultMessage

      public void appendResultMessage(String errorMessage)
      append error message to list of error messages
      Parameters:
      errorMessage -

    • getResultCode

      public 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 String getResultCode2()
       reserved for future purpose
      Returns:
      the resultCode

    • getResultMessage

      public String getResultMessage()
      error message if there is an error
      Returns:
      the errorMessage

    • getSuccess

      public String getSuccess()
      T or F as to whether it was a successful assignment
      Returns:
      the success

    • setResultCode

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

    • setResultCode2

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

    • setSuccess

      public void setSuccess(String theSuccess)
      T or F as to whether it was a successful assignment
      Parameters:
      theSuccess - T | F

    • assignResultCode

      public void assignResultCode(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(String errorMessage)
      error message if there is an error
      Parameters:
      errorMessage - the errorMessage to set

    • assignSuccess

      public void assignSuccess(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