edu.wisc.trace.urcsdk.target.uisocket
Interface IUISocketElement

All Superinterfaces:

java.lang.Cloneable, IUISocketElement

public interface IUISocketElement
extends java.lang.Cloneable, IUISocketElement

IUISocketElement is the interface used for creating UI Socket Elements. All socket element implementations must derive from this class to be compliant.

Version:

1.0

Author:

Parikshit Thakur

Method Summary

java.lang.String	getRef() Returns the Ref of this element.
UISocket	getSocket() Returns the UISocket object associated with this element.
UISocketDocument	getSocketDocument() Returns the parent UISocketDocument of this element
java.lang.String	getType() Returns the type of this element.
boolean	internalSetValue(java.lang.Object value) Sets this element's current value
void	setSession(TargetSession session) Sets the TargetSession for this element
void	setSocket(UISocket socket) Sets the UISocket associated with this element.
void	setSocketDocument(UISocketDocument socketDocument) Sets the UISocketDocument associated with this element.
boolean	setValue(java.lang.Object value) Sets this element's current value and triggers an update

Methods inherited from interface edu.wisc.trace.urcsdk.base.IUISocketElement

clone, getId, getValue, isWritable, parse, toString

Method Detail

getSocketDocument

UISocketDocument getSocketDocument()

Returns the parent UISocketDocument of this element

Returns:

an UISocketDocument value

getSocket

UISocket getSocket()

Returns the UISocket object associated with this element.

Returns:

an UISocket value

getType

java.lang.String getType()

Returns the type of this element.

Specified by:

getType in interface IUISocketElement

Returns:

a String value

getRef

java.lang.String getRef()

Returns the Ref of this element.

Returns:

a String value

setValue

boolean setValue(java.lang.Object value)
                 throws UrcException

Sets this element's current value and triggers an update

Parameters:

value - the new value

Returns:

returns true if successful

Throws:

UrcException

setSocketDocument

void setSocketDocument(UISocketDocument socketDocument)

Sets the UISocketDocument associated with this element.

Parameters:

socketDocument - the new UISocketDocument object

setSocket

void setSocket(UISocket socket)

Sets the UISocket associated with this element.

Parameters:

socket - the new UISocket object

internalSetValue

boolean internalSetValue(java.lang.Object value)
                         throws UrcException

Sets this element's current value

Parameters:

value - the new value

Returns:

returns true if successful

Throws:

UrcException

setSession

void setSession(TargetSession session)

Sets the TargetSession for this element

Parameters:

session -