edu.utexas.its.eis.tools.qwicap.servlet
Class BlockingDescription

java.lang.Object
  extended by edu.utexas.its.eis.tools.qwicap.servlet.BlockingDescription
Direct Known Subclasses:
PromptDescription, RedirectDescription

public abstract class BlockingDescription
extends Object

Describes a Qwicap blocking operation. This base class provides basic identifying information (the type of the operation). Operation-specific information is provided by methods in operation-specific subclasses. A "prompt" operation (getOperation() returns BlockingOperation.PROMPT) is described by the subclass PromptDescription. A "redirect" operation (getOperation() returns BlockingOperation.REDIRECT) is described by the subclass RedirectDescription.

Author:
Chris W. Johnson

Method Summary
 Qwicap getCurrentInstance()
          Returns a reference to the instance of Qwicap that is blocking or unblocking.
 BlockingOperation getOperation()
          Returns an BlockingOperation object that identifies the operation which caused blocking to occur.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getCurrentInstance

public Qwicap getCurrentInstance()
Returns a reference to the instance of Qwicap that is blocking or unblocking.

Returns:
A reference to the instance of Qwicap that is blocking or unblocking.

getOperation

public BlockingOperation getOperation()
Returns an BlockingOperation object that identifies the operation which caused blocking to occur.

Returns:
The kind of operation which caused blocking to occur.