Package org.odpi.openmetadata.adminservices.configuration.properties

Class ViewServiceConfig

    • Constructor Detail

      • ViewServiceConfig

        public ViewServiceConfig()
        Default constructor for use with Jackson libraries

      • ViewServiceConfig

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

      • ViewServiceConfig

        public ViewServiceConfig​(ViewServiceRegistration viewRegistration)
        Set up the default values for a view service using a view service description.
        Parameters:
        viewRegistration - fixed properties about the view service

    • Method Detail

      • getViewServiceId

        public int getViewServiceId()
        Return the code number (ordinal) for this view service.
        Returns:
        int ordinal

      • setViewServiceId

        public void setViewServiceId​(int viewId)
        Set up the code number (ordinal) for this view service.
        Parameters:
        viewId - int ordinal

      • getViewServiceAdminClass

        public String getViewServiceAdminClass()
        Return the Java class name of the admin-services interface for this view service.
        Returns:
        String class name implementing the ViewServiceAdmin interface.

      • setViewServiceAdminClass

        public void setViewServiceAdminClass​(String viewServiceAdminClass)
        Set up the Java class name of the admin services interface for this view service.
        Parameters:
        viewServiceAdminClass - String class name implementing the ViewServiceAdmin interface.

      • getViewServiceFullName

        public String getViewServiceFullName()
        Return the full name of the view service.
        Returns:
        String name

      • setViewServiceFullName

        public void setViewServiceFullName​(String viewServiceFullName)
        Set up the full name of the view service.
        Parameters:
        viewServiceFullName - String name

      • getViewServiceName

        public String getViewServiceName()
        Return the name of the view service.
        Returns:
        String name

      • setViewServiceName

        public void setViewServiceName​(String viewServiceName)
        Set up the name of the view service.
        Parameters:
        viewServiceName - String 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 viewServiceURLMarker

      • setViewServiceURLMarker

        public void setViewServiceURLMarker​(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 short description of the view service. The default value is in English but this can be changed.
        Returns:
        String viewServiceDescription

      • setViewServiceDescription

        public void setViewServiceDescription​(String viewServiceDescription)
        Set up the short description of the view service.
        Parameters:
        viewServiceDescription - String description

      • getViewServiceWiki

        public String getViewServiceWiki()
        Return the wiki page link for the view service.
        Returns:
        viewServiceWiki String url

      • setViewServiceWiki

        public void setViewServiceWiki​(String viewServiceWiki)
        Set up the wiki page link for the view service.
        Parameters:
        viewServiceWiki - String url

      • getViewServiceOperationalStatus

        public ServiceOperationalStatus getViewServiceOperationalStatus()
        Return the status of this view service.
        Returns:
        viewServiceOperationalStatus enum

      • setViewServiceOperationalStatus

        public void setViewServiceOperationalStatus​(ServiceOperationalStatus viewServiceOperationalStatus)
        Set up the status of the view service.
        Parameters:
        viewServiceOperationalStatus - ViewServiceOperationalStatus enum

      • getViewServiceOptions

        public Map<String,​Object> getViewServiceOptions()
        Return the options for this view service. These are properties that are specific to the view service.
        Returns:
        Map from String to String

      • setViewServiceOptions

        public void setViewServiceOptions​(Map<String,​Object> viewServiceOptions)
        Set up the options for this view service. These are properties that are specific to the view service.
        Parameters:
        viewServiceOptions - Map from String to String

      • equals

        public boolean equals​(Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class OMAGServerClientConfig
        Parameters:
        objectToCompare - object
        Returns:
        boolean result

      • hashCode

        public int hashCode()
        Return a hash code based on the values of this object.
        Overrides:
        hashCode in class OMAGServerClientConfig
        Returns:
        in hash code