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

Interface IAutomationRequest

All Known Implementing Classes:

AutomationRequest

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

Method Summary

Modifier and Type	Method	Description
void	addContributor(Link contributor)
void	addCreator(Link creator)
void	addInputParameter(Link inputParameter)
void	addInstanceShape(Link instanceShape)
void	addServiceProvider(Link serviceProvider)
void	addState(Link state)
void	addType(Link type)
Set<Link>	getContributor()
Date	getCreated()
Set<Link>	getCreator()
String	getDescription()
Link	getDesiredState()
Link	getExecutesAutomationPlan()
String	getIdentifier()
Set<Link>	getInputParameter()
Set<Link>	getInstanceShape()
Date	getModified()
Set<Link>	getServiceProvider()
Set<Link>	getState()
String	getTitle()
Set<Link>	getType()
void	setContributor(Set<Link> contributor)
void	setCreated(Date created)
void	setCreator(Set<Link> creator)
void	setDescription(String description)
void	setDesiredState(Link desiredState)
void	setExecutesAutomationPlan(Link executesAutomationPlan)
void	setIdentifier(String identifier)
void	setInputParameter(Set<Link> inputParameter)
void	setInstanceShape(Set<Link> instanceShape)
void	setModified(Date modified)
void	setServiceProvider(Set<Link> serviceProvider)
void	setState(Set<Link> state)
void	setTitle(String title)
void	setType(Set<Link> type)

Method Detail

addContributor

void addContributor(Link contributor)

addCreator

void addCreator(Link creator)

addType

void addType(Link type)

addInstanceShape

void addInstanceShape(Link instanceShape)

addServiceProvider

void addServiceProvider(Link serviceProvider)

addState

void addState(Link state)

addInputParameter

void addInputParameter(Link inputParameter)

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

getDescription

@OslcName("description")
@OslcPropertyDefinition("http://purl.org/dc/terms/description")
@OslcDescription("Descriptive text about resource represented as rich text in XHTML content. SHOULD include only content that is valid and suitable inside an XHTML <div> element.")
@OslcOccurs(ZeroOrOne)
@OslcValueType(XMLLiteral)
@OslcReadOnly(false)
String getDescription()

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

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

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

getExecutesAutomationPlan

@OslcName("executesAutomationPlan")
@OslcPropertyDefinition("http://open-services.net/ns/auto#executesAutomationPlan")
@OslcDescription("Automation Plan run by the Automation Request. 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 getExecutesAutomationPlan()

setContributor

void setContributor(Set<Link> contributor)

setCreated

void setCreated(Date created)

setCreator

void setCreator(Set<Link> creator)

setDescription

void setDescription(String description)

setIdentifier

void setIdentifier(String identifier)

setModified

void setModified(Date modified)

setType

void setType(Set<Link> type)

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)

setInputParameter

void setInputParameter(Set<Link> inputParameter)

setExecutesAutomationPlan

void setExecutesAutomationPlan(Link executesAutomationPlan)