edu.wisc.trace.urcsdk.client.uisocket.types
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. Created on: Aug 27, 2004

Version:

$Revision: 1.21 $

Author:

Andrew Martin, Trace R&D Center

Method Summary

void	checkDependencies() checkDependencies checks to see whether a write is accepted based on XPath.
IResource	getAccessKey(UserPreferences prefs) getAccessKey returns an access key for the socket element.
java.util.Set<IUISocketElement>	getDependents() getDependents gets all the dependents of this socket element
IResource	getHelp() getHelp returns a help item for the socket element
IInteractor	getInteractor() getInteractor returns the current IInteractor for this element.
java.util.List<java.lang.String>	getKeywords(UserPreferences prefs) getKeywords
IResource	getLabel() getLabel returns the label associated with the socket element
ElementRef	getRef() getRef returns the ref of the socket element
IResource	getResource(java.lang.String name) getResource
boolean	getSecret() getSecret returns true if socket element is secret
ClientSession	getSession() getSession gets the current Session
UISocketMirror	getSocket() getSocket returns the socket element's UISocket
SocketDependency	getSocketDependency() getSocketDependency gets the current SocketDependency for this element.
XSDSimpleType	getXSDSimpleType() getXSDSimpleType returns the simpleType associated with a variable, if any
boolean	isExecutable() Returns true if the element's value is executable
boolean	isReadable() isReadable returns true if the element's value can be read
void	registerDependent(IUISocketElement e) registerDependent registers another socket element as having an XPath dependency on this one.
void	registerSupport(IUISocketElement se)
void	setInteractor(IInteractor interactor) setInteractor sets the IInteractor for this element.
void	setListener(ISocketElementListener socketElementListener) setListener set the SocketElementListener for this element.
void	setParent(UISocketDocument parent) setParent sets which UISocketDocument this element is part of.
void	setSession(ClientSession session) setSession sets the Session for this socket element.
void	setSocket(UISocketMirror socket) setSocket sets which UISocket this socket element is part of.
void	setValue(java.lang.String value) setValue sets the value of the element
boolean	setValueRequest(java.lang.String value) setValueRequest is called by the Urc to request a change to the socket element.
void	setXSDSimpleType(XSDSimpleType simpleType) Adds xsd:simpleType information to base types for XSD support
void	updateValue() updateValue updates the value of the socket element

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

clone, getId, getType, getValue, isWritable, parse, toString

Method Detail

getAccessKey

IResource getAccessKey(UserPreferences prefs)

getAccessKey returns an access key for the socket element.

Returns:

an IResource value

getHelp

IResource getHelp()

getHelp returns a help item for the socket element

Returns:

an IResource value

getKeywords

java.util.List<java.lang.String> getKeywords(UserPreferences prefs)

getKeywords

Returns:

a List value

getLabel

IResource getLabel()

getLabel returns the label associated with the socket element

Returns:

an IResource value

getRef

ElementRef getRef()

getRef returns the ref of the socket element

Returns:

a String value

getResource

IResource getResource(java.lang.String name)

getResource

Parameters:

name - a String value

Returns:

an IResource value

getSocket

UISocketMirror getSocket()

getSocket returns the socket element's UISocket

Returns:

an UISocket value

updateValue

void updateValue()
                 throws UrcException

updateValue updates the value of the socket element

Throws:

UrcException

isReadable

boolean isReadable()

isReadable returns true if the element's value can be read

Returns:

a boolean value

setValue

void setValue(java.lang.String value)

setValue sets the value of the element

Parameters:

value -

isExecutable

boolean isExecutable()

Returns true if the element's value is executable

Returns:

a boolean value

setParent

void setParent(UISocketDocument parent)

setParent sets which UISocketDocument this element is part of.

Parameters:

parent - an UISocketDocument value

setSocket

void setSocket(UISocketMirror socket)

setSocket sets which UISocket this socket element is part of.

Parameters:

socket - an UISocket value

setValueRequest

boolean setValueRequest(java.lang.String value)
                        throws UrcException

setValueRequest is called by the Urc to request a change to the socket element.

Parameters:

value - a String value

Returns:

a boolean value

Throws:

UrcException

setListener

void setListener(ISocketElementListener socketElementListener)

setListener set the SocketElementListener for this element.

Parameters:

socketElementListener -

setInteractor

void setInteractor(IInteractor interactor)

setInteractor sets the IInteractor for this element.

Parameters:

interactor -

getInteractor

IInteractor getInteractor()

getInteractor returns the current IInteractor for this element.

Returns:

the IInteractor for this element

getSocketDependency

SocketDependency getSocketDependency()

getSocketDependency gets the current SocketDependency for this element.

Returns:

the SocketDependency for the element

registerDependent

void registerDependent(IUISocketElement e)

registerDependent registers another socket element as having an XPath dependency on this one.

Parameters:

e -

registerSupport

void registerSupport(IUISocketElement se)

Parameters:

se -

checkDependencies

void checkDependencies()

checkDependencies checks to see whether a write is accepted based on XPath.

setSession

void setSession(ClientSession session)

setSession sets the Session for this socket element.

Parameters:

session -

getDependents

java.util.Set<IUISocketElement> getDependents()

getDependents gets all the dependents of this socket element

Returns:

a Set of of all of the dependents of this socket element

getSession

ClientSession getSession()

getSession gets the current Session

Returns:

a ClientSession object

getSecret

boolean getSecret()

getSecret returns true if socket element is secret

Returns:

true if the socket element is secret

setXSDSimpleType

void setXSDSimpleType(XSDSimpleType simpleType)

Adds xsd:simpleType information to base types for XSD support

getXSDSimpleType

XSDSimpleType getXSDSimpleType()

getXSDSimpleType returns the simpleType associated with a variable, if any

Returns:

the XSDSimpleType associtated with the variable