Package org.odpi.openmetadata.conformance.beans

Class OpenMetadataConformanceProfileSummary

java.lang.Object

org.odpi.openmetadata.conformance.beans.OpenMetadataConformanceProfileSummary

All Implemented Interfaces:

Serializable

public class OpenMetadataConformanceProfileSummary
extends Object
implements Serializable

OpenMetadataConformanceProfileSummary provides a summary of the assessment of a technology's conformance to an open metadata conformance profile.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OpenMetadataConformanceProfileSummary()	Default constructor used in JSON exchange
OpenMetadataConformanceProfileSummary(Integer id, String name, String description, String documentationURL, OpenMetadataConformanceProfilePriority profilePriority)	Standard constructor used during test run.
OpenMetadataConformanceProfileSummary(OpenMetadataConformanceProfileSummary template)	Copy/clone constructor used in JSON exchange

Method Summary

Modifier and Type	Method	Description
OpenMetadataConformanceStatus	getConformanceStatus()	Return the conformance status of the technology under test (TUT).
String	getDescription()	Return the short description of the profile.
String	getDocumentationURL()	Return the URL link to the profile.
Integer	getId()	Return the identifier of the profile.
String	getName()	Return the display name of the profile.
OpenMetadataConformanceProfilePriority	getProfilePriority()	Return the priority of the profile.
List<OpenMetadataConformanceRequirementSummary>	getRequirementSummary()	Return detailed results, requirement by requirement.
void	setConformanceStatus(OpenMetadataConformanceStatus conformanceStatus)	Set up the conformance status of the technology under test (TUT).
void	setDescription(String description)	Set up the short description of the profile.
void	setDocumentationURL(String documentationURL)	Set up the URL link to the profile.
void	setId(Integer id)	Set up the identifier of the profile.
void	setName(String name)	Set up the display name of the profile.
void	setProfilePriority(OpenMetadataConformanceProfilePriority profilePriority)	Set up the priority of the profile.
void	setRequirementSummary(List<OpenMetadataConformanceRequirementSummary> requirementSummary)	Set up detailed results, requirement by requirement.
String	toString()	toString() JSON-style

Methods inherited from class java.lang.Object

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

Constructor Details

OpenMetadataConformanceProfileSummary

public OpenMetadataConformanceProfileSummary()

Default constructor used in JSON exchange

OpenMetadataConformanceProfileSummary

public OpenMetadataConformanceProfileSummary(Integer id,
 String name,
 String description,
 String documentationURL,
 OpenMetadataConformanceProfilePriority profilePriority)

Standard constructor used during test run.

Parameters:

id - unique identifier use in indexing the results

name - name of the profile

description - description of the profile

documentationURL - URL to the documentation of the profile

profilePriority - mandatory or optional

OpenMetadataConformanceProfileSummary

public OpenMetadataConformanceProfileSummary(OpenMetadataConformanceProfileSummary template)

Copy/clone constructor used in JSON exchange

Parameters:

template - object to copy

Method Details

getId

public Integer getId()

Return the identifier of the profile.

Returns:

integer used to index the profile

setId

public void setId(Integer id)

Set up the identifier of the profile.

Parameters:

id - integer used to index the profile

getName

public String getName()

Return the display name of the profile.

Returns:

string name

setName

public void setName(String name)

Set up the display name of the profile.

Parameters:

name - string name

getDescription

public String getDescription()

Return the short description of the profile.

Returns:

string description

setDescription

public void setDescription(String description)

Set up the short description of the profile.

Parameters:

description - string description

getDocumentationURL

public String getDocumentationURL()

Return the URL link to the profile.

Returns:

url

setDocumentationURL

public void setDocumentationURL(String documentationURL)

Set up the URL link to the profile.

Parameters:

documentationURL - url

getConformanceStatus

public OpenMetadataConformanceStatus getConformanceStatus()

Return the conformance status of the technology under test (TUT).

Returns:

status enum

setConformanceStatus

public void setConformanceStatus(OpenMetadataConformanceStatus conformanceStatus)

Set up the conformance status of the technology under test (TUT).

Parameters:

conformanceStatus - status enum

getProfilePriority

public OpenMetadataConformanceProfilePriority getProfilePriority()

Return the priority of the profile.

Returns:

priority enum

setProfilePriority

public void setProfilePriority(OpenMetadataConformanceProfilePriority profilePriority)

Set up the priority of the profile.

Parameters:

profilePriority - priority enum

getRequirementSummary

public List<OpenMetadataConformanceRequirementSummary> getRequirementSummary()

Return detailed results, requirement by requirement.

Returns:

list of requirement results (summary)

setRequirementSummary

public void setRequirementSummary(List<OpenMetadataConformanceRequirementSummary> requirementSummary)

Set up detailed results, requirement by requirement.

Parameters:

requirementSummary - list of requirement results (summary)

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Object

Returns:

string description