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

Interface IAutomationPlan

All Known Implementing Classes:

AutomationPlan

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

Method Summary

Modifier and Type	Method	Description
void	addContributor(Link contributor)
void	addCreator(Link creator)
void	addFutureAction(Link futureAction)
void	addInstanceShape(Link instanceShape)
void	addParameterDefinition(Link parameterDefinition)
void	addServiceProvider(Link serviceProvider)
void	addSubject(String subject)
void	addType(Link type)
void	addUsesExecutionEnvironment(Link usesExecutionEnvironment)
Set<Link>	getContributor()
Date	getCreated()
Set<Link>	getCreator()
String	getDescription()
Set<Link>	getFutureAction()
String	getIdentifier()
Set<Link>	getInstanceShape()
Date	getModified()
Set<Link>	getParameterDefinition()
Set<Link>	getServiceProvider()
Set<String>	getSubject()
String	getTitle()
Set<Link>	getType()
Set<Link>	getUsesExecutionEnvironment()
void	setContributor(Set<Link> contributor)
void	setCreated(Date created)
void	setCreator(Set<Link> creator)
void	setDescription(String description)
void	setFutureAction(Set<Link> futureAction)
void	setIdentifier(String identifier)
void	setInstanceShape(Set<Link> instanceShape)
void	setModified(Date modified)
void	setParameterDefinition(Set<Link> parameterDefinition)
void	setServiceProvider(Set<Link> serviceProvider)
void	setSubject(Set<String> subject)
void	setTitle(String title)
void	setType(Set<Link> type)
void	setUsesExecutionEnvironment(Set<Link> usesExecutionEnvironment)

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)

addParameterDefinition

void addParameterDefinition(Link parameterDefinition)

addUsesExecutionEnvironment

void addUsesExecutionEnvironment(Link usesExecutionEnvironment)

addFutureAction

void addFutureAction(Link futureAction)

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

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

getParameterDefinition

@OslcName("parameterDefinition")
@OslcPropertyDefinition("http://open-services.net/ns/auto#parameterDefinition")
@OslcDescription("The definition of a parameter for this Automation Plan. parameterDefinitions are either a local (inline) or referenced resource and use the attributes (the range) of the  oslc:Property resource with one exception. When used in the context of an oslc_auto:parameterDefinition, the cardinality of oslc:propertyDefinition becomes zero-or-one instead of exactly-one. Automation consumers creating Automation Requests MUST use the oslc:occurs attribute of the parameterDefinition, if present, to determine if a given parameter is required when creating the Automation Request. If the oslc:occurs attribute indicates the parameter is required (exactly-one or one-or-more), the service provider must guarantee the named parameter will be present in the Automation Result either as an oslc_auto:inputParmeter when unmodified during execution, or as an oslc_auto:outputParameter when modified during execution.")
@OslcOccurs(ZeroOrMany)
@OslcValueType(Resource)
@OslcReadOnly(false)
Set<Link> getParameterDefinition()

getUsesExecutionEnvironment

@OslcName("usesExecutionEnvironment")
@OslcPropertyDefinition("http://open-services.net/ns/auto#usesExecutionEnvironment")
@OslcDescription("A resource representing the environment(s) which this Automation Plan can be executed in. The execution environment resource could represent a grouping of environmental details such as operating system, database, browser, compiler, etc. See also the execution environments section.")
@OslcOccurs(ZeroOrMany)
@OslcValueType(Resource)
@OslcRepresentation(Reference)
@OslcReadOnly(false)
Set<Link> getUsesExecutionEnvironment()

getFutureAction

@OslcName("futureAction")
@OslcPropertyDefinition("http://open-services.net/ns/auto#futureAction")
@OslcDescription("A resource representing actions that will become available on Automation Results that result from execution of this Plan. The resource is likely to be of type oslc:Action, but it can be of any type. Automation defines oslc_auto:TeardownAction as one kind of future action.")
@OslcOccurs(ZeroOrMany)
@OslcValueType(Resource)
@OslcRepresentation(Reference)
@OslcReadOnly(false)
Set<Link> getFutureAction()

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)

setSubject

void setSubject(Set<String> subject)

setTitle

void setTitle(String title)

setInstanceShape

void setInstanceShape(Set<Link> instanceShape)

setServiceProvider

void setServiceProvider(Set<Link> serviceProvider)

setParameterDefinition

void setParameterDefinition(Set<Link> parameterDefinition)

setUsesExecutionEnvironment

void setUsesExecutionEnvironment(Set<Link> usesExecutionEnvironment)

setFutureAction

void setFutureAction(Set<Link> futureAction)