ProgressObject (JBoss J2EE API) - JBoss 4.0.1 sp1 j2ee API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi.status
Interface ProgressObject

public interface ProgressObject

Tracks the progress of a deployment

Version:: $Revision: 1.1 $
Author:: Adrian Brock

Method Summary

void addProgressListener(ProgressListener listener)
          Add a progress listener

void cancel()
          Cancels the deployment

ClientConfiguration getClientConfiguration(TargetModuleID id)
          Return the client configuration associated with the module

DeploymentStatus getDeploymentStatus()
          Retrieve the status of the deployment

TargetModuleID[] getResultTargetModuleIDs()
          Retrieve the resulting target module ids

boolean isCancelSupported()
          Is cancel supported

boolean isStopSupported()
          Is stop supported

void removeProgressListener(ProgressListener listener)
          Remove a progress listener

void stop()
          Stops the deployment

Method Detail

getDeploymentStatus

public DeploymentStatus getDeploymentStatus()

Retrieve the status of the deployment

Returns:: the status

getResultTargetModuleIDs

public TargetModuleID[] getResultTargetModuleIDs()

Retrieve the resulting target module ids

Returns:: the module ids

getClientConfiguration

public ClientConfiguration getClientConfiguration(TargetModuleID 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

Cancels the deployment

Throws:: OperationUnsupportedException - 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

Stops the deployment

Throws:: OperationUnsupportedException - when stop is not supported

addProgressListener

public void addProgressListener(ProgressListener listener)

Add a progress listener

Parameters:: listener - the listener

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Remove a progress listener

Parameters:: listener - the listener