edu.wisc.trace.urcsdk.client.uisocket.types
Class BasicCommand

java.lang.Object
  edu.wisc.trace.urcsdk.client.uisocket.types.AbstractUISocketElement
      edu.wisc.trace.urcsdk.client.uisocket.types.UISocketCommand
          edu.wisc.trace.urcsdk.client.uisocket.types.BasicCommand

All Implemented Interfaces:

IUISocketElement, java.lang.Cloneable

public class BasicCommand
extends UISocketCommand

BasicCommand is the variant of UISocketCommand that provides four separate states: ready, done, in-progress, and error.

Created on: Apr 28, 2005
Known bugs: None
Thread safe: Yes

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center

Field Summary

Fields inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.AbstractUISocketElement

dependents, id, interactor, listeners, logger, parent, ref, secret, sensitive, session, sessionId, simpleType, socket, socketDependency, supports, timeout, type, value

Constructor Summary

BasicCommand()

BasicCommand(UISocketDocument parent, UISocketMirror socket, org.w3c.dom.Element rootElement)
Creates a new BasicCommand instance with state READY.

BasicCommand(UISocketMirror socket)
Creates a new BasicCommand instance with state READY.

Method Summary

BasicCommand	clone() Describe clone method here.
IInteractor	getInteractor()
java.lang.String	invokeCommandRequest() Attempts to invoke the target command bound to this element.
boolean	isExecutable()
boolean	isReadable()
void	setInteractor(IInteractor interactor)

Methods inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.UISocketCommand

hasSelection, isWritable, parse, validate

Methods inherited from class edu.wisc.trace.urcsdk.client.uisocket.types.AbstractUISocketElement

checkDependencies, checkDependents, getAccessKey, getDependents, getHelp, getId, getKeywords, getLabel, getParent, getRef, getResource, getSecret, getSession, getSocket, getSocketDependency, getSupports, getType, getValue, getXSDSimpleType, registerDependent, registerSupport, setListener, setParent, setSession, setSessionId, setSocket, setValue, setValueRequest, setXSDSimpleType, toString, updateValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicCommand

public BasicCommand(UISocketMirror socket)

Creates a new BasicCommand instance with state READY.

Parameters:

socket - a UISocket object

BasicCommand

public BasicCommand(UISocketDocument parent,
                    UISocketMirror socket,
                    org.w3c.dom.Element rootElement)
             throws UrcException

Creates a new BasicCommand instance with state READY.

Parameters:

parent - a UISocketDocument object.

socket - a UISocket object.

rootElement - a Element object.

Throws:

UrcException - if parse fails.

BasicCommand

public BasicCommand()

Method Detail

isExecutable

public boolean isExecutable()

isReadable

public boolean isReadable()

getInteractor

public IInteractor getInteractor()

Overrides:

getInteractor in class AbstractUISocketElement

setInteractor

public void setInteractor(IInteractor interactor)

Overrides:

setInteractor in class AbstractUISocketElement

clone

public BasicCommand clone()

Describe clone method here.

Specified by:

clone in interface IUISocketElement

Overrides:

clone in class UISocketCommand

Returns:

an BasicCommand value

invokeCommandRequest

public java.lang.String invokeCommandRequest()
                                      throws UrcException

Description copied from class: UISocketCommand

Attempts to invoke the target command bound to this element.

Specified by:

invokeCommandRequest in class UISocketCommand

Returns:

String variable indicating true on success and false on failure.

Throws:

UrcException