Package org.gcube.resourcemanagement.model.reference.entities.facets

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

      Fields 
      Modifier and Type Field Description
      static String NAME
      The name associated with this facet

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

        DATETIME_PATTERN, TYPE_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.model.reference.ERElement

        CONTEXTS_PROPERTY

      • Fields inherited from interface org.gcube.informationsystem.base.reference.IdentifiableElement

        ID_PROPERTY, METADATA_PROPERTY

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

        EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static CapabilityFacet getDefaultInstance()
      Returns a default instance of CapabilityFacet
      String getDescription()
      A human oriented description of the capability.
      String getName()
      The distinguishing name of the capability.
      String getQualifier()
      A string used to specialise the capability.
      void setDescription​(String description)
      Sets a human oriented description of the capability.
      void setName​(String name)
      Sets the distinguishing name of the capability.
      void setQualifier​(String qualifier)
      Sets the qualifier of the capability.

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

        getTypeName

      • Methods inherited from interface org.gcube.informationsystem.base.reference.entities.EntityElement

        getID, getMetadata, setID, setMetadata

      • Methods inherited from interface org.gcube.informationsystem.model.reference.ERElement

        getContexts

      • Methods inherited from interface org.gcube.informationsystem.model.reference.entities.Facet

        getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

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

        getExpectedtype, getSupertypes

    • Method Detail

      • getDefaultInstance

        static CapabilityFacet 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

        void setName​(String name)
        Sets the distinguishing name of the capability.
        Parameters:
        name - the name

      • getDescription

        @ISProperty(description="A human oriented description of the capability.")
String getDescription()
        A human oriented description of the capability.
        Returns:
        the description

      • setDescription

        void setDescription​(String description)
        Sets a human oriented description of the capability.
        Parameters:
        description - the description

      • getQualifier

        @ISProperty(description="A string used to specialise the capability.")
String getQualifier()
        A string used to specialise the capability.
        Returns:
        the qualifier

      • setQualifier

        void setQualifier​(String qualifier)
        Sets the qualifier of the capability.
        Parameters:
        qualifier - the qualifier