Package org.gcube.informationsystem.model.reference.properties

Interface Metadata

All Superinterfaces:

Element, ModelElement, Property, PropertyElement, SchemaMixedElement, Serializable

All Known Implementing Classes:

MetadataImpl

@TypeMetadata(name="Metadata",
              description="This type provides metadata per every IdentifiableElement",
              version="1.0.0")
@Change(version="1.0.0",
        description="First Version")
public interface Metadata
extends Property

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:

Property, IdentifiableElement

Field Summary

Fields

Modifier and Type	Field	Description
static String	CREATED_BY_PROPERTY	The property name for the creator.
static String	CREATION_TIME_PROPERTY	The property name for the creation time.
static String	HIDDEN_FOR_PRIVACY_USER	A constant for a user hidden for privacy reasons.
static String	LAST_UPDATE_BY_PROPERTY	The property name for the last updater.
static String	LAST_UPDATE_TIME_PROPERTY	The property name for the last update time.
static String	NAME	The name of the Metadata property type.
static String	UNKNOWN_USER	A constant for an unknown user.

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

DATETIME_PATTERN, TYPE_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.reference.ModelElement

EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

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

Methods inherited from interface org.gcube.informationsystem.model.reference.ModelElement

getExpectedtype, getSupertypes

Methods inherited from interface org.gcube.informationsystem.model.reference.properties.Property

getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

Field Detail

NAME

static final String NAME

The name of the Metadata property type.

See Also:

Constant Field Values

UNKNOWN_USER

static final String UNKNOWN_USER

A constant for an unknown user.

See Also:

Constant Field Values

HIDDEN_FOR_PRIVACY_USER

static final String HIDDEN_FOR_PRIVACY_USER

A constant for a user hidden for privacy reasons.

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 Detail

getCreatedBy

@ISProperty(name="createdBy",
            description="The user that created the Entity or the Relation. It is initialized at Creation Time.",
            readonly=true,
            mandatory=true,
            nullable=false)
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,
            nullable=false)
Date getCreationTime()

Returns the time when the element was created.

Returns:

The creation date and time.

getLastUpdateBy

@ISProperty(name="lastUpdateBy",
            description="The user that made the last update to the Entity or the Relation. At Creation Time, it assumes the same value of createdBy.",
            mandatory=true,
            nullable=false)
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,
            nullable=false)
Date getLastUpdateTime()

Returns the time when the element was last updated.

Returns:

The last update date and time.