Package org.odpi.openmetadata.accessservices.datamanager.metadataelements

Class APIParameterListElement

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.metadataelements.APIParameterListElement

All Implemented Interfaces:

Serializable, MetadataElement

public class APIParameterListElement
extends Object
implements MetadataElement, Serializable

APIParameterListElement contains the properties and header for an APIParameterList entity retrieved from the metadata repository.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
APIParameterListElement()	Default constructor
APIParameterListElement(APIParameterListElement template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
ElementHeader	getElementHeader()	Return the element header associated with the properties.
int	getParameterCount()	Return the count of parameters in this parameter list.
APIParameterListType	getParameterListType()	Return the type of parameter list for the API operation.
APIParameterListProperties	getProperties()	Return the properties for the parameter list.
int	hashCode()	Return hash code for this object
void	setElementHeader(ElementHeader elementHeader)	Set up the element header associated with the properties.
void	setParameterCount(int parameterCount)	Set up the count of parameters in this parameter list
void	setParameterListType(APIParameterListType parameterListType)	Set up the type of parameter list for the API Operation.
void	setProperties(APIParameterListProperties properties)	Set up the properties for the parameter list.
String	toString()	JSON-style toString

Methods inherited from class java.lang.Object

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

Constructor Detail

APIParameterListElement

public APIParameterListElement()

Default constructor

APIParameterListElement

public APIParameterListElement(APIParameterListElement template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getElementHeader

public ElementHeader getElementHeader()

Return the element header associated with the properties.

Specified by:

getElementHeader in interface MetadataElement

Returns:

element header object

setElementHeader

public void setElementHeader(ElementHeader elementHeader)

Set up the element header associated with the properties.

Specified by:

setElementHeader in interface MetadataElement

Parameters:

elementHeader - element header object

getProperties

public APIParameterListProperties getProperties()

Return the properties for the parameter list.

Returns:

schema properties (using appropriate subclass)

setProperties

public void setProperties(APIParameterListProperties properties)

Set up the properties for the parameter list.

Parameters:

properties - schema properties

getParameterListType

public APIParameterListType getParameterListType()

Return the type of parameter list for the API operation.

Returns:

enum value

setParameterListType

public void setParameterListType(APIParameterListType parameterListType)

Set up the type of parameter list for the API Operation.

Parameters:

parameterListType - enum value

getParameterCount

public int getParameterCount()

Return the count of parameters in this parameter list.

Returns:

String data type name

setParameterCount

public void setParameterCount(int parameterCount)

Set up the count of parameters in this parameter list

Parameters:

parameterCount - data type name

toString

public String toString()

JSON-style toString

Overrides:

toString in class Object

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class Object

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code