org.odpi.openmetadata.frameworks.auditlog

Interface ComponentDescription

All Known Implementing Classes:

AuditLogReportingComponent

public interface ComponentDescription

ComponentDescription is an interface implemented by a enum that describes the components using the audit log

Method Summary

Modifier and Type	Method and Description
int	getComponentId() Return the numerical code for this component.
String	getComponentName() Return the name of the component.
String	getComponentType() Return the short description of the component.
String	getComponentWikiURL() URL link to the wiki page that describes this component.

Method Detail

getComponentId

int getComponentId()

Return the numerical code for this component.

Returns:

int componentId

getComponentName

String getComponentName()

Return the name of the component. This is the name used in the audit log records.

Returns:

String component name

getComponentType

String getComponentType()

Return the short description of the component. This is an English description. Natural language support for these values can be added to UIs using a resource bundle indexed with the component Id. This value is provided as a default if the resource bundle is not available.

Returns:

String description

getComponentWikiURL

String getComponentWikiURL()

URL link to the wiki page that describes this component. This provides more information to the log reader on the operation of the component.

Returns:

String URL