Package org.gcube.informationsystem.base.reference.properties

Interface Metadata

All Superinterfaces:

Element, PropertyElement, Serializable

All Known Implementing Classes:

MetadataImpl

@TypeMetadata(name="Metadata",
              description="Metadata associated with the instance that is automatically created/updated by the system.",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface Metadata
extends PropertyElement

A property type that provides metadata for an IdentifiableElement.

This includes information about the element's creation and last update, such as the user responsible and the timestamp of the event.

Author:

Luca Frosini (ISTI - CNR)

See Also:

• PropertyElement
• IdentifiableElement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREATED_BY_PROPERTY	The property name for the creator.
static final String	CREATION_TIME_PROPERTY	The property name for the creation time.
static final String	LAST_UPDATE_BY_PROPERTY	The property name for the last updater.
static final String	LAST_UPDATE_TIME_PROPERTY	The property name for the last update time.
static final String	NAME	The name of the Metadata property type.

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

Method Summary

Modifier and Type	Method	Description
String	getCreatedBy()	Returns the user who created the element.
Date	getCreationTime()	Returns the time when the element was created.
String	getLastUpdateBy()	Returns the user who last updated the element.
Date	getLastUpdateTime()	Returns the time when the element was last updated.

Methods inherited from interface org.gcube.informationsystem.base.reference.Element

getTypeName

Field Details

NAME

static final String NAME

The name of the Metadata property type.

See Also:

• Constant Field Values

CREATED_BY_PROPERTY

static final String CREATED_BY_PROPERTY

The property name for the creator.

See Also:

• Constant Field Values

CREATION_TIME_PROPERTY

static final String CREATION_TIME_PROPERTY

The property name for the creation time.

See Also:

• Constant Field Values

LAST_UPDATE_BY_PROPERTY

static final String LAST_UPDATE_BY_PROPERTY

The property name for the last updater.

See Also:

• Constant Field Values

LAST_UPDATE_TIME_PROPERTY

static final String LAST_UPDATE_TIME_PROPERTY

The property name for the last update time.

See Also:

• Constant Field Values

Method Details

getCreatedBy

@ISProperty(name="createdBy",
            description="The principal who created the instance. *(Note: This field may be returned as \"[REDACTED]\" depending on the caller\'s authorization role).*",
            readonly=true,
            mandatory=true)
String getCreatedBy()

Returns the user who created the element.

Returns:

The creator's identifier.

getCreationTime

@ISProperty(name="creationTime",
            description="Creation time. It is represented in the format yyyy-MM-dd HH:mm:ss.SSS Z",
            readonly=true,
            mandatory=true)
Date getCreationTime()

Returns the time when the element was created.

Returns:

The creation date and time.

getLastUpdateBy

@ISProperty(name="lastUpdateBy",
            description="The principal who last updated the instance. *(Note: This field may be returned as \"[REDACTED]\" depending on the caller\'s authorization role).*",
            mandatory=true)
String getLastUpdateBy()

Returns the user who last updated the element.

Returns:

The last updater's identifier.

getLastUpdateTime

@ISProperty(name="lastUpdateTime",
            description="Last Update time. At creation time it assumes the same value of creationTime. It is represented in the format yyyy-MM-dd HH:mm:ss.SSS Z",
            mandatory=true)
Date getLastUpdateTime()

Returns the time when the element was last updated.

Returns:

The last update date and time.