Verastream Transaction Integrator 4.0
A B C D 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.
addTaskListener(ITaskListener) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Adds a new task listener to this bean.

B

BaseTaskBean - Class in com.attachmate.transaction.runtime.common.taskbean
Implements the ITask interface and is to be used as the super class for all generated task beans.
BaseTaskBean() - Constructor for class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Zero-arg constructor for use with scripting engines and other containers
BaseTxBean - Class in com.attachmate.transaction.runtime.common.taskbean
 
BaseTxBean() - Constructor for class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Default no argument constructor

C

cancel() - Method in interface com.attachmate.connectors.IConnectorAccess
If execute() was successful, then cancel will attempt to terminate the client operation.
cancel() - Method in interface com.attachmate.tasks.ITask
Cancels the currently executing client operation and fires a task status change event with a TASK_CANCELED completion status.
cancel() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Cancels the currently executing client operation.
clearContext() - Method in interface com.attachmate.tasks.ITask
Removes a context from a bean.
clearContext() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: this product does not currently participate in Context management as described in the documentation for ITask.
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
 
com.attachmate.transaction.runtime.common.taskbean - package com.attachmate.transaction.runtime.common.taskbean
 
com.attachmate.transaction.runtime.common.util - package com.attachmate.transaction.runtime.common.util
 
copyContext(ITask) - Method in interface com.attachmate.tasks.ITask
Copies a context from one bean to another.
copyContext(ITask) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: this product does not currently participate in Context management as described in the documentation for ITask.

D

DataToolKit - Class in com.attachmate.transaction.runtime.common.util
Utility class for conversion of data from Java variables to host COBOL variable memory representation, and vice-versa.
DataToolKit() - Constructor for class com.attachmate.transaction.runtime.common.util.DataToolKit
Constructor for DataToolKit.
DataToolKit(int) - Constructor for class com.attachmate.transaction.runtime.common.util.DataToolKit
Constructor for DataToolKit, with option to override default host code page
doExecute() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
 

E

execute(String, String) - Method in interface com.attachmate.connectors.IConnectorAccess
Execute the client operation identified by the taskID using the specified inputs.
executeAsync() - Method in interface com.attachmate.tasks.ITask
Asynchronously executes the client operation using the current property settings.
executeAsync() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Asynchronously executes the client operation using the current property settings.
executeSync() - Method in interface com.attachmate.tasks.ITask
Synchronously executes the client operation using the current property settings.
executeSync() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Synchronously executes the client operation 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.
getBLOB() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns a copy of the entire content of the host-supplied transaction response bytes currently held in the Program Output Area
getBLOB(int) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns a copy of a specified portion of the host-supplied transaction response bytes in the Program Output Area.
getBLOB(int, int) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns a copy of a specified portion of the host-supplied transaction response bytes in the Program Output Area.
getCurrentContentLength() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Return the number of bytes of transaction data currently contained in the current Program I/O Area (Input Area if bean is in INPUT mode, Output Area if bean is currently in OUTPUT mode).
getData() - Method in interface com.attachmate.connectors.IConnectorAccess
If execute() was successful, then getData returns XML containing the retrieved data.
getDecimalPointIsComma() - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns current setting to use a comma as a decimal point in numeric data.
getDoubleFromHostBytes(String, byte[]) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the double value obtained by decoding the input bytes, which represent a host memory image of a COBOL field defined with the input pictureDescription.
getException() - Method in class com.attachmate.tasks.TaskStatusChangeEvent
Optional event information.
getFloatFromHostBytes(String, byte[]) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the float value obtained by decoding the input bytes, which represent a host memory image of a COBOL field defined with the input pictureDescription.
getHostBytesFromDouble(double, String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns a byte array containing the host memory representation of a COBOL field defined according to the supplied COBOL PICTURE specification, and containing the value represented by the input double variable.
getHostBytesFromFloat(float, String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns a byte array containing the host memory representation of a COBOL field defined according to the supplied COBOL PICTURE specification, and containing the value represented by the input floating point variable.
getHostBytesFromInt(int, String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns a byte array containing the host memory representation of a COBOL field defined according to the supplied COBOL PICTURE specification, and containing the value represented by the input int variable.
getHostBytesFromLong(long, String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns a byte array containing the host memory representation of a COBOL field defined according to the supplied COBOL PICTURE specification, and containing the value represented by the input long variable.
getHostBytesFromShort(short, String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns a byte array containing the host memory representation of a COBOL field defined according to the supplied COBOL PICTURE specification, and containing the value represented by the input short variable.
getHostBytesFromString(String, String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns a byte array containing the host memory representation of a COBOL field defined according to the supplied COBOL PICTURE specification, and containing the value represented by the input client codepage String variable.
getHostCodePage() - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the codepage value set for host-formatted representations.
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.
getInstanceName() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: This property is only passed through - this product does not currently act upon the supplied value.
getIntFromHostBytes(String, byte[]) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the int value obtained by decoding the input bytes, which represent a host memory image of a COBOL field defined with the input pictureDescription.
getJobName() - Method in interface com.attachmate.tasks.ITask
Retrieves user-defined job name, such as a JSP web path.
getJobName() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: This property is only passed through - this product does not currently act upon the supplied value.
getLocale() - Method in interface com.attachmate.tasks.ITask
Retrieves the locale property for the current instance of this bean.
getLocale() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: The Locale property is only passed through - this product does not currently act upon the supplied value.
getLongFromHostBytes(String, byte[]) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the long value obtained by decoding the input bytes, which represent a host memory image of a COBOL field defined with the input pictureDescription.
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 client operation.
getPreserveContext() - Method in interface com.attachmate.tasks.ITask
Retrieves the current preserve context mode.
getPreserveContext() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: this product does not currently participate in Context management as described in the documentation for ITask.
getResourceName() - Method in interface com.attachmate.tasks.ITask
Retrieves the name of the resource configuration in use by this bean
getResourceName() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Retrieves the name of the resource configuration in use by this bean Note: This property is only passed through - this product does not currently act upon the supplied value.
getShortFromHostBytes(String, byte[]) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the short value obtained by decoding the input bytes, which represent a host memory image of a COBOL field defined with the input pictureDescription.
getStatus() - Method in interface com.attachmate.tasks.ITask
Returns the current client operation execution status.
getStatus() - Method in class com.attachmate.tasks.TaskStatusChangeEvent
Task completion status
getStatus() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Returns the current client operation execution status.
getStringFromHostBytes(String, byte[]) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Returns the String value obtained by decoding the input bytes, which represent a host memory image of a COBOL field defined with the input pictureDescription.
getTaskPassword() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns the current value of the Password that will be sent to the host for execution of the transaction when the client operation is executed.
getTaskRACFGroup() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns the value of the RACF Group that will be sent to the host for execution of the transaction when the client operation is executed.
getTaskUserID() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns the value of the UserID that will be sent to the host for execution of the transaction when the client operation is executed.
getTimeOut() - Method in interface com.attachmate.connectors.IConnectorAccess
Returns the timeOut property.
getTimeout() - Method in interface com.attachmate.tasks.ITask
Retrieves the current client operation timeout in milliseconds.
getTimeout() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Retrieves the current client operation timeout in milliseconds.
getTransaction() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: this product does not currently support Transaction management
getTransactionCode() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Returns the Program Name specified during client operation definition that is to be used to invoke the target transaction when the client operation is executed.
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.
getVersion() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Retrieves the version of the Attachmate tool used to generate this bean.

I

IConnectorAccess - Interface in com.attachmate.connectors
This interface is an alternate means to communication with the Transaction Integrator.
ITask - Interface in com.attachmate.tasks
Contains method definitions to be implemented by all Task Beans.
ITaskListener - Interface in com.attachmate.tasks
Task listener interface.

M

MODE_INPUT - Static variable in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Constant value to specify target of setBLOB(begin, end, bytes[], mode) as the Program Input Area, and switch Task bean mode to Input
MODE_OUTPUT - Static variable in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Constant value to specify target of setBLOB(begin, end, bytes[], mode) as the Program Output Area, and switch Task bean mode to Output

O

open(String) - Method in interface com.attachmate.connectors.IConnectorAccess
Note: this method is no longer required, and performs no action.

P

parseOneCopybookLine(String) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
 
PRESERVE_ALWAYS - Static variable in interface com.attachmate.tasks.ITask
Always preserve context after client operation execution
PRESERVE_NEVER - Static variable in interface com.attachmate.tasks.ITask
Do not preserve context after client operation execution (default)
PRESERVE_ON_ERROR - Static variable in interface com.attachmate.tasks.ITask
Preserve context on client operation execution errors only

R

removeTaskListener(ITaskListener) - Method in interface com.attachmate.tasks.ITask
Removes the specified task listener from this bean.
removeTaskListener(ITaskListener) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Removes the specified task listener from this bean.
reset() - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Clear instance properties of this task bean, and reset the bean state to INPUT mode for reuse in execution of another client operation.
ResourceInUseException - Exception in com.attachmate.tasks
Exception thrown when a method on the task bean cannot be executed because the resource context is in use.
ResourceInUseException() - Constructor for exception com.attachmate.tasks.ResourceInUseException
Constructs an exception with no detail message.
ResourceInUseException(String) - Constructor for exception com.attachmate.tasks.ResourceInUseException
Constructs an exception with the specified detail message.

S

setBLOB(byte[]) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Populate a portion of the Program Input Area with host-ready binary data.
setBLOB(int, byte[]) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Populate a portion of the Program Input Area with host-ready binary data.
setBLOB(int, int, byte[]) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Populate a portion of the Program Input Area with host-ready binary data.
setBLOB(int, int, byte[], String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Populate a portion of the Program Input or Output Area with host-ready binary data.
setDecimalPointIsComma(boolean) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Select whether to use a comma as a decimal point in numeric data.
setHostCodePage(int) - Method in class com.attachmate.transaction.runtime.common.util.DataToolKit
Sets the codepage to be used for host-formatted representations.
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.
setInstanceName(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: This property is only passed through - this product does not currently act upon the supplied value.
setJobName(String) - Method in interface com.attachmate.tasks.ITask
Sets a user-defined job name, such as a JSP web path.
setJobName(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: This property is only passed through - this product does not currently act upon the supplied value.
setLocale(Locale) - Method in interface com.attachmate.tasks.ITask
Sets the locale property for the current instance of this bean.
setLocale(Locale) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: This property is only passed through - this product does not currently act upon the supplied value.
setMaxSize(int) - Method in interface com.attachmate.connectors.IConnectorAccess
Sets the maxSize property.
setNumberDecimalFormat(Locale) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
 
setPreserveContext(int) - Method in interface com.attachmate.tasks.ITask
Sets the preserve context mode.
setPreserveContext(int) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: this product does not currently participate in Context management as described in the documentation for ITask.
setRemoteServer(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: This product does not currently act upon the supplied server value.
setResourceName(String) - Method in interface com.attachmate.tasks.ITask
Sets the name of the resource to use with this bean.
setResourceName(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Sets the name of the resource to use with this bean.
setTaskPassword(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Defines the value of the Password that will be sent to the host for execution of the transaction when the client operation is executed.
setTaskRACFGroup(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
 
setTaskUserID(String) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTxBean
Defines the value of the UserID that will be sent to the host for execution of the transaction when the client operation is executed.
setTimeOut(int) - Method in interface com.attachmate.connectors.IConnectorAccess
Sets the timeOut property.
setTimeout(long) - Method in interface com.attachmate.tasks.ITask
Sets the client operation timeout in milliseconds.
setTimeout(long) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Sets the client operation timeout in milliseconds.

T

TASK_CANCELED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating client operation execution was canceled by the user.
TASK_CREATED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating client operation 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 client operation execution.
TASK_STARTED - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating client operation started.
TASK_SUCCESSFUL - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating successful completion of the client operation execution.
TASK_TIMEOUT - Static variable in class com.attachmate.tasks.TaskStatusChangeEvent
Task status constant indicating client operation execution could not complete within the specified timeout.
TaskException - Exception in com.attachmate.tasks
Base class for all task bean exceptions.
TaskException() - Constructor for exception com.attachmate.tasks.TaskException
Constructs an exception with no detail message.
TaskException(String) - Constructor for exception com.attachmate.tasks.TaskException
Constructs an exception with the specified detail message.
taskStatusChange(TaskStatusChangeEvent) - Method in interface com.attachmate.tasks.ITaskListener
Notification of a change in client operation status.
TaskStatusChangeEvent - Class in com.attachmate.tasks
This class represents an event fired by a task bean when the status of the 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.
transferContext(ITask) - Method in interface com.attachmate.tasks.ITask
Transfers a context from one bean to another.
transferContext(ITask) - Method in class com.attachmate.transaction.runtime.common.taskbean.BaseTaskBean
Note: this product does not currently participate in Context management as described in the documentation for ITask.

U

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

A B C D E G I M O P R S T U
Verastream Transaction Integrator 4.0