Class AutomationResult
- java.lang.Object
-
- org.eclipse.lyo.oslc4j.core.model.AbstractResource
-
- org.eclipse.lyo.oslc.domains.auto.AutomationResult
-
- All Implemented Interfaces:
IAutomationResult
,IExtendedResource
,IResource
@OslcNamespace("http://open-services.net/ns/auto#") @OslcName("AutomationResult") @OslcResourceShape(title="AutomationResult Shape", describes="http://open-services.net/ns/auto#AutomationResult") public class AutomationResult extends AbstractResource implements IAutomationResult
-
-
Constructor Summary
Constructors Constructor Description AutomationResult()
AutomationResult(URI about)
-
Method Summary
-
Methods inherited from class org.eclipse.lyo.oslc4j.core.model.AbstractResource
addType, getAbout, getExtendedProperties, getTypes, setAbout, setExtendedProperties, setTypes
-
-
-
-
Constructor Detail
-
AutomationResult
public AutomationResult()
-
AutomationResult
public AutomationResult(URI about)
-
-
Method Detail
-
createResourceShape
public static ResourceShape createResourceShape() throws OslcCoreApplicationException, URISyntaxException
-
toString
public String toString(boolean asLocalResource)
-
addContributor
public void addContributor(Link contributor)
- Specified by:
addContributor
in interfaceIAutomationResult
-
addCreator
public void addCreator(Link creator)
- Specified by:
addCreator
in interfaceIAutomationResult
-
addType
public void addType(Link type)
- Specified by:
addType
in interfaceIAutomationResult
-
addSubject
public void addSubject(String subject)
- Specified by:
addSubject
in interfaceIAutomationResult
-
addInstanceShape
public void addInstanceShape(Link instanceShape)
- Specified by:
addInstanceShape
in interfaceIAutomationResult
-
addServiceProvider
public void addServiceProvider(Link serviceProvider)
- Specified by:
addServiceProvider
in interfaceIAutomationResult
-
addState
public void addState(Link state)
- Specified by:
addState
in interfaceIAutomationResult
-
addVerdict
public void addVerdict(Link verdict)
- Specified by:
addVerdict
in interfaceIAutomationResult
-
addContribution
public void addContribution(Link contribution)
- Specified by:
addContribution
in interfaceIAutomationResult
-
addInputParameter
public void addInputParameter(Link inputParameter)
- Specified by:
addInputParameter
in interfaceIAutomationResult
-
addOutputParameter
public void addOutputParameter(Link outputParameter)
- Specified by:
addOutputParameter
in interfaceIAutomationResult
-
getContributor
@OslcName("contributor") @OslcPropertyDefinition("http://purl.org/dc/terms/contributor") @OslcDescription("Contributor or contributors to the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcRange("http://xmlns.com/foaf/0.1/Person") @OslcReadOnly(false) public Set<Link> getContributor()
- Specified by:
getContributor
in interfaceIAutomationResult
-
getCreated
@OslcName("created") @OslcPropertyDefinition("http://purl.org/dc/terms/created") @OslcDescription("Timestamp of resource creation") @OslcOccurs(ZeroOrOne) @OslcValueType(DateTime) @OslcReadOnly(false) public Date getCreated()
- Specified by:
getCreated
in interfaceIAutomationResult
-
getCreator
@OslcName("creator") @OslcPropertyDefinition("http://purl.org/dc/terms/creator") @OslcDescription("Creator or creators of the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcRange("http://xmlns.com/foaf/0.1/Person") @OslcReadOnly(false) public Set<Link> getCreator()
- Specified by:
getCreator
in interfaceIAutomationResult
-
getIdentifier
@OslcName("identifier") @OslcPropertyDefinition("http://purl.org/dc/terms/identifier") @OslcDescription("A unique identifier for a resource. Typically read-only and assigned by the service provider when a resource is created. Not typically intended for end-user display.") @OslcOccurs(ExactlyOne) @OslcValueType(String) @OslcReadOnly(false) public String getIdentifier()
- Specified by:
getIdentifier
in interfaceIAutomationResult
-
getModified
@OslcName("modified") @OslcPropertyDefinition("http://purl.org/dc/terms/modified") @OslcDescription("Timestamp of latest resource modification") @OslcOccurs(ZeroOrOne) @OslcValueType(DateTime) @OslcReadOnly(false) public Date getModified()
- Specified by:
getModified
in interfaceIAutomationResult
-
getType
@OslcName("type") @OslcPropertyDefinition("http://www.w3.org/1999/02/22-rdf-syntax-ns#type") @OslcDescription("The resource type URIs") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcReadOnly(false) public Set<Link> getType()
- Specified by:
getType
in interfaceIAutomationResult
-
getSubject
@OslcName("subject") @OslcPropertyDefinition("http://purl.org/dc/terms/subject") @OslcDescription("Tag or keyword for a resource. Each occurrence of a dcterms:subject property denotes an additional tag for the resource.") @OslcOccurs(ZeroOrMany) @OslcValueType(String) @OslcReadOnly(false) @OslcTitle("") public Set<String> getSubject()
- Specified by:
getSubject
in interfaceIAutomationResult
-
getTitle
@OslcName("title") @OslcPropertyDefinition("http://purl.org/dc/terms/title") @OslcDescription("Title of the resource represented as rich text in XHTML content. SHOULD include only content that is valid inside an XHTML <span> element.") @OslcOccurs(ExactlyOne) @OslcValueType(XMLLiteral) @OslcReadOnly(false) public String getTitle()
- Specified by:
getTitle
in interfaceIAutomationResult
-
getInstanceShape
@OslcName("instanceShape") @OslcPropertyDefinition("http://open-services.net/ns/core#instanceShape") @OslcDescription("The URI of a Resource Shape that describes the possible properties, occurrence, value types, allowed values and labels. This shape information is useful in displaying the subject resource as well as guiding clients in performing modifications. Instance shapes may be specific to the authenticated user associated with the request that retrieved the resource, the current state of the resource and other factors and thus should not be cached.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcRepresentation(Reference) @OslcReadOnly(false) public Set<Link> getInstanceShape()
- Specified by:
getInstanceShape
in interfaceIAutomationResult
-
getServiceProvider
@OslcName("serviceProvider") @OslcPropertyDefinition("http://open-services.net/ns/core#serviceProvider") @OslcDescription("A link to the resource\'s OSLC Service Provider. There may be cases when the subject resource is available from a service provider that implements multiple domain specifications, which could result in multiple values for this property.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcRepresentation(Reference) @OslcReadOnly(false) public Set<Link> getServiceProvider()
- Specified by:
getServiceProvider
in interfaceIAutomationResult
-
getState
@OslcName("state") @OslcPropertyDefinition("http://open-services.net/ns/auto#state") @OslcDescription("Used to indicate the state of the automation request based on values defined by the service provider. Most often a read-only property. It is expected that this will be a resource reference to a definition of a valid automation request state on the service provider.") @OslcOccurs(OneOrMany) @OslcValueType(Resource) @OslcReadOnly(true) public Set<Link> getState()
- Specified by:
getState
in interfaceIAutomationResult
-
getDesiredState
@OslcName("desiredState") @OslcPropertyDefinition("http://open-services.net/ns/auto#desiredState") @OslcDescription("Used to indicate the desired state of the Automation Request based on values defined by the service provider. It is expected that this will be a resource reference to a definition of a valid automation request state on the service provider.") @OslcOccurs(ZeroOrOne) @OslcValueType(Resource) @OslcReadOnly(false) public Link getDesiredState()
- Specified by:
getDesiredState
in interfaceIAutomationResult
-
getVerdict
@OslcName("verdict") @OslcPropertyDefinition("http://open-services.net/ns/auto#verdict") @OslcDescription("Used to indicate the verdict of the automation result based on values defined by the service provider. Most often a read-only property. It is expected that this will be a resource reference to a definition of a valid automation result verdict on the service provider.") @OslcOccurs(OneOrMany) @OslcValueType(Resource) @OslcReadOnly(false) public Set<Link> getVerdict()
- Specified by:
getVerdict
in interfaceIAutomationResult
-
getContribution
@OslcName("contribution") @OslcPropertyDefinition("http://open-services.net/ns/auto#contribution") @OslcDescription("A result contribution associated with this automation result. It is recommended that the contribution be an inline resource which can be retrieved with the automation result. The recommended attributes beyond the contribution itself are dcterms:title, dcterms:description and dcterms:type to provide a description of the contribution which would be appropriate for display in a simple UI for an automation result.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcReadOnly(false) public Set<Link> getContribution()
- Specified by:
getContribution
in interfaceIAutomationResult
-
getInputParameter
@OslcName("inputParameter") @OslcPropertyDefinition("http://open-services.net/ns/auto#inputParameter") @OslcDescription("Parameters provided when Automation Requests are created. These include parameters provided by the creator of the Automation Request (whether by delegated UI or HTTP POST) and MAY include additional parameters added by the service provider during Automation Request creation. See the definition of the oslc_auto:parameterDefinition attribute of the Automation Plan for additional guidance on determining which parameters are required. Creators of Automation Requests MAY provide parameters beyond those defined in the Automation Plan without guarantee the service provider will recognize or honor them. It is expected that this attribute is write-able on Automation Request creation and read-only thereafter.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcRange("http://open-services.net/ns/auto#ParameterInstance") @OslcReadOnly(false) public Set<Link> getInputParameter()
- Specified by:
getInputParameter
in interfaceIAutomationResult
-
getOutputParameter
@OslcName("outputParameter") @OslcPropertyDefinition("http://open-services.net/ns/auto#outputParameter") @OslcDescription("Automation Result output parameters are parameters associated with the automation execution which produced this Result. This includes the final value of all parameters used to initiate the execution and any additional parameters which may have been created during automation execution by the service provider or external agents. The value of a given oslc_auto:outputParameter MAY change as the execution proceeds. Point-in-time accuracy of the values of output parameters is not covered by this specification. Once the Automation Result is in a final state ( oslc_auto:complete or oslc_auto:canceled), the oslc_auto:outputParameter values MUST NOT change.") @OslcOccurs(ZeroOrMany) @OslcValueType(Resource) @OslcRange("http://open-services.net/ns/auto#ParameterInstance") @OslcReadOnly(false) public Set<Link> getOutputParameter()
- Specified by:
getOutputParameter
in interfaceIAutomationResult
-
getProducedByAutomationRequest
@OslcName("producedByAutomationRequest") @OslcPropertyDefinition("http://open-services.net/ns/auto#producedByAutomationRequest") @OslcDescription("Automation Request which produced the Automation Result. It is likely that the target resource will be an oslc_auto:AutomationRequest but that is not necessarily the case.") @OslcOccurs(ZeroOrOne) @OslcValueType(Resource) @OslcRepresentation(Reference) @OslcRange("http://open-services.net/ns/auto#AutomationRequest") @OslcReadOnly(false) public Link getProducedByAutomationRequest()
- Specified by:
getProducedByAutomationRequest
in interfaceIAutomationResult
-
getReportsOnAutomationPlan
@OslcName("reportsOnAutomationPlan") @OslcPropertyDefinition("http://open-services.net/ns/auto#reportsOnAutomationPlan") @OslcDescription("Automation Plan which the Automation Result reports on. It is likely that the target resource will be an oslc_auto:AutomationPlan but that is not necessarily the case.") @OslcOccurs(ExactlyOne) @OslcValueType(Resource) @OslcRepresentation(Reference) @OslcRange("http://open-services.net/ns/auto#AutomationPlan") @OslcReadOnly(false) public Link getReportsOnAutomationPlan()
- Specified by:
getReportsOnAutomationPlan
in interfaceIAutomationResult
-
setContributor
public void setContributor(Set<Link> contributor)
- Specified by:
setContributor
in interfaceIAutomationResult
-
setCreated
public void setCreated(Date created)
- Specified by:
setCreated
in interfaceIAutomationResult
-
setCreator
public void setCreator(Set<Link> creator)
- Specified by:
setCreator
in interfaceIAutomationResult
-
setIdentifier
public void setIdentifier(String identifier)
- Specified by:
setIdentifier
in interfaceIAutomationResult
-
setModified
public void setModified(Date modified)
- Specified by:
setModified
in interfaceIAutomationResult
-
setType
public void setType(Set<Link> type)
- Specified by:
setType
in interfaceIAutomationResult
-
setSubject
public void setSubject(Set<String> subject)
- Specified by:
setSubject
in interfaceIAutomationResult
-
setTitle
public void setTitle(String title)
- Specified by:
setTitle
in interfaceIAutomationResult
-
setInstanceShape
public void setInstanceShape(Set<Link> instanceShape)
- Specified by:
setInstanceShape
in interfaceIAutomationResult
-
setServiceProvider
public void setServiceProvider(Set<Link> serviceProvider)
- Specified by:
setServiceProvider
in interfaceIAutomationResult
-
setState
public void setState(Set<Link> state)
- Specified by:
setState
in interfaceIAutomationResult
-
setDesiredState
public void setDesiredState(Link desiredState)
- Specified by:
setDesiredState
in interfaceIAutomationResult
-
setVerdict
public void setVerdict(Set<Link> verdict)
- Specified by:
setVerdict
in interfaceIAutomationResult
-
setContribution
public void setContribution(Set<Link> contribution)
- Specified by:
setContribution
in interfaceIAutomationResult
-
setInputParameter
public void setInputParameter(Set<Link> inputParameter)
- Specified by:
setInputParameter
in interfaceIAutomationResult
-
setOutputParameter
public void setOutputParameter(Set<Link> outputParameter)
- Specified by:
setOutputParameter
in interfaceIAutomationResult
-
setProducedByAutomationRequest
public void setProducedByAutomationRequest(Link producedByAutomationRequest)
- Specified by:
setProducedByAutomationRequest
in interfaceIAutomationResult
-
setReportsOnAutomationPlan
public void setReportsOnAutomationPlan(Link reportsOnAutomationPlan)
- Specified by:
setReportsOnAutomationPlan
in interfaceIAutomationResult
-
-