Home
Extending product function
Learn how to extend the product.
Programming with HCL Compass CM API
HCL Compass CM API object model overview
The HCL Compass CM API common object model maps HCL Compass objects to a resource proxy hierarchy, based on the WVCM proxy and property model. This common data model enables API client applications to retrieve data, through one set of interfaces, as API resources.
Resources and proxies
The HCL Compass CM API comprises proxy objects for the persistent resources that are stored in the HCL Compass repositories.
Naming conventions
Each interface derived from the Resource interface has a well-defined set of properties than can be examined and modified by the HCL Compass CM API. Each interface also has a well-defined set of operations that can be invoked on the proxy to effect the underlying resource. Proxy methods whose names begin with get, set, and do perform specific operations.

Extending product function
Learn how to extend the product.
- HCL Compass REST API developer guide
- Programming with the HCL Compass OSLC CM REST API
  Learn how to use Compass CM REST API that supports both, OSLC v1 and v2.
- Programming with HCL Compass CM API
  - HCL Compass CM API introduction
    The HCL Compass CM API is a unified Java™ API through that you can access HCL Compass.
  - HCL Compass CM API object model overview
    The HCL Compass CM API common object model maps HCL Compass objects to a resource proxy hierarchy, based on the WVCM proxy and property model. This common data model enables API client applications to retrieve data, through one set of interfaces, as API resources.
    - Resources and proxies
      The HCL Compass CM API comprises proxy objects for the persistent resources that are stored in the HCL Compass repositories.
      - Naming conventions
        Each interface derived from the Resource interface has a well-defined set of properties than can be examined and modified by the HCL Compass CM API. Each interface also has a well-defined set of operations that can be invoked on the proxy to effect the underlying resource. Proxy methods whose names begin with get, set, and do perform specific operations.
        Naming convention for get and set property value methods
        For each resource type, the HCL Compass CM API provides specific methods to get and possibly set the values of properties defined by the interface.
      - Getting a provider
        A client must get a Provider object before it can get resource proxies and access resources.
      - Getting resource proxies
        The Provider class builds proxies in response to client requests. The client can then invoke methods on the proxy to work with the represented resource.
      - Resources
        A resource is a named collection of properties that exists in a repository.
    - Location objects
      Each resource has a location that uniquely identifies it to the server.
    - Properties and meta-properties
      Resources have properties. Each property has a name, a type, and a value; it might have other meta-properties associated with it (such as its value, size, or an indication of its validity).
    - Collections
      Several HCL Compass CM API methods return collections of resources.
    - Change contexts and context resources
      A change context is a workspace or container for editing context resources which are nonversioned resources, such as records and queries.
    - Exceptions
      All problems are reported by means of an exception object, which is a subclass of the exception object defined by WVCM.
  - Class overviews
    The Javadoc information that is included with the HCL Compass CM API provides an overview section that includes descriptions of the available classes. Each class represents a major collection of operations supported by the API.
  - Configuring HCL Compass CM API logging
    You can configure HCL Compass CM API logging.

Naming conventions

Each interface derived from the Resource interface has a well-defined set of properties than can be examined and modified by the HCL Compass CM API. Each interface also has a well-defined set of operations that can be invoked on the proxy to effect the underlying resource. Proxy methods whose names begin with get, set, and do perform specific operations.

Any proxy method whose name begins with:

get returns a property value from the proxy object for a product resource.
set specifies values in an existing proxy object but do not update the product resource.
do is an operation that requires a Provider to connect to a server and access the product repository that contains the resource.

Methods that get and set properties do not interact with the resource. The set methods store their argument values in the proxy and the get methods retrieve property values stored in the proxy. Values are read from a repository by using a do method such as Resource.doReadProperties() and are written to a repository by using a do method such as doWriteProperties().

The do methods cause the API Provider to perform operations on the resource and cause an interaction with the server. Many do methods take an optional ProperyRequest or Feedback parameter in which the client can request the properties to be read from the resource when running that method. All do methods write to the resource any property values that have been set in the proxy since the last server interaction.

The name of each interface in each HCL Compass CM API package is unique and includes a prefix that identifies the package that contains it. This makes it easy to read the code, even when not using fully qualified interface names.