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-11-06T15:23:42.243-03:00 Generated source version: 2.5.1

Summary

Public Methods
abstract ArrayOfResult execute(ArrayOfBaseMessage request)
Perform operations against the Clarizen web services @param request An array of requests derived from @return An array of corresponsding to each request.
abstract GetServerDefinitionResult getServerDefinition(String userName, String password, LoginOptions options)
abstract LoginResult login(String userName, String password, LoginOptions options)
Logs in to the Clarizen API server and starts a session @param userName Login user name @param password Login password @param options Additional options such as partnerId and applicationId @return a with the new session Id
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 @param request An array of requests derived from @return 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

Parameters
request
Throws
IClarizenExecuteSessionTimeoutFailureFaultFaultMessage

public abstract GetServerDefinitionResult getServerDefinition (String userName, String password, LoginOptions options)

Parameters
userName
password
options

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

Logs in to the Clarizen API server and starts a session @param userName Login user name @param password Login password @param options Additional options such as partnerId and applicationId @return a with the new session Id

Parameters
userName
password
options
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 @param request a Metadata request @return Returns an instance of a . You must cast this to the specific instance corresponding to the parameter.

Parameters
request
Throws
IClarizenMetadataSessionTimeoutFailureFaultFaultMessage

public abstract QueryResult query (Query queryExpression)

Executes a Query request. This is the same as sending a Query message to the method. @param queryExpression The query to execute @return A instance.

Parameters
queryExpression
Throws
IClarizenQuerySessionTimeoutFailureFaultFaultMessage