org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore

Class OMRSAuditLogReportingComponent

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore.OMRSAuditLogReportingComponent

public class OMRSAuditLogReportingComponent
extends Object

OMRSAuditLogReportingComponent describes the component issuing the audit log record.

Constructor Summary

Constructors

Constructor and Description
OMRSAuditLogReportingComponent(int componentId, String componentName, String componentDescription, String componentWikiURL) Construct the description of the reporting component.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Validate that an object is equal depending on their stored values.
String	getComponentDescription() Return the short description of the component.
int	getComponentId() Return the numerical code for this enum.
String	getComponentName() Return the name of the component.
String	getComponentWikiURL() URL link to the wiki page that describes this component.
int	hashCode() Return a hash code based on the values of this object.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OMRSAuditLogReportingComponent

public OMRSAuditLogReportingComponent(int componentId,
                                      String componentName,
                                      String componentDescription,
                                      String componentWikiURL)

Construct the description of the reporting component.

Parameters:

componentId - numerical identifier for the component.

componentName - display name for the component.

componentDescription - description of the component.

componentWikiURL - link to more information.

Method Detail

getComponentId

public int getComponentId()

Return the numerical code for this enum.

Returns:

int componentId

getComponentName

public String getComponentName()

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

Returns:

String component name

getComponentDescription

public String getComponentDescription()

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

public 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

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Validate that an object is equal depending on their stored values.

Overrides:

equals in class Object

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 Object

Returns:

in hash code