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

Class AutomationRequest

java.lang.Object

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

org.eclipse.lyo.oslc.domains.auto.AutomationRequest

All Implemented Interfaces:

IAutomationRequest, IExtendedResource, IResource

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

Constructor Summary

Constructors

Constructor	Description
AutomationRequest()
AutomationRequest(URI about)

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)
static ResourceShape	createResourceShape()
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)
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 Detail

AutomationRequest

public AutomationRequest()

AutomationRequest

public AutomationRequest(URI about)

Method Detail

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 IAutomationRequest

addCreator

public void addCreator(Link creator)

Specified by:

addCreator in interface IAutomationRequest

addType

public void addType(Link type)

Specified by:

addType in interface IAutomationRequest

addInstanceShape

public void addInstanceShape(Link instanceShape)

Specified by:

addInstanceShape in interface IAutomationRequest

addServiceProvider

public void addServiceProvider(Link serviceProvider)

Specified by:

addServiceProvider in interface IAutomationRequest

addState

public void addState(Link state)

Specified by:

addState in interface IAutomationRequest

addInputParameter

public void addInputParameter(Link inputParameter)

Specified by:

addInputParameter in interface IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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 IAutomationRequest

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

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

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

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

Specified by:

getExecutesAutomationPlan in interface IAutomationRequest

setContributor

public void setContributor(Set<Link> contributor)

Specified by:

setContributor in interface IAutomationRequest

setCreated

public void setCreated(Date created)

Specified by:

setCreated in interface IAutomationRequest

setCreator

public void setCreator(Set<Link> creator)

Specified by:

setCreator in interface IAutomationRequest

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface IAutomationRequest

setIdentifier

public void setIdentifier(String identifier)

Specified by:

setIdentifier in interface IAutomationRequest

setModified

public void setModified(Date modified)

Specified by:

setModified in interface IAutomationRequest

setType

public void setType(Set<Link> type)

Specified by:

setType in interface IAutomationRequest

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface IAutomationRequest

setInstanceShape

public void setInstanceShape(Set<Link> instanceShape)

Specified by:

setInstanceShape in interface IAutomationRequest

setServiceProvider

public void setServiceProvider(Set<Link> serviceProvider)

Specified by:

setServiceProvider in interface IAutomationRequest

setState

public void setState(Set<Link> state)

Specified by:

setState in interface IAutomationRequest

setDesiredState

public void setDesiredState(Link desiredState)

Specified by:

setDesiredState in interface IAutomationRequest

setInputParameter

public void setInputParameter(Set<Link> inputParameter)

Specified by:

setInputParameter in interface IAutomationRequest

setExecutesAutomationPlan

public void setExecutesAutomationPlan(Link executesAutomationPlan)

Specified by:

setExecutesAutomationPlan in interface IAutomationRequest