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

Class AutomationPlan

java.lang.Object

org.eclipse.lyo.oslc4j.core.model.AbstractResource

org.eclipse.lyo.oslc.domains.auto.AutomationPlan

All Implemented Interfaces:

IAutomationPlan, IExtendedResource, IResource

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

Constructor Summary

Constructors

Constructor	Description
AutomationPlan()
AutomationPlan(URI about)

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)
static ResourceShape	createResourceShape()
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)
String	toString()
String	toString(boolean asLocalResource)

Methods inherited from class org.eclipse.lyo.oslc4j.core.model.AbstractResource

addType, getAbout, getExtendedProperties, getTypes, setAbout, setExtendedProperties, setTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AutomationPlan

public AutomationPlan()

AutomationPlan

public AutomationPlan(URI about)

Method Details

createResourceShape

public static ResourceShape createResourceShape()
                                         throws OslcCoreApplicationException,
URISyntaxException

Throws:

OslcCoreApplicationException

URISyntaxException

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean asLocalResource)

addContributor

public void addContributor(Link contributor)

Specified by:

addContributor in interface IAutomationPlan

addCreator

public void addCreator(Link creator)

Specified by:

addCreator in interface IAutomationPlan

addType

public void addType(Link type)

Specified by:

addType in interface IAutomationPlan

addSubject

public void addSubject(String subject)

Specified by:

addSubject in interface IAutomationPlan

addInstanceShape

public void addInstanceShape(Link instanceShape)

Specified by:

addInstanceShape in interface IAutomationPlan

addServiceProvider

public void addServiceProvider(Link serviceProvider)

Specified by:

addServiceProvider in interface IAutomationPlan

addParameterDefinition

public void addParameterDefinition(Link parameterDefinition)

Specified by:

addParameterDefinition in interface IAutomationPlan

addUsesExecutionEnvironment

public void addUsesExecutionEnvironment(Link usesExecutionEnvironment)

Specified by:

addUsesExecutionEnvironment in interface IAutomationPlan

addFutureAction

public void addFutureAction(Link futureAction)

Specified by:

addFutureAction in interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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)
public String getDescription()

Specified by:

getDescription in interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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 interface IAutomationPlan

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

Specified by:

getParameterDefinition in interface IAutomationPlan

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

Specified by:

getUsesExecutionEnvironment in interface IAutomationPlan

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

Specified by:

getFutureAction in interface IAutomationPlan

setContributor

public void setContributor(Set<Link> contributor)

Specified by:

setContributor in interface IAutomationPlan

setCreated

public void setCreated(Date created)

Specified by:

setCreated in interface IAutomationPlan

setCreator

public void setCreator(Set<Link> creator)

Specified by:

setCreator in interface IAutomationPlan

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface IAutomationPlan

setIdentifier

public void setIdentifier(String identifier)

Specified by:

setIdentifier in interface IAutomationPlan

setModified

public void setModified(Date modified)

Specified by:

setModified in interface IAutomationPlan

setType

public void setType(Set<Link> type)

Specified by:

setType in interface IAutomationPlan

setSubject

public void setSubject(Set<String> subject)

Specified by:

setSubject in interface IAutomationPlan

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface IAutomationPlan

setInstanceShape

public void setInstanceShape(Set<Link> instanceShape)

Specified by:

setInstanceShape in interface IAutomationPlan

setServiceProvider

public void setServiceProvider(Set<Link> serviceProvider)

Specified by:

setServiceProvider in interface IAutomationPlan

setParameterDefinition

public void setParameterDefinition(Set<Link> parameterDefinition)

Specified by:

setParameterDefinition in interface IAutomationPlan

setUsesExecutionEnvironment

public void setUsesExecutionEnvironment(Set<Link> usesExecutionEnvironment)

Specified by:

setUsesExecutionEnvironment in interface IAutomationPlan

setFutureAction

public void setFutureAction(Set<Link> futureAction)

Specified by:

setFutureAction in interface IAutomationPlan