ToiOperationManagerOperationInfo Interface Reference

---

Description

This is the documentation for ToiOperationManagerOperationInfo.
Information associated with an operation. Use toi.statics.ToiOperationManagerOperationInfo.create(<id>, <userData>, <state>, <progress>, <errorCode>, <properties>) to create an instance of ToiOperationManagerOperationInfo. The following parameters in the create method are optional: <properties>. For the optional members that have default values, the values are: ; if they are not set from the portal, they will have the default value.

import "ToiOperationManagerOperationInfo.idl";

List of all members.

Public Attributes
attribute ToiOperationManager::TToiOperationId	id
attribute string	userData
attribute ToiOperationManager::TToiOperationState	state
attribute long	progress
attribute ToiOperationManager::TToiOperationError	errorCode
attribute ToiOperationManager::TToiPropertySequence	properties

---

Member Data Documentation

attribute ToiOperationManager::TToiOperationError ToiOperationManagerOperationInfo::errorCode

The error code for the operation, only valid if the state is equal to ToiOperationManager::OPERATION_FAILED. The possible error codes are defined by the service implementation.

attribute ToiOperationManager::TToiOperationId ToiOperationManagerOperationInfo::id

The operation identifier.

attribute long ToiOperationManagerOperationInfo::progress

The current progress value of the operation between 0 and 100, -1 if not used.

attribute ToiOperationManager::TToiPropertySequence ToiOperationManagerOperationInfo::properties

The property sequence associated with current operation state.

attribute ToiOperationManager::TToiOperationState ToiOperationManagerOperationInfo::state

The current state of the operation.

attribute string ToiOperationManagerOperationInfo::userData

The user data associated with the operation.