Package org.odpi.openmetadata.adminservices.configuration.registration

Class ViewServiceRegistrationEntry

java.lang.Object
org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceRegistrationEntry
All Implemented Interfaces:
Serializable
public class ViewServiceRegistrationEntry extends Object implements Serializable
ViewServiceRegistrationEntry is used by a view service to register its admin services interface.
See Also:

  • Constructor Details

    • ViewServiceRegistrationEntry

      public ViewServiceRegistrationEntry(int viewServiceCode, ComponentDevelopmentStatus viewServiceDevelopmentStatus, String viewServiceName, String viewServiceFullName, String viewServiceURLMarker, String viewServiceDescription, String viewServiceWiki, String viewServicePartnerService, ServiceOperationalStatus viewServiceOperationalStatus, String viewServiceAdminClassName)
      Complete Constructor
      Parameters:
      viewServiceCode - ordinal for this view service
      viewServiceDevelopmentStatus - development status
      viewServiceName - symbolic name for this view service
      viewServiceFullName - full name for this view service
      viewServiceURLMarker - name of the part of the URL that is the name of the view service
      viewServiceDescription - short description for this view service
      viewServiceWiki - wiki page for the view service for this view service
      viewServicePartnerService - service that is called
      viewServiceOperationalStatus - default initial operational status for the view service
      viewServiceAdminClassName - name of ViewServiceAdmin implementation class for the view service

    • ViewServiceRegistrationEntry

      public ViewServiceRegistrationEntry(ViewServiceDescription viewServiceDescription, ServiceOperationalStatus viewServiceOperationalStatus, String viewServiceAdminClassName)
      Enum Constructor
      Parameters:
      viewServiceDescription - enum for this view service
      viewServiceOperationalStatus - default initial operational status for the view service
      viewServiceAdminClassName - name of ViewServiceAdmin implementation class for the view service

    • ViewServiceRegistrationEntry

      public ViewServiceRegistrationEntry()
      Default constructor

  • Method Details

    • getViewServiceCode

      public int getViewServiceCode()
      Return the code for this view service
      Returns:
      int type code

    • setViewServiceCode

      public void setViewServiceCode(int viewServiceCode)
      Set up the code for this view service
      Parameters:
      viewServiceCode - int type code

    • getViewServiceDevelopmentStatus

      public ComponentDevelopmentStatus getViewServiceDevelopmentStatus()
      Return the development status of the component.
      Returns:
      enum describing the status

    • setViewServiceDevelopmentStatus

      public void setViewServiceDevelopmentStatus(ComponentDevelopmentStatus viewServiceDevelopmentStatus)
      Set up the development status of the component.
      Parameters:
      viewServiceDevelopmentStatus - enum describing the status

    • getViewServiceName

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

    • setViewServiceName

      public void setViewServiceName(String viewServiceName)
      Set up the default name for this view service.
      Parameters:
      viewServiceName - String default name

    • getViewServiceFullName

      public String getViewServiceFullName()
      Return the full name for this view service.
      Returns:
      String default name

    • setViewServiceFullName

      public void setViewServiceFullName(String viewServiceFullName)
      Set up the full name for this view service.
      Parameters:
      viewServiceFullName - String default name

    • getViewServiceURLMarker

      public String getViewServiceURLMarker()
      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:
      String default name

    • setServiceURLMarker

      public void setServiceURLMarker(String viewServiceURLMarker)
      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:
      viewServiceURLMarker - url fragment

    • getViewServiceDescription

      public String getViewServiceDescription()
      Return the default description for the type for this view service.
      Returns:
      String default description

    • setViewServiceDescription

      public void setViewServiceDescription(String viewServiceDescription)
      Set up the default description for the type for this view service.
      Parameters:
      viewServiceDescription - String default description

    • getViewServiceWiki

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

    • setViewServiceWiki

      public void setViewServiceWiki(String viewServiceWiki)
      Set up the URL for the wiki page describing this view service.
      Parameters:
      viewServiceWiki - String URL name for the wiki page

    • getViewServicePartnerService

      public String getViewServicePartnerService()
      Return the full name of the service (typically Open Metadata Access Service (OMAS)) that this view service is partnered with.
      Returns:
      Full name of OMAS

    • setViewServicePartnerService

      public void setViewServicePartnerService(String viewServicePartnerService)
      Set up the full name of the service (typically Open Metadata Access Service (OMAS)) that this view service is partnered with.
      Parameters:
      viewServicePartnerService - Full name of OMAS

    • getViewServiceOperationalStatus

      public ServiceOperationalStatus getViewServiceOperationalStatus()
      Return the initial operational status for this view service.
      Returns:
      ServiceOperationalStatus enum

    • setViewServiceOperationalStatus

      public void setViewServiceOperationalStatus(ServiceOperationalStatus viewServiceOperationalStatus)
      Set up the initial operational status for this view service.
      Parameters:
      viewServiceOperationalStatus - ServiceOperationalStatus enum

    • getViewServiceAdminClassName

      public String getViewServiceAdminClassName()
      Return the class name of the admin class that should be called during initialization and termination.
      Returns:
      class name

    • setViewServiceAdminClassName

      public void setViewServiceAdminClassName(String viewServiceAdminClassName)
      Set up the class name of the admin class that should be called during initialization and termination.
      Parameters:
      viewServiceAdminClassName - class name