ProgressObject

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi.status
Interface ProgressObject

All Known Implementing Classes:: ProgressObjectImpl (src)

public interface ProgressObject

Tracks the progress of a deployment

Method Summary
`void`	`addProgressListener(ProgressListener (src) listener)` Add a progress listener
`void`	`cancel()` Cancels the deployment
`ClientConfiguration (src)`	`getClientConfiguration(TargetModuleID (src) id)` Return the client configuration associated with the module
`DeploymentStatus (src)`	`getDeploymentStatus()` Retrieve the status of the deployment
`TargetModuleID (src) []`	`getResultTargetModuleIDs()` Retrieve the resulting target module ids
`boolean`	`isCancelSupported()` Is cancel supported
`boolean`	`isStopSupported()` Is stop supported
`void`	`removeProgressListener(ProgressListener (src) listener)` Remove a progress listener
`void`	`stop()` Stops the deployment

Method Detail

getDeploymentStatus

public DeploymentStatus (src)  getDeploymentStatus()

Retrieve the status of the deployment

Returns:: the status

getResultTargetModuleIDs

public TargetModuleID (src) [] getResultTargetModuleIDs()

Retrieve the resulting target module ids

Returns:: the module ids

getClientConfiguration

public ClientConfiguration (src)  getClientConfiguration(TargetModuleID (src)  id)

Return the client configuration associated with the module

Parameters:: id - the module id
Returns:: the client configuration or null if none exists

isCancelSupported

public boolean isCancelSupported()

Is cancel supported

Returns:: true when cancel is supported, false otherwise

cancel

public void cancel()
            throws OperationUnsupportedException (src)

Cancels the deployment

Throws:: OperationUnsupportedException (src) - when cancel is not supported

isStopSupported

public boolean isStopSupported()

Is stop supported

Returns:: true when stop is supported, false otherwise

stop

public void stop()
          throws OperationUnsupportedException (src)

Stops the deployment

Throws:: OperationUnsupportedException (src) - when stop is not supported

addProgressListener

public void addProgressListener(ProgressListener (src)  listener)

Add a progress listener

Parameters:: listener - the listener

removeProgressListener

public void removeProgressListener(ProgressListener (src)  listener)

Remove a progress listener

Parameters:: listener - the listener