public interface ProgressObject
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 |
---|---|
void |
addProgressListener(ProgressListener pol)
Add a listener to receive Progress events on deployment
actions.
|
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.
|
ClientConfiguration |
getClientConfiguration(TargetModuleID id)
Return the ClientConfiguration object associated with the
TargetModuleID.
|
DeploymentStatus |
getDeploymentStatus()
Retrieve the status of this activity.
|
TargetModuleID[] |
getResultTargetModuleIDs()
Retrieve the list of TargetModuleIDs successfully
processed or created by the associated DeploymentManager
operation.
|
boolean |
isCancelSupported()
Tests whether the vendor supports a cancel
opertation for deployment activities.
|
boolean |
isStopSupported()
Tests whether the vendor supports a stop
opertation for deployment activities.
|
void |
removeProgressListener(ProgressListener pol)
Remove a ProgressObject listener.
|
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.
|
DeploymentStatus getDeploymentStatus()
TargetModuleID[] getResultTargetModuleIDs()
ClientConfiguration getClientConfiguration(TargetModuleID id)
boolean isCancelSupported()
true
if canceling an
activity is supported by this platform.void cancel() throws OperationUnsupportedException
OperationUnsupportedException
- this optional command
is not supported by this implementation.boolean isStopSupported()
true
if canceling an
activity is supported by this platform.void stop() throws OperationUnsupportedException
OperationUnsupportedException
- this optional command
is not supported by this implementation.void addProgressListener(ProgressListener pol)
pol
- the listener to receive eventsProgressEvent
void removeProgressListener(ProgressListener pol)
pol
- the listener being removedProgressEvent
Copyright © 1996-2017, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.