Package org.eclipse.lyo.oslc4j.core.model

Class QueryCapability

java.lang.Object
org.eclipse.lyo.oslc4j.core.model.AbstractResource
org.eclipse.lyo.oslc4j.core.model.QueryCapability
All Implemented Interfaces:
IExtendedResource, IResource
@OslcNamespace("http://open-services.net/ns/core#") @OslcResourceShape(title="OSLC Query Capability Resource Shape", describes="http://open-services.net/ns/core#QueryCapability") public class QueryCapability extends AbstractResource
OSLC QueryCapability resource

  • Constructor Details

    • QueryCapability

      public QueryCapability()

    • QueryCapability

      public QueryCapability(String title, URI queryBase)

  • Method Details

    • addResourceType

      public void addResourceType(URI resourceType)

    • addUsage

      public void addUsage(URI usage)

    • getLabel

      @OslcDescription("Very short label for use in menu items") @OslcPropertyDefinition("http://open-services.net/ns/core#label") @OslcReadOnly @OslcTitle("Label") public String getLabel()
      Very short label for use in menu items
      Returns:
      label

    • getQueryBase

      @OslcDescription("The base URI to use for queries. Queries are invoked via HTTP GET on a query URI formed by appending a key=value pair to the base URI, as described in Query Capabilities section") @OslcOccurs(ExactlyOne) @OslcPropertyDefinition("http://open-services.net/ns/core#queryBase") @OslcReadOnly @OslcTitle("Query Base") public URI getQueryBase()
      The base URI to use for queries. Queries are invoked via HTTP GET on a query URI formed by appending a key=value pair to the base URI, as described in Query Capabilities section
      Returns:
      queryBase

    • getResourceShape

      @OslcDescription("The Query Capability SHOULD provide a Resource Shape that describes the query base URI") @OslcName("resourceShape") @OslcPropertyDefinition("http://open-services.net/ns/core#resourceShape") @OslcRange("http://open-services.net/ns/core#ResourceShape") @OslcReadOnly @OslcTitle("Resource Shape") @OslcValueShape("resourceShapes/resourceShape") public URI getResourceShape()
      The Query Capability SHOULD provide a Resource Shape that describes the query base URI
      Returns:
      resourceShape

    • getResourceTypes

      @OslcDescription("The expected resource type URI that will be returned with this query capability. These would be the URIs found in the result resource\'s rdf:type property") @OslcName("resourceType") @OslcPropertyDefinition("http://open-services.net/ns/core#resourceType") @OslcReadOnly @OslcTitle("Resource Types") public URI[] getResourceTypes()
      The expected resource type URI that will be returned with this query capability. These would be the URIs found in the result resource's rdf:type property
      Returns:
      resourceTypes

    • getTitle

      @OslcDescription("Title string that could be used for display") @OslcOccurs(ExactlyOne) @OslcPropertyDefinition("http://purl.org/dc/terms/title") @OslcReadOnly @OslcTitle("Title") @OslcValueType(XMLLiteral) public String getTitle()
      Title string that could be used for display
      Returns:
      title

    • getUsages

      @OslcDescription("An identifier URI for the domain specified usage of this query capability. If a service provides multiple query capabilities, it may designate the primary or default one that should be used with a property value of http://open-services.net/ns/core#default") @OslcName("usage") @OslcPropertyDefinition("http://open-services.net/ns/core#usage") @OslcReadOnly @OslcTitle("Usages") public URI[] getUsages()
      An identifier URI for the domain specified usage of this query capability. If a service provides multiple query capabilities, it may designate the primary or default one that should be used with a property value of http://open-services.net/ns/core#default
      Returns:
      usages

    • setLabel

      public void setLabel(String label)

    • setQueryBase

      public void setQueryBase(URI queryBase)

    • setResourceShape

      public void setResourceShape(URI resourceShape)

    • setResourceTypes

      public void setResourceTypes(URI[] resourceTypes)

    • setTitle

      public void setTitle(String title)

    • setUsages

      public void setUsages(URI[] usages)