Class Deliverable
java.lang.Object
org.eclipse.lyo.oslc4j.core.model.AbstractResource
com.sodius.oslc.app.jazz.ccm.model.Deliverable
- All Implemented Interfaces:
IExtendedResource,IResource
@OslcNamespace("http://jazz.net/xmlns/prod/jazz/rtc/cm/1.0/")
@OslcResourceShape(title="Deliverable Resource Shape",
describes="http://jazz.net/xmlns/prod/jazz/rtc/cm/1.0/Deliverable")
public class Deliverable
extends AbstractResource
Describes a deliverable.
In order to be GC compatible, OSLC Change Management applications need to implement a mapping between their deliverables and some global configurations.
When a link is created from a change request to a configured resource:
- The right change request Deliverable attribute is identified. It can be deduced from the link type and the
DeliverableTypeit's mapped to. - The right global configuration is identified with the Deliverable's oslc_config:configuration attribute.
- The link is created on the change request. The change request should return it as a
DeliverableLink.
See this article for more information:
https://jazz.net/help-dev/clm/index.jsp?topic=%2Fcom.ibm.team.workitem.doc%2Ftopics%2Fc_linking_to_cm_artifacts.html
- Since:
- 1.8.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the the associated configuration, if any.Returns the description of the deliverable.Returns the identifier of the deliverable.getTitle()voidsetConfiguration(URI configuration) Changes the configuration associated to the deliverable.voidsetConfiguration(Link configuration) Changes the configuration associated to the deliverable.voidsetDescription(String description) Sets the description of the deliverable.voidsetIdentifier(String identifier) Changes the identifier of the deliverable.voidsetInstanceShape(URI instanceShape) voidMethods inherited from class org.eclipse.lyo.oslc4j.core.model.AbstractResource
addType, getAbout, getExtendedProperties, getTypes, setAbout, setExtendedProperties, setTypes
-
Constructor Details
-
Deliverable
public Deliverable()
-
-
Method Details
-
getIdentifier
@OslcDescription("A unique identifier for a resource. Assigned by the service provider when a resource is created. Not intended for end-user display.") @OslcOccurs(ExactlyOne) @OslcPropertyDefinition("http://purl.org/dc/terms/identifier") @OslcReadOnly @OslcTitle("Identifier") public String getIdentifier()Returns the identifier of the deliverable.- Returns:
- the identifier of the deliverable
- Since:
- 4.0.0
-
setIdentifier
Changes the identifier of the deliverable.- Parameters:
identifier- the new identifier of the deliverable- Since:
- 4.0.0
-
getConfiguration
@OslcPropertyDefinition("http://open-services.net/ns/config#configuration") public Link getConfiguration()Returns the the associated configuration, if any.- Returns:
- the associated configuration,
nullif none - Since:
- 4.0.0 (was returning a URI in previous versions)
-
setConfiguration
Changes the configuration associated to the deliverable.- Parameters:
configuration- the new configuration
-
setConfiguration
Changes the configuration associated to the deliverable. It is usually expected to provide only a URI when referencing a configuration, notably when exposing the deliverable to the outside world. Associating a label may be handy when editing the deliverable in an application, for exchanging information between the back-end and the front-end.- Parameters:
configuration- the new configuration- Since:
- 4.0.0
-
getTitle
@OslcDescription("Title (reference: Dublin Core) or often a single line summary of the resource represented as rich text in XHTML content.") @OslcOccurs(ExactlyOne) @OslcPropertyDefinition("http://purl.org/dc/terms/title") @OslcTitle("Title") @OslcValueType(XMLLiteral) public String getTitle() -
setTitle
-
getDescription
@OslcDescription("Descriptive text (reference: Dublin Core) about resource represented as rich text in XHTML content.") @OslcPropertyDefinition("http://purl.org/dc/terms/description") @OslcTitle("Description") @OslcValueType(XMLLiteral) public String getDescription()Returns the description of the deliverable.- Returns:
- the description of the deliverable
- Since:
- 4.0.0
-
setDescription
Sets the description of the deliverable.- Parameters:
description- the new description- Since:
- 4.0.0
-
getInstanceShape
@OslcDescription("Resource Shape that provides hints as to resource property value-types and allowed values. ") @OslcPropertyDefinition("http://open-services.net/ns/core#instanceShape") @OslcRange("http://open-services.net/ns/core#ResourceShape") @OslcTitle("Instance Shape") public URI getInstanceShape() -
setInstanceShape
-