org.odpi.openmetadata.accessservices.subjectarea.generated.entities.APIOperation

Class APIOperation

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.generated.entities.APIOperation.APIOperation

All Implemented Interfaces:

Serializable

public class APIOperation
extends Object
implements Serializable

APIOperation entity in the Subject Area OMAS. Description of an API operation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ATTRIBUTE_NAMES_SET
static String[]	ATTRIBUTE_NAMES_SET_VALUES
static Set<String>	ENUM_NAMES_SET
static String[]	ENUM_NAMES_SET_VALUES
static Set<String>	MAP_NAMES_SET
static String[]	MAP_NAMES_SET_VALUES
static Set<String>	PROPERTY_NAMES_SET
static String[]	PROPERTY_NAMES_SET_VALUES

Constructor Summary

Constructors

Constructor and Description
APIOperation()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,String>	getAdditionalProperties() {@literal Additional properties for the element.
List<Classification>	getClassifications() Classifications
Date	getEffectiveFromTime() Return the date/time that this APIOperation should start to be used (null means it can be used from creationTime).
Date	getEffectiveToTime() Return the date/time that this APIOperation should no longer be used.
Map<String,Object>	getExtraAttributes() Get the extra attributes - ones that are in addition to the standard types.
Map<String,Classification>	getExtraClassifications() Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.
String	getQualifiedName() {@literal Unique identifier for the entity.
SystemAttributes	getSystemAttributes() Get the system attributes
int	hashCode()
void	setAdditionalProperties(Map<String,String> additionalProperties)
void	setClassifications(List<Classification> classifications)
void	setEffectiveFromTime(Date effectiveFromTime)
void	setEffectiveToTime(Date effectiveToTime)
void	setExtraAttributes(Map<String,Object> extraAttributes)
void	setExtraClassifications(Map<String,Classification> extraClassifications)
void	setQualifiedName(String qualifiedName)
void	setSystemAttributes(SystemAttributes systemAttributes)
String	toString()
StringBuilder	toString(StringBuilder sb)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAMES_SET_VALUES

public static final String[] PROPERTY_NAMES_SET_VALUES

ATTRIBUTE_NAMES_SET_VALUES

public static final String[] ATTRIBUTE_NAMES_SET_VALUES

ENUM_NAMES_SET_VALUES

public static final String[] ENUM_NAMES_SET_VALUES

MAP_NAMES_SET_VALUES

public static final String[] MAP_NAMES_SET_VALUES

PROPERTY_NAMES_SET

public static final Set<String> PROPERTY_NAMES_SET

ATTRIBUTE_NAMES_SET

public static final Set<String> ATTRIBUTE_NAMES_SET

ENUM_NAMES_SET

public static final Set<String> ENUM_NAMES_SET

MAP_NAMES_SET

public static final Set<String> MAP_NAMES_SET

Constructor Detail

APIOperation

public APIOperation()

Method Detail

getSystemAttributes

public SystemAttributes getSystemAttributes()

Get the system attributes

Returns:

SystemAttributes if populated, null otherwise.

setSystemAttributes

public void setSystemAttributes(SystemAttributes systemAttributes)

getQualifiedName

public String getQualifiedName()

Unique identifier for the entity.

Returns:

String

setQualifiedName

public void setQualifiedName(String qualifiedName)

getAdditionalProperties

public Map<String,String> getAdditionalProperties()

Additional properties for the element.

Returns:

{@code Map<String,String> }

setAdditionalProperties

public void setAdditionalProperties(Map<String,String> additionalProperties)

getEffectiveFromTime

public Date getEffectiveFromTime()

Return the date/time that this APIOperation should start to be used (null means it can be used from creationTime).

Returns:

Date the APIOperation becomes effective.

setEffectiveFromTime

public void setEffectiveFromTime(Date effectiveFromTime)

getEffectiveToTime

public Date getEffectiveToTime()

Return the date/time that this APIOperation should no longer be used.

Returns:

Date the APIOperation stops being effective.

setEffectiveToTime

public void setEffectiveToTime(Date effectiveToTime)

setExtraAttributes

public void setExtraAttributes(Map<String,Object> extraAttributes)

setClassifications

public void setClassifications(List<Classification> classifications)

getExtraAttributes

public Map<String,Object> getExtraAttributes()

Get the extra attributes - ones that are in addition to the standard types.

Returns:

map of attributes, null if there are none

getClassifications

public List<Classification> getClassifications()

Classifications

Returns:

List of Classifications, null if there are none

getExtraClassifications

public Map<String,Classification> getExtraClassifications()

Extra classifications are classifications that are not in the open metadata model - we include the OMRS Classifications.

Returns:

Map of classifications with the classification Name as the map key

setExtraClassifications

public void setExtraClassifications(Map<String,Classification> extraClassifications)

toString

public StringBuilder toString(StringBuilder sb)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object