This class has an optional cancel
method. The support of the cancel function can
be tested by the isCancelSupported method.
The ProgressObject structure allows the user the option of polling for status or to provide a callback.
| Modifier and Type | Method and Description |
|---|---|
| public void | addProgressListener(ProgressListener
the listener to receive events pol)Add a listener to receive Progress events on deployment actions. |
| public void | cancel()
(optional) A cancel request on an in-process operation stops all further processing of the operation and returns the environment to it original state before the operation was executed. |
| public ClientConfiguration | Returns: ClientConfiguration for a given TargetModuleID or null if none exists.Return the ClientConfiguration object associated with the TargetModuleID. |
| public DeploymentStatus | Returns: An object containing the status information.Retrieve the status of this activity. |
| public TargetModuleID[] | Returns: a list of TargetModuleIDs.Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation. |
| public boolean | Returns: true if canceling an
activity is supported by this platform.Tests whether the vendor supports a cancel opertation for deployment activities. |
| public boolean | Returns: true if canceling an
activity is supported by this platform.Tests whether the vendor supports a stop opertation for deployment activities. |
| public void | removeProgressListener(ProgressListener
the listener being removed pol)Remove a ProgressObject listener. |
| public void | stop()
(optional) A stop request on an in-process operation allows the operation on the current TargetModuleID to run to completion but does not process any of the remaining unprocessed TargetModuleID objects. |
| addProgressListener | back to summary |
|---|---|
| public void addProgressListener(ProgressListener pol) Add a listener to receive Progress events on deployment actions.
| |
| cancel | back to summary |
|---|---|
| public void cancel() throws OperationUnsupportedException (optional) A cancel request on an in-process operation stops all further processing of the operation and returns the environment to it original state before the operation was executed. An operation that has run to completion cannot be cancelled.
| |
| getClientConfiguration | back to summary |
|---|---|
| public ClientConfiguration getClientConfiguration(TargetModuleID id) Return the ClientConfiguration object associated with the TargetModuleID.
| |
| getDeploymentStatus | back to summary |
|---|---|
| public DeploymentStatus getDeploymentStatus() Retrieve the status of this activity.
| |
| getResultTargetModuleIDs | back to summary |
|---|---|
| public TargetModuleID[] getResultTargetModuleIDs() Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.
| |
| isCancelSupported | back to summary |
|---|---|
| public boolean isCancelSupported() Tests whether the vendor supports a cancel opertation for deployment activities.
| |
| isStopSupported | back to summary |
|---|---|
| public boolean isStopSupported() Tests whether the vendor supports a stop opertation for deployment activities.
| |
| removeProgressListener | back to summary |
|---|---|
| public void removeProgressListener(ProgressListener pol) Remove a ProgressObject listener.
| |
| stop | back to summary |
|---|---|
| public void stop() throws OperationUnsupportedException (optional) A stop request on an in-process operation allows the operation on the current TargetModuleID to run to completion but does not process any of the remaining unprocessed TargetModuleID objects. The processed TargetModuleIDs must be returned by the method getResultTargetModuleIDs.
| |