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.
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.

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 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.

For example, the Compass CqRecord interface defines the PropertyNames HAS_DUPLICATES, FIELDS_UPDATED_THIS_SET_VALUE, and ALL_FIELD_VALUES. Corresponding to these, it defines the methods getHasDuplicates, getFieldsUpdatedThisSetValue, and getAllFieldValues.

The API uses the following naming convention for PropertyNames fields and the corresponding get and set methods for the property value. For a given PropertyName XXXXX_YYY_ZZZZZ (for example, DISPLAY_NAME):

The get method for the property is getXxxxxYyyZzzzz (for example, getDisplayName or getComment).
The set method for the property is setXxxxxYyyZzzzz (for example, setDisplayName or setComment).

For example:

String  DisplayName =  my_resource.getDisplayName();
String  DisplayFields =  my_resource.getComment();

If a set method is not defined, the property cannot be set directly with the HCL Compass CM API.

You can also get and set property values with the getProperty and setProperty methods.

getXxxxxYyyZzzzz() is equivalent to getProperty(XXXXX_YYY_ZZZZZ). For example, getDisplayName is equivalent to getProperty(DISPLAY_NAME).
setXxxxxYyyZzzzz(val) is equivalent to setProperty(XXXXX_YYY_ZZZZZ, val). For example, setDisplayName(val) is equivalent to setProperty(DISPLAY_NAME, val)

See Additional information about properties for more information.