Documentation Overview

Documentation for the Rational® ClearCase® Automation Library consists of conceptual material, diagrams, examples, as well as reference pages for each interface.

Diagrams

Two types of diagrams are included: association diagrams and inheritance diagrams. Association diagrams are in the Diagrams folder. An Inheritance diagram for each interface is included on the interface's reference page. The main inheritance diagram is in the Diagrams folder.

Association diagrams (created in IBM Rational Rose) show the relationships among CAL objects. For example, from these diagrams, you can tell what types of objects you can lock, which objects can have metadata applied to them, and how to create a version.

You can click an interface name in any diagram to jump to that interface reference page.

Examples

The Examples page provides links to all of the code examples for CAL. In addition, each interface reference page links to examples that demonstrate the more common as well as some of the trickier operations.

Reference pages

In addition to providing an inheritance diagram and examples for the interface, each interface reference page describes the properties and methods for that interface, and includes both Visual Basic and Visual C++ syntax and descriptions of the parameters. The Creation section lists the interfaces and properties that can produce the object that is represented by the interface.


Feedback