Package org.eclipse.lyo.oslc.domains.auto

Interface IAutomationResult

All Known Implementing Classes:

AutomationResult

@OslcNamespace("http://open-services.net/ns/auto#")
@OslcName("AutomationResult")
@OslcResourceShape(title="AutomationResult Shape",
                   describes="http://open-services.net/ns/auto#AutomationResult")
public interface IAutomationResult

Method Summary

Modifier and Type	Method	Description
void	addContribution(Link contribution)
void	addContributor(Link contributor)
void	addCreator(Link creator)
void	addInputParameter(Link inputParameter)
void	addInstanceShape(Link instanceShape)
void	addOutputParameter(Link outputParameter)
void	addServiceProvider(Link serviceProvider)
void	addState(Link state)
void	addSubject(String subject)
void	addType(Link type)
void	addVerdict(Link verdict)
Set<Link>	getContribution()
Set<Link>	getContributor()
Date	getCreated()
Set<Link>	getCreator()
Link	getDesiredState()
String	getIdentifier()
Set<Link>	getInputParameter()
Set<Link>	getInstanceShape()
Date	getModified()
Set<Link>	getOutputParameter()
Link	getProducedByAutomationRequest()
Link	getReportsOnAutomationPlan()
Set<Link>	getServiceProvider()
Set<Link>	getState()
Set<String>	getSubject()
String	getTitle()
Set<Link>	getType()
Set<Link>	getVerdict()
void	setContribution(Set<Link> contribution)
void	setContributor(Set<Link> contributor)
void	setCreated(Date created)
void	setCreator(Set<Link> creator)
void	setDesiredState(Link desiredState)
void	setIdentifier(String identifier)
void	setInputParameter(Set<Link> inputParameter)
void	setInstanceShape(Set<Link> instanceShape)
void	setModified(Date modified)
void	setOutputParameter(Set<Link> outputParameter)
void	setProducedByAutomationRequest(Link producedByAutomationRequest)
void	setReportsOnAutomationPlan(Link reportsOnAutomationPlan)
void	setServiceProvider(Set<Link> serviceProvider)
void	setState(Set<Link> state)
void	setSubject(Set<String> subject)
void	setTitle(String title)
void	setType(Set<Link> type)
void	setVerdict(Set<Link> verdict)

Method Detail

addContributor

void addContributor(Link contributor)

addCreator

void addCreator(Link creator)

addType

void addType(Link type)

addSubject

void addSubject(String subject)

addInstanceShape

void addInstanceShape(Link instanceShape)

addServiceProvider

void addServiceProvider(Link serviceProvider)

addState

void addState(Link state)

addVerdict

void addVerdict(Link verdict)

addContribution

void addContribution(Link contribution)

addInputParameter

void addInputParameter(Link inputParameter)

addOutputParameter

void addOutputParameter(Link outputParameter)

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)
Set<Link> getContributor()

getCreated

@OslcName("created")
@OslcPropertyDefinition("http://purl.org/dc/terms/created")
@OslcDescription("Timestamp of resource creation")
@OslcOccurs(ZeroOrOne)
@OslcValueType(DateTime)
@OslcReadOnly(false)
Date getCreated()

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)
Set<Link> getCreator()

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)
String getIdentifier()

getModified

@OslcName("modified")
@OslcPropertyDefinition("http://purl.org/dc/terms/modified")
@OslcDescription("Timestamp of latest resource modification")
@OslcOccurs(ZeroOrOne)
@OslcValueType(DateTime)
@OslcReadOnly(false)
Date getModified()

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)
Set<Link> getType()

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("")
Set<String> getSubject()

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)
String getTitle()

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)
Set<Link> getInstanceShape()

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)
Set<Link> getServiceProvider()

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)
Set<Link> getState()

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)
Link getDesiredState()

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)
Set<Link> getVerdict()

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)
Set<Link> getContribution()

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)
Set<Link> getInputParameter()

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)
Set<Link> getOutputParameter()

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)
Link getProducedByAutomationRequest()

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)
Link getReportsOnAutomationPlan()

setContributor

void setContributor(Set<Link> contributor)

setCreated

void setCreated(Date created)

setCreator

void setCreator(Set<Link> creator)

setIdentifier

void setIdentifier(String identifier)

setModified

void setModified(Date modified)

setType

void setType(Set<Link> type)

setSubject

void setSubject(Set<String> subject)

setTitle

void setTitle(String title)

setInstanceShape

void setInstanceShape(Set<Link> instanceShape)

setServiceProvider

void setServiceProvider(Set<Link> serviceProvider)

setState

void setState(Set<Link> state)

setDesiredState

void setDesiredState(Link desiredState)

setVerdict

void setVerdict(Set<Link> verdict)

setContribution

void setContribution(Set<Link> contribution)

setInputParameter

void setInputParameter(Set<Link> inputParameter)

setOutputParameter

void setOutputParameter(Set<Link> outputParameter)

setProducedByAutomationRequest

void setProducedByAutomationRequest(Link producedByAutomationRequest)

setReportsOnAutomationPlan

void setReportsOnAutomationPlan(Link reportsOnAutomationPlan)