oslc.cm.ChangeRequest

Change request resource for OSLC change management domain

Since R2021a

Description

The oslc.cm.ChangeRequest object represents change request resources in the change management domain of the Open Services for Lifecycle Collaboration (OSLC) service provider. After creating and configuring oslc.Client and oslc.core.QueryCapability objects, query the service provider for available change request resources by using the queryChangeRequests function.

Creation

Create an oslc.cm.ChangeRequest object by using the createChangeRequest function.

Properties

ResourceUrl — Resource navigation URL

character array

Navigation URL for the change request resource, specified as a character array.

Dirty — Uncommitted changes indicator

0 | 1

Indicator for uncommitted changes to the change request resource, specified as a logical 1or 0 where:

• 1 indicates the change request resource has uncommitted changes.

• 0 indicates the change request resource has no uncommitted changes.

Data Types: logical

IsFetched — Resource fetch status

0 | 1

Change request resource fetch status, specified as a logical 1 or 0 where:

• 1 indicates the change request resource is fetched.

• 0 indicates the change request resource is not fetched.

Data Types: logical

Title — Change request title

character array

Change request title, specified as a character array.

Identifier — Change request resource identifier

character array

OSLC change request resource identifier, specified as a character array.

Object Functions

addResourceProperty	Add resource property to local OSLC resource object
addTextProperty	Add text property to local OSLC resource object
commit	Send local changes to OSLC service provider
fetch	Retrieve full resource data from OSLC service provider
getProperty	Get local contents of text property from OSLC resource object
getRDF	Get resource RDF/XML data from OSLC resource object
getResourceProperty	Get local contents of resource property from OSLC resource object
remove	Remove resource from OSLC service provider
removeResourceProperty	Remove resource property from local OSLC resource object
setProperty	Set local contents of text property for OSLC resource object
setRDF	Set RDF content for local OSLC resource object
setResourceProperty	Set local contents of resource property from OSLC resource object
setResourceUrl	Set resource URL for local OSLC resource object
show	View OSLC resource in system browser

Examples

Edit a Change Request and Commit Changes

This example shows how to submit a query request for change request resources with a configured OSLC client, edit an existing change request resource, and commit the changes to the service provider.

After you have created and configured the OSLC client myClient as described in Create and Configure an OSLC Client for the Change Management Domain, create a query capability for the change request resource type.

myQueryCapability = getQueryService(myClient,'ChangeRequest');

Submit a query request to the service provider for the available change request resources.

changeRequests = queryChangeRequests(myQueryCapability)

changeRequests = 

  1×6 ChangeRequest array with properties:

    ResourceUrl
    Dirty
    IsFetched
    Title
    Identifier

Assign a change request resource to the variable myCR. Retrieve the full resource data from the service provider for the change request resource. Examine the Title property.

myCR = changeRequests(1);
status = fetch(myCR,myClient)

status = 

  StatusCode enumeration

    OK

title = myCR.Title

title =

    'Change Request 1'

Edit the change request title and commit the change to the service provider.

myCR.Title = 'My New Change Request Title';
status = commit(myCR,myClient)

status = 

  StatusCode enumeration

    OK

Open the change request resource in the system browser by using the show function.

show(myChangeRequest)

Create a New Change Request

This example shows how to submit a creation request for a new change request resource with a configured OSLC client.

After you have created and configured the OSLC client myClient as described in Create and Configure an OSLC Client for the Change Management Domain, create a creation factory for the change request resource type.

myCreationFactory = getCreationFactory(myClient,'ChangeRequest');

Use the creation factory to create a new change request resource with the title My New Change Request. Retrieve the full resource data from the service provider for the change request resource and inspect the resource.

newCR = createChangeRequest(myCreationFactory,'My New Change Request');
fetch(newCR,myClient);
newCR

newCR = 

  ChangeRequest with properties:

    ResourceUrl: 'https://localhost:9443/ccm/resource/itemName/...'
          Dirty: 0
      IsFetched: 1
          Title: 'My New Change Request'
     Identifier: '204'

Open the change request resource in the system browser by using the show function.

show(newCR)

Version History

Introduced in R2021a