Interface CapabilityFacet
- All Superinterfaces:
org.gcube.informationsystem.base.reference.Element,org.gcube.informationsystem.model.reference.entities.Entity,org.gcube.informationsystem.base.reference.entities.EntityElement,org.gcube.informationsystem.model.reference.ERElement,org.gcube.informationsystem.model.reference.entities.Facet,org.gcube.informationsystem.base.reference.IdentifiableElement,org.gcube.informationsystem.model.reference.ModelElement,org.gcube.informationsystem.base.reference.SchemaMixedElement,Serializable
- All Known Implementing Classes:
CapabilityFacetImpl
@TypeMetadata(name="CapabilityFacet",
description="CapabilityFacet captures a defined facility for performing a specified task supported by a given Resource. It is mainly used to provide a human-readable description of the capabilities of a resource (e.g., the support for transactions of an electronic device or some non-functional properties of a service like its replicability to support High-Availability (HA)).",
version="1.0.0")
@Change(version="1.0.0",
description="First Version")
public interface CapabilityFacet
extends org.gcube.informationsystem.model.reference.entities.Facet
CapabilityFacet captures a defined facility to perform a specified task supported by a given Resource.
It is mainly used to provide a human-readable description of the capabilities of a resource
(e.g., the support for transactions of an electronic device or some non-functional
properties of a service like its replicability to support High-Availability (HA)).
https://wiki.gcube-system.org/gcube/GCube_Model#Capability_Facet
- Author:
- Luca Frosini (ISTI - CNR)
-
Field Summary
FieldsFields inherited from interface org.gcube.informationsystem.base.reference.Element
DATETIME_PATTERN, TYPE_PROPERTYFields inherited from interface org.gcube.informationsystem.model.reference.ERElement
CONTEXTS_PROPERTYFields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement
ID_PROPERTY, METADATA_PROPERTYFields inherited from interface org.gcube.informationsystem.model.reference.ModelElement
EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY -
Method Summary
Modifier and TypeMethodDescriptionstatic CapabilityFacetReturns a default instance of CapabilityFacetA human oriented description of the capability.getName()The distinguishing name of the capability.A string used to specialise the capability.voidsetDescription(String description) Sets a human oriented description of the capability.voidSets the distinguishing name of the capability.voidsetQualifier(String qualifier) Sets the qualifier of the capability.Methods inherited from interface org.gcube.informationsystem.base.reference.Element
getTypeNameMethods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement
getID, getMetadata, setID, setMetadataMethods inherited from interface org.gcube.informationsystem.model.reference.ERElement
getContextsMethods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet
getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalPropertyMethods inherited from interface org.gcube.informationsystem.model.reference.ModelElement
getExpectedtype, getSupertypes
-
Field Details
-
NAME
The name associated with this facet- See Also:
-
-
Method Details
-
getDefaultInstance
Returns a default instance of CapabilityFacet- Returns:
- a default instance of CapabilityFacet
-
getName
@ISProperty(description="The distinguishing name of the capability.", mandatory=true, nullable=false) String getName()The distinguishing name of the capability.- Returns:
- the name
-
setName
Sets the distinguishing name of the capability.- Parameters:
name- the name
-
getDescription
A human oriented description of the capability.- Returns:
- the description
-
setDescription
Sets a human oriented description of the capability.- Parameters:
description- the description
-
getQualifier
A string used to specialise the capability.- Returns:
- the qualifier
-
setQualifier
Sets the qualifier of the capability.- Parameters:
qualifier- the qualifier
-