org.odpi.openmetadata.accessservices.governanceengine.rest

Class NewMetadataElementRequestBody

java.lang.Object

org.odpi.openmetadata.accessservices.governanceengine.rest.NewMetadataElementRequestBody

All Implemented Interfaces:

Serializable

public class NewMetadataElementRequestBody
extends Object
implements Serializable

NewMetadataElementRequestBody provides a structure for passing the properties for a new metadata element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NewMetadataElementRequestBody() Default constructor
NewMetadataElementRequestBody(NewMetadataElementRequestBody template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Equals method that returns true if containing properties are the same.
Date	getEffectiveFrom() Return the date/time that this new element becomes effective in the governance program (null means immediately).
Date	getEffectiveTo() Return the date/time when the new element is no longer effective in the governance program (null means until deleted).
ElementStatus	getInitialStatus() Return the initial status of the metadata element (typically ACTIVE).
ElementProperties	getProperties() Return the properties for the new metadata element.
String	getTemplateGUID() Returns the unique identifier of the element to use as a template (optional).
String	getTypeName() Return the open metadata type name for the new metadata element.
int	hashCode() Return hash code for this object
void	setEffectiveFrom(Date effectiveFrom) Set up the date/time that this new element becomes effective in the governance program (null means immediately).
void	setEffectiveTo(Date effectiveTo) Set up the date/time when the new element is no longer effective in the governance program (null means until deleted).
void	setInitialStatus(ElementStatus initialStatus) Set up the initial status of the metadata element (typically ACTIVE).
void	setProperties(ElementProperties properties) Set up the properties for the new metadata element.
void	setTemplateGUID(String templateGUID) Set up the unique identifier of the element to use as a template (optional).
void	setTypeName(String typeName) Set up the open metadata type name for the new metadata element.
String	toString() JSON-style toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewMetadataElementRequestBody

public NewMetadataElementRequestBody()

Default constructor

NewMetadataElementRequestBody

public NewMetadataElementRequestBody(NewMetadataElementRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getTypeName

public String getTypeName()

Return the open metadata type name for the new metadata element.

Returns:

string name

setTypeName

public void setTypeName(String typeName)

Set up the open metadata type name for the new metadata element.

Parameters:

typeName - string name

getInitialStatus

public ElementStatus getInitialStatus()

Return the initial status of the metadata element (typically ACTIVE).

Returns:

element status enum value

setInitialStatus

public void setInitialStatus(ElementStatus initialStatus)

Set up the initial status of the metadata element (typically ACTIVE).

Parameters:

initialStatus - element status enum value

getEffectiveFrom

public Date getEffectiveFrom()

Return the date/time that this new element becomes effective in the governance program (null means immediately).

Returns:

date object

setEffectiveFrom

public void setEffectiveFrom(Date effectiveFrom)

Set up the date/time that this new element becomes effective in the governance program (null means immediately).

Parameters:

effectiveFrom - date object

getEffectiveTo

public Date getEffectiveTo()

Return the date/time when the new element is no longer effective in the governance program (null means until deleted).

Returns:

date object

setEffectiveTo

public void setEffectiveTo(Date effectiveTo)

Set up the date/time when the new element is no longer effective in the governance program (null means until deleted).

Parameters:

effectiveTo - date object

getProperties

public ElementProperties getProperties()

Return the properties for the new metadata element.

Returns:

list of properties

setProperties

public void setProperties(ElementProperties properties)

Set up the properties for the new metadata element.

Parameters:

properties - list of properties

setTemplateGUID

public void setTemplateGUID(String templateGUID)

Set up the unique identifier of the element to use as a template (optional).

Parameters:

templateGUID - String guid

getTemplateGUID

public String getTemplateGUID()

Returns the unique identifier of the element to use as a template (optional).

Returns:

string guid

toString

public String toString()

JSON-style toString.

Overrides:

toString in class Object

Returns:

list of properties and their values.

equals

public boolean equals(Object objectToCompare)

Equals method that returns true if containing properties are the same.

Overrides:

equals in class Object

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code