Synapta Services Builder for CICS Version 3.0
A C E G I M O P R S T U

A

addTaskListener(ITaskListener) - Method in interface com.attachmate.tasks.ITask
Adds a new task listener to this bean.

C

cancel() - Method in interface com.attachmate.connectors.IConnectorAccess
If execute() was successful, then cancel will attempt to abort the task.
cancel() - Method in interface com.attachmate.tasks.ITask
Cancels the currently executing task and fires a task status change event with a TASK_CANCELED completion status.
clearContext() - Method in interface com.attachmate.tasks.ITask
Removes a context from a bean.
close() - Method in interface com.attachmate.connectors.IConnectorAccess
Releases all resources.
com.attachmate.connectors - package com.attachmate.connectors
 
com.attachmate.tasks - package com.attachmate.tasks
 
copyContext(ITask) - Method in interface com.attachmate.tasks.ITask
Copies a context from one bean to another.

E

execute(String, String) - Method in interface com.attachmate.connectors.IConnectorAccess
Excute the task identified by the taskID using the specified inputs.
executeAsync() - Method in interface com.attachmate.tasks.ITask
Asynchronously executes the task using the current property settings.
executeSync() - Method in interface com.attachmate.tasks.ITask
Synchronously executes the task using the current property settings.

G

getAvailable() - Method in interface com.attachmate.connectors.IConnectorAccess
Returns the amount of data left after a successful call to execute.
getData() - Method in interface com.attachmate.connectors.IConnectorAccess
If execute() was successful, then getData returns XML containing the retrieved data.
getException() - Method in class com.attachmate.tasks.TaskStatusChangeEvent
Optional event information.
getInstanceName() - Method in interface com.attachmate.tasks.ITask
Retrieves a user-defined instance name, such as an identifier for the bean on a web page or other bean container.
getJobName() - Method in interface com.attachmate.tasks.ITask
Retrieves user-defined job name, such as a JSP web path.
getLocale() - Method in interface com.attachmate.tasks.ITask
Retrieves the locale property for the current instance of this bean.
getMaxSize() - Method in interface com.attachmate.connectors.IConnectorAccess
Returns the maxSize property.
getMetaData(String) - Method in interface com.attachmate.connectors.IConnectorAccess
Returns the metadata for the specified task.
getPreserveContext() - Method in interface com.attachmate.tasks.ITask
Retrieves the current preserve context mode.
getResourceName() - Method in interface com.attachmate.tasks.ITask
Retrieves the name of the resource configuration in use by this bean
getStatus() - Method in interface com.attachmate.tasks.ITask
Returns the current task execution status.
getStatus() - Method in class com.attachmate.tasks.TaskStatusChangeEvent
Task completion status
getTimeOut() - Method in interface com.attachmate.connectors.IConnectorAccess
Returns the timeOut property.
getTimeout() - Method in interface com.attachmate.tasks.ITask
Retrieves the current task timeout in milliseconds.
getVersion() - Method in interface com.attachmate.tasks.ITask
Retrieves the version of the user's development environment or other user-specified version information, such as a date code.

I

IConnectorAccess - interface com.attachmate.connectors.IConnectorAccess.
This interface is the primary means of communication with connectors.
ITask - interface com.attachmate.tasks.ITask.
Contains method definitions to be implemented by all Task Beans.
ITaskListener - interface com.attachmate.tasks.ITaskListener.
Task listener interface.

M

m_exception - Variable in class com.attachmate.tasks.TaskStatusChangeEvent
Optional exception object describing the cause of failure.
m_status - Variable in class com.attachmate.tasks.TaskStatusChangeEvent
Status code (from task status constants).

O

open(String) - Method in interface com.attachmate.connectors.IConnectorAccess
Initializes the connector.

P

PRESERVE_ALWAYS - Static variable in interface com.attachmate.tasks.ITask
Always preserve context after task execution
PRESERVE_NEVER - Static variable in interface com.attachmate.tasks.ITask
Do not preserve context after task execution (default)
PRESERVE_ON_ERROR - Static variable in interface com.attachmate.tasks.ITask
Preserve context on task execution errors only

R

ResourceInUseException - exception com.attachmate.tasks.ResourceInUseException.
Exception thrown when a method on the task bean cannot be executed because the resource context is in use.
ResourceInUseException() - Constructor for class com.attachmate.tasks.ResourceInUseException
Constructs an exception with no detail message.
ResourceInUseException(String) - Constructor for class com.attachmate.tasks.ResourceInUseException
Constructs an exception with the specified detail message.
removeTaskListener(ITaskListener) - Method in interface com.attachmate.tasks.ITask
Removes the specified task listener from this bean.

S

setInstanceName(String) - Method in interface com.attachmate.tasks.ITask
Sets a user-defined instance name, such as an identifier for the bean on a web page or other bean container.
setJobName(String) - Method in interface com.attachmate.tasks.ITask
Sets a user-defined job name, such as a JSP web path.
setLocale(Locale) - Method in interface com.attachmate.tasks.ITask
Sets the locale property for the current instance of this bean.
setMaxSize(int) - Method in interface com.attachmate.connectors.IConnectorAccess
Sets the maxSize property.
setPreserveContext(int) - Method in interface com.attachmate.tasks.ITask
Sets the preserve context mode.
setResourceName(String) - Method in interface com.attachmate.tasks.ITask
Sets the name of the resource to use with this bean.
setTimeOut(int) - Method in interface com.attachmate.connectors.IConnectorAccess
Sets the timeOut property.
setTimeout(long) - Method in interface com.attachmate.tasks.ITask
Sets the task timeout in milliseconds.

T

TASK_CANCELED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating task execution was canceled by the user.
TASK_CREATED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating task is created but executeSync or executeAsync has not been called yet.
TASK_FAILED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating unsuccessful completion of the task execution.
TASK_STARTED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating task started.
TASK_SUCCESSFUL - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating successful completion of the task execution.
TASK_TIMEOUT - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating task execution could not complete within the specified timeout.
TaskException - exception com.attachmate.tasks.TaskException.
Base class for all task bean exceptions.
TaskException() - Constructor for class com.attachmate.tasks.TaskException
Constructs an exception with no detail message.
TaskException(String) - Constructor for class com.attachmate.tasks.TaskException
Constructs an exception with the specified detail message.
TaskStatusChangeEvent - class com.attachmate.tasks.TaskStatusChangeEvent.
This class represents an event fired by a task bean when a task bean status changes.
TaskStatusChangeEvent(Object) - Constructor for class com.attachmate.tasks.TaskStatusChangeEvent
Constructs a new TaskStatusChangeEvent using default status information and no exception.
TaskStatusChangeEvent(Object, int) - Constructor for class com.attachmate.tasks.TaskStatusChangeEvent
Constructs a new TaskStatusChangeEvent with status information.
TaskStatusChangeEvent(Object, int, Exception) - Constructor for class com.attachmate.tasks.TaskStatusChangeEvent
Constructs a new TaskStatusChangeEvent with status and exception information.
taskStatusChange(TaskStatusChangeEvent) - Method in interface com.attachmate.tasks.ITaskListener
Notification of a change in task status.
transferContext(ITask) - Method in interface com.attachmate.tasks.ITask
Transfers a context from one bean to another.

U

UnsupportedOperationException - exception com.attachmate.tasks.UnsupportedOperationException.
Exception thrown when an attempt is made to execute a method that is not supported.
UnsupportedOperationException() - Constructor for class com.attachmate.tasks.UnsupportedOperationException
Constructs an exception with no detail message.
UnsupportedOperationException(String) - Constructor for class com.attachmate.tasks.UnsupportedOperationException
Constructs an exception with the specified detail message.

A C E G I M O P R S T U
Synapta Services Builder for CICS Version 3.0