Module org.cruk.clarity.api

Package org.cruk.clarity.api

package org.cruk.clarity.api

The main public package of the Clarity API.

The main Spring configuration file for the API is in this package as clarity-client-context.xml.

Related Packages

Package	Description
org.cruk.clarity.api.automation	Tools to help move steps through Clarity using the API that allows processes to be run as if they are done through the browser, rather than the ExecutableProcess mechanism.
org.cruk.clarity.api.cache	Package supporting caching of Clarity entities in memory (or, if so configured, on disk) to reduce the amount of traffic being sent to and from the REST API.
org.cruk.clarity.api.debugging	Aspects and beans to aid with tracking the exchanges with the Clarity API for debugging purposes.
org.cruk.clarity.api.http	Classes specific to the REST template operation.
org.cruk.clarity.api.impl	Concrete implementation classes of the Clarity API.
org.cruk.clarity.api.jaxb	Classes to aid the JAXB object mapping process.

Class	Description
ClarityAPI	Interface to the Clarity API version 2 via REST.
ClarityException	Exception decoded when a response from an API call gives an exception object.
ClarityUpdateException	Exception thrown when an attempt is made to change an object that cannot be altered in such a manner through the Clarity API.
IllegalSearchTermException	Exception raised when a search for entities is provided with search terms that are illegal.
InvalidURIException	Exception raised when a URI or URL object is created from a string but the string isn't a valid URI or URL.
StatefulOverride	Enumeration of the ways to override the normal behaviour of the API and the cache to get specific versions of stateful entities.