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

Class PagedResponse

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.PagedResponse
All Implemented Interfaces:
Serializable, org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponse
Direct Known Subclasses:
APIOperationsResponse, AssetsResponse, CommentsResponse, ConnectionsResponse, ExternalIdentifiersResponse, ExternalReferencesResponse, InformalTagsResponse, LicensesResponse, LikesResponse, LocationsResponse, MeaningsResponse, MoreInformationResponse, NoteLogsResponse, NotesResponse, RatingsResponse, ReferenceablesResponse, RelatedAssetsResponse, RelatedMediaReferencesResponse, SchemaAttributesResponse, SchemaTypeResponse, TagsResponse, ValidValuesResponse
public class PagedResponse extends OCFOMASAPIResponse
PagedResponse is used for responses that can contain paged responses
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PagedResponse()
    Default constructor
    PagedResponse(PagedResponse 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.
    int
    getStartingFromElement()
    Return the starting element number from the server side list that this response contains.
    int
    hashCode()
    Return hash code for this object
    void
    setStartingFromElement(int startingFromElement)
    Set up the starting element number from the server side list that this response contains.
    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

    • PagedResponse

      public PagedResponse()
      Default constructor

    • PagedResponse

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

  • Method Details

    • getStartingFromElement

      public int getStartingFromElement()
      Return the starting element number from the server side list that this response contains.
      Returns:
      int

    • setStartingFromElement

      public void setStartingFromElement(int startingFromElement)
      Set up the starting element number from the server side list that this response contains.
      Parameters:
      startingFromElement - 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