Main Content

queryRequirementCollections

Query OSLC service provider for requirement collections

Since R2021a

collapse all in page

    Syntax

    reqCollections = queryRequirementCollections(myQueryCapability)

    Description

    reqCollections = queryRequirementCollections(myQueryCapability) returns the available requirement collection resources in the Open Services for Lifecycle Collaboration (OSLC) service provider that is associated with the query capability myQueryCapability.

    example

    Examples

    collapse all

    This example shows how to submit a query request for requirement collection resources 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 Requirements Management Domain, create a query capability for the requirement collection resource type.

    myQueryCapability = getQueryService(myClient,'RequirementCollection')
    myQueryCapability = 

  QueryCapability with properties:

    queryParameter: ''
            client: [1×1 oslc.Client]
         queryBase: 'https://localhost:9443/rm/views?oslc.query=true&projectURL=http...'
     resourceShape: {0×1 cell}
               dom: [1×1 matlab.io.xml.dom.Element]
             title: 'Query Capability'
      resourceType: {1×2 cell}

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

    reqCollections = queryRequirementCollections(myQueryCapability)
    reqCollections = 

  1×5 RequirementCollection array with properties:

    ResourceUrl
    Dirty
    IsFetched
    Title
    Identifier

    Input Arguments

    collapse all

    OSLC resource query capability, specified as an oslc.core.QueryCapability object.

    Output Arguments

    collapse all

    OSLC requirement collection resource, returned as an oslc.rm.RequirementCollection object.

    Version History

    Introduced in R2021a

    See Also

    | | |