org.odpi.openmetadata.adminservices.configuration.registration

Class ViewServiceRegistration

java.lang.Object

org.odpi.openmetadata.adminservices.configuration.registration.ViewServiceRegistration

All Implemented Interfaces:

Serializable

public class ViewServiceRegistration
extends Object
implements Serializable

ViewServiceRegistration is used by an view service to register its admin services interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ViewServiceRegistration() Default constructor
ViewServiceRegistration(int viewServiceCode, String viewServiceName, String viewServiceFullName, String viewServiceURLMarker, String viewServiceDescription, String viewServiceWiki, ServiceOperationalStatus viewServiceOperationalStatus, String viewServiceAdminClassName) Complete Constructor
ViewServiceRegistration(ViewServiceDescription viewServiceDescription, ServiceOperationalStatus viewServiceOperationalStatus, String viewServiceAdminClassName) Enum Constructor

Method Summary

Modifier and Type	Method and Description
String	getViewServiceAdminClassName() Return the class name of the admin class that should be called during initialization and termination.
int	getViewServiceCode() Return the code for this view service
String	getViewServiceDescription() Return the default description for the type for this view service.
String	getViewServiceFullName() Return the full name for this view service.
String	getViewServiceName() Return the default name for this view service.
ServiceOperationalStatus	getViewServiceOperationalStatus() Return the initial operational status for this view service.
String	getViewServiceURLMarker() Return the string that appears in the REST API URL that identifies the owning service.
String	getViewServiceWiki() Return the URL for the wiki page describing this view service.
void	setServiceURLMarker(String viewServiceURLMarker) Set up the string that appears in the REST API URL that identifies the owning service.
void	setViewServiceAdminClassName(String viewServiceAdminClassName) Set up the class name of the admin class that should be called during initialization and termination.
void	setViewServiceCode(int viewServiceCode) Set up the code for this view service
void	setViewServiceDescription(String viewServiceDescription) Set up the default description for the type for this view service.
void	setViewServiceFullName(String viewServiceFullName) Set up the full name for this view service.
void	setViewServiceName(String viewServiceName) Set up the default name for this view service.
void	setViewServiceOperationalStatus(ServiceOperationalStatus viewServiceOperationalStatus) Set up the initial operational status for this view service.
void	setViewServiceWiki(String viewServiceWiki) Set up the URL for the wiki page describing this view service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewServiceRegistration

public ViewServiceRegistration(int viewServiceCode,
                               String viewServiceName,
                               String viewServiceFullName,
                               String viewServiceURLMarker,
                               String viewServiceDescription,
                               String viewServiceWiki,
                               ServiceOperationalStatus viewServiceOperationalStatus,
                               String viewServiceAdminClassName)

Complete Constructor

Parameters:

viewServiceCode - ordinal for this view service

viewServiceName - symbolic 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

viewServiceOperationalStatus - default initial operational status for the view service

viewServiceAdminClassName - name of ViewServiceAdmin implementation class for the view service

ViewServiceRegistration

public ViewServiceRegistration(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

ViewServiceRegistration

public ViewServiceRegistration()

Default constructor

Method Detail

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

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

getViewServiceOperationalStatus

public ServiceOperationalStatus getViewServiceOperationalStatus()

Return the initial operational status for this view service.

Returns:

ViewServiceOperationalStatus enum

setViewServiceOperationalStatus

public void setViewServiceOperationalStatus(ServiceOperationalStatus viewServiceOperationalStatus)

Set up the initial operational status for this view service.

Parameters:

viewServiceOperationalStatus - ViewServiceOperationalStatus 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