com.orchestranetworks.addon.mtrn.context

Class StopContext

java.lang.Object

com.orchestranetworks.addon.mtrn.context.MonitoringContext

com.orchestranetworks.addon.mtrn.context.StopContext

public final class StopContext
extends MonitoringContext

Defines a context to include required information for stopping an operation.

Constructor Summary

Constructors

Constructor and Description
StopContext(com.orchestranetworks.service.Session userSession) Instantiates a new stop context.

Method Summary

Modifier and Type	Method and Description
Date	getLastModificationDate() Returns the last modification date.
ParametersMap	getOutputParameters() Returns the output parameters.
double	getPercentage() Returns the percentage.
StopCause	getStopCause() Returns the reason for stopping the operation.
void	setLastModificationDate(Date lastModificationDate) Sets the last modification date for monitoring.
void	setOutputParameters(ParametersMap outputParameters) Sets the output parameters.
void	setPercentage(double percentage) Sets the completion percentage when stopping the operation.
void	setStopCause(StopCause stopCause) Sets the reason for stopping the operation.

Methods inherited from class com.orchestranetworks.addon.mtrn.context.MonitoringContext

getSession

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StopContext

public StopContext(com.orchestranetworks.service.Session userSession)

Instantiates a new stop context.

Parameters:

userSession - the user session

Method Detail

getStopCause

public StopCause getStopCause()

Returns the reason for stopping the operation.

Returns:

the stop cause

setStopCause

public void setStopCause(StopCause stopCause)

Sets the reason for stopping the operation.

Parameters:

stopCause - the new stop cause

getLastModificationDate

public Date getLastModificationDate()

Returns the last modification date.

Returns:

the last modification date

setLastModificationDate

public void setLastModificationDate(Date lastModificationDate)

Sets the last modification date for monitoring. This date can be retrieved using MonitoringStatus.getLastModificationDate().

Parameters:

lastModificationDate - the new last modification date

getOutputParameters

public ParametersMap getOutputParameters()

Returns the output parameters.

Returns:

the output parameters

setOutputParameters

public void setOutputParameters(ParametersMap outputParameters)

Sets the output parameters.

Parameters:

outputParameters - the new output parameters

getPercentage

public double getPercentage()

Returns the percentage.

Returns:

the percentage

setPercentage

public void setPercentage(double percentage)

Sets the completion percentage when stopping the operation.

The percentage must be a double value greater than zero, otherwise it is not updated.

Parameters:

percentage - the new percentage