Package org.odpi.openmetadata.frameworks.auditlog

Class AuditLogReportingComponent

java.lang.Object

org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent

All Implemented Interfaces:

Serializable, ComponentDescription

public class AuditLogReportingComponent
extends Object
implements Serializable, ComponentDescription

AuditLogReportingComponent describes the component issuing the audit log record.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuditLogReportingComponent()	Default constructor for Jackson
AuditLogReportingComponent(int componentId, ComponentDevelopmentStatus componentDevelopmentStatus, String componentName, String componentDescription, String componentWikiURL)	Construct the description of the reporting component.
AuditLogReportingComponent(ComponentDescription template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Validate that an object is equal depending on their stored values.
ComponentDevelopmentStatus	getComponentDevelopmentStatus()	Return the development status of the component.
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()	Return the URL link to the wiki page that describes this component.
int	hashCode()	Return a hash code based on the values of this object.
void	setComponentDescription(String componentDescription)	Set up the short description of the component.
void	setComponentDevelopmentStatus(ComponentDevelopmentStatus componentDevelopmentStatus)	Set up the development status of the component.
void	setComponentId(int componentId)	Set up the numerical code for this component.
void	setComponentName(String componentName)	Set up the name of the component.
void	setComponentWikiURL(String componentWikiURL)	Set up the URL link to the wiki page that describes this component.
String	toString()	Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditLogReportingComponent

public AuditLogReportingComponent()

Default constructor for Jackson

AuditLogReportingComponent

public AuditLogReportingComponent(ComponentDescription template)

Copy/clone constructor

Parameters:

template - object to copy

AuditLogReportingComponent

public AuditLogReportingComponent(int componentId,
                                  ComponentDevelopmentStatus componentDevelopmentStatus,
                                  String componentName,
                                  String componentDescription,
                                  String componentWikiURL)

Construct the description of the reporting component.

Parameters:

componentId - numerical identifier for the component

componentDevelopmentStatus - development status

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 component.

Specified by:

getComponentId in interface ComponentDescription

Returns:

int componentId

setComponentId

public void setComponentId(int componentId)

Set up the numerical code for this component.

Parameters:

componentId - int componentId

getComponentDevelopmentStatus

public ComponentDevelopmentStatus getComponentDevelopmentStatus()

Return the development status of the component.

Specified by:

getComponentDevelopmentStatus in interface ComponentDescription

Returns:

enum describing the status

setComponentDevelopmentStatus

public void setComponentDevelopmentStatus(ComponentDevelopmentStatus componentDevelopmentStatus)

Set up the development status of the component.

Parameters:

componentDevelopmentStatus - enum describing the status

getComponentName

public String getComponentName()

Return the name of the component.

Specified by:

getComponentName in interface ComponentDescription

Returns:

String component name

setComponentName

public void setComponentName(String componentName)

Set up the name of the component.

Parameters:

componentName - String component name

getComponentType

public 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.

Specified by:

getComponentType in interface ComponentDescription

Returns:

String description

setComponentDescription

public void setComponentDescription(String componentDescription)

Set up 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.

Parameters:

componentDescription - String description

getComponentWikiURL

public String getComponentWikiURL()

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

Specified by:

getComponentWikiURL in interface ComponentDescription

Returns:

String URL

setComponentWikiURL

public void setComponentWikiURL(String componentWikiURL)

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

Parameters:

componentWikiURL - 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