Package org.odpi.openmetadata.commonservices.ffdc.rest

Class RegisteredOMAGService

java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService
public class RegisteredOMAGService extends Object
RegisteredOMAGServicesResponse provides an object for returning information about a service that is registered with an OMAG Server Platform.

  • Field Details

    • partnerServiceName

      public String partnerServiceName

    • partnerServerType

      public String partnerServerType

  • Constructor Details

    • RegisteredOMAGService

      public RegisteredOMAGService()
      Default constructor

    • RegisteredOMAGService

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

  • Method Details

    • getServiceId

      public int getServiceId()
      Return the component identifier used by the service
      Returns:
      int

    • setServiceId

      public void setServiceId(int serviceId)
      Set up the component identifier used by the service.
      Parameters:
      serviceId - int

    • getServiceName

      public String getServiceName()
      Return the default name for this service.
      Returns:
      String default name

    • setServiceName

      public void setServiceName(String serviceName)
      Set up the default name for this service.
      Parameters:
      serviceName - name

    • getServiceDevelopmentStatus

      public ComponentDevelopmentStatus getServiceDevelopmentStatus()
      Return the development status of the service.
      Returns:
      development status enum

    • setServiceDevelopmentStatus

      public void setServiceDevelopmentStatus(ComponentDevelopmentStatus serviceDevelopmentStatus)
      Set up the development status of the service.
      Parameters:
      serviceDevelopmentStatus - development status

    • getServiceURLMarker

      public String getServiceURLMarker()
      Return the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.
      Returns:
      url fragment

    • setServiceURLMarker

      public void setServiceURLMarker(String serviceURLMarker)
      Set up the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.
      Parameters:
      serviceURLMarker - url fragment

    • getServiceDescription

      public String getServiceDescription()
      Return the default description for this service.
      Returns:
      String default description

    • setServiceDescription

      public void setServiceDescription(String serviceDescription)
      Set up the default description for this service.
      Parameters:
      serviceDescription - text

    • getServiceWiki

      public String getServiceWiki()
      Return the URL for the wiki page describing this service.
      Returns:
      String URL name for the wiki page

    • setServiceWiki

      public void setServiceWiki(String serviceWiki)
      Set up the URL for the wiki page describing this service.
      Parameters:
      serviceWiki - URL

    • getServerType

      public String getServerType()
      Return the type of the service that this service sits in.
      Returns:
      name of the type of server

    • setServerType

      public void setServerType(String serverType)
      Set up the name of the server that this service sits in.
      Parameters:
      serverType - name of the type of server

    • getPartnerServiceName

      public String getPartnerServiceName()
      Return the service in a remote server that this service depends on.
      Returns:
      name of the service

    • setPartnerServiceName

      public void setPartnerServiceName(String partnerServiceName)
      Set up the service in a remote server that this service depends on.
      Parameters:
      partnerServiceName - name of the service

    • getPartnerServerType

      public String getPartnerServerType()
      Return the type of the server that the partner service resides on.
      Returns:
      name of the type of server

    • setPartnerServerType

      public void setPartnerServerType(String partnerServerType)
      Set up the type of the server that the partner service resides on.
      Parameters:
      partnerServerType - name of the type of server

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      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 Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code