public interface

IClarizen

com.clarizen.api.IClarizen

Class Overview

Contains the operations exposed by the Clarizen web service This class was generated by Apache CXF 2.5.1 2013-05-29T11:28:27.889-03:00 Generated source version: 2.5.1

Summary

Public Methods
abstract ArrayOfResult execute(ArrayOfBaseMessage request)
Perform operations against the Clarizen web services
abstract LoginResult login(String userName, String password, LoginOptions opts)
Logs in to the Clarizen API server and starts a session
abstract void logout()
Terminates an active web services session
abstract Result metadata(MetadataMessage request)
Executes a Metadata request.
abstract QueryResult query(Query queryExpression)
Executes a Query request.

Public Methods

public abstract ArrayOfResult execute (ArrayOfBaseMessage request)

Perform operations against the Clarizen web services

Parameters
request An array of requests derived from
Returns
  • An array of corresponsding to each request. You must cast each result to the specific instance that corresponds to the request parameter. See the remarks section for more information
Throws
IClarizenExecuteSessionTimeoutFailureFaultFaultMessage

public abstract LoginResult login (String userName, String password, LoginOptions opts)

Logs in to the Clarizen API server and starts a session

Parameters
userName Login user name
password Login password
opts
Returns
  • a with the new session Id
Throws
IClarizenLoginLoginFailureFaultFaultMessage

public abstract void logout ()

Terminates an active web services session

public abstract Result metadata (MetadataMessage request)

Executes a Metadata request. This is the same as sending a to the method

Parameters
request A Metadata request
Returns
  • Returns an instance of a . You must cast this to the specific instance corresponding to the request parameter.
Throws
IClarizenMetadataSessionTimeoutFailureFaultFaultMessage

public abstract QueryResult query (Query queryExpression)

Executes a Query request. This is the same as sending a Query message to the method.

Parameters
queryExpression The query to execute
Returns
  • A instance.
Throws
IClarizenQuerySessionTimeoutFailureFaultFaultMessage