Package org.odpi.openmetadata.repositoryservices.rest.properties

Class SubtypeLimitedFindRequest

java.lang.Object
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.TypeLimitedFindRequest
org.odpi.openmetadata.repositoryservices.rest.properties.SubtypeLimitedFindRequest
All Implemented Interfaces:
RequestIdService
Direct Known Subclasses:
InstanceFindRequest
public class SubtypeLimitedFindRequest extends TypeLimitedFindRequest
SubtypeLimitedFindRequest extends the type limited find request to allow the caller to request that only a restricted list of subtypes of the overall type are included in the results.

  • Constructor Details

    • SubtypeLimitedFindRequest

      public SubtypeLimitedFindRequest()
      Default constructor

    • SubtypeLimitedFindRequest

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

  • Method Details

    • getSubtypeGUIDs

      public List<String> getSubtypeGUIDs()
      Return the subtype guids to limit the results of the find request.
      Returns:
      List<String> guids

    • setSubtypeGUIDs

      public void setSubtypeGUIDs(List<String> subtypeGUIDs)
      Set up the subtype guids to limit the results of the find request.
      Parameters:
      subtypeGUIDs - List<String> guids

    • getExcludeSubtypeGUIDs

      public List<String> getExcludeSubtypeGUIDs()
      Return the subtypes to exclude from the results. This is the counterpart of subtypeGUIDs, which names the only subtypes to include, and the two are mutually exclusive.
      The exclusion list is carried in a field of its own rather than by qualifying subtypeGUIDs with a flag, because these request bodies ignore properties they do not recognise. A server that predates this field ignores it and applies no subtype filter at all, which the caller can correct for itself. Had the exclusion been expressed as a flag beside subtypeGUIDs, that same server would have ignored the flag and read the list as the subtypes to include - returning precisely the set that was meant to be excluded, which no caller could detect or correct.
      Returns:
      list of guids

    • setExcludeSubtypeGUIDs

      public void setExcludeSubtypeGUIDs(List<String> excludeSubtypeGUIDs)
      Set up the subtypes to exclude from the results.
      Parameters:
      excludeSubtypeGUIDs - list of guids

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class TypeLimitedFindRequest
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class TypeLimitedFindRequest
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class TypeLimitedFindRequest
      Returns:
      int hash code