Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest

Class APIOperationResponse

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.OCFOMASAPIResponse
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.rest.APIOperationResponse
All Implemented Interfaces:
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponse
public class APIOperationResponse extends OCFOMASAPIResponse
CommentResponse is the response structure used on the OMAS REST API calls that returns a Comment object as a response. It returns details of the comment and the count of the replies within it.

  • Constructor Summary

    Constructors
    Constructor
    Description
    APIOperationResponse()
    Default constructor
    APIOperationResponse(APIOperationResponse template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation
    getAPIOperation()
    Return the note log properties.
    int
    getHeaderAttributeCount()
    Return the count of the attributes within the header.
    int
    getRequestAttributeCount()
    Return the count of the attributes within the request.
    int
    getResponseAttributeCount()
    Return the count of the attributes within the response.
    int
    hashCode()
    Return hash code for this object
    void
    setAPIOperation(org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation apiOperation)
    Set up the not log properties.
    void
    setHeaderAttributeCount(int headerAttributeCount)
    Set up the count of attributes within the header.
    void
    setRequestAttributeCount(int requestAttributeCount)
    Set up the count of attributes within the request.
    void
    setResponseAttributeCount(int responseAttributeCount)
    Set up the count of attributes within the response.
    String
    toString()
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

    getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • APIOperationResponse

      public APIOperationResponse()
      Default constructor

    • APIOperationResponse

      public APIOperationResponse(APIOperationResponse template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getAPIOperation

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation getAPIOperation()
      Return the note log properties.
      Returns:
      note log bean

    • setAPIOperation

      public void setAPIOperation(org.odpi.openmetadata.frameworks.connectors.properties.beans.APIOperation apiOperation)
      Set up the not log properties.
      Parameters:
      apiOperation - bean

    • getHeaderAttributeCount

      public int getHeaderAttributeCount()
      Return the count of the attributes within the header.
      Returns:
      int

    • setHeaderAttributeCount

      public void setHeaderAttributeCount(int headerAttributeCount)
      Set up the count of attributes within the header.
      Parameters:
      headerAttributeCount - int

    • getRequestAttributeCount

      public int getRequestAttributeCount()
      Return the count of the attributes within the request.
      Returns:
      int

    • setRequestAttributeCount

      public void setRequestAttributeCount(int requestAttributeCount)
      Set up the count of attributes within the request.
      Parameters:
      requestAttributeCount - int

    • getResponseAttributeCount

      public int getResponseAttributeCount()
      Return the count of the attributes within the response.
      Returns:
      int

    • setResponseAttributeCount

      public void setResponseAttributeCount(int responseAttributeCount)
      Set up the count of attributes within the response.
      Parameters:
      responseAttributeCount - int

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class OCFOMASAPIResponse
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
      Returns:
      int hash code