edu.wisc.trace.urcsdk.base
Interface IUISocketElement

All Superinterfaces:

java.lang.Cloneable

All Known Subinterfaces:

IUISocketElement, IUISocketElement

All Known Implementing Classes:

AbstractUISocketElement, AbstractUISocketElement, BasicCommand, BooleanConstant, BooleanConstant, BooleanVariable, BooleanVariable, DateConstant, DateConstant, DateTimeConstant, DateTimeConstant, DateTimeVariable, DateTimeVariable, DateVariable, DateVariable, DayConstant, DayConstant, DayVariable, DayVariable, DecimalConstant, DecimalConstant, DecimalVariable, DecimalVariable, DurationConstant, DurationConstant, DurationVariable, DurationVariable, IntegerConstant, IntegerConstant, IntegerVariable, IntegerVariable, ListConstant, ListConstant, ListVariable, ListVariable, MonthConstant, MonthConstant, MonthDayConstant, MonthDayConstant, MonthDayVariable, MonthDayVariable, MonthVariable, MonthVariable, NumberConstant, NumberConstant, NumberVariable, NumberVariable, StringConstant, StringConstant, StringVariable, StringVariable, TimeConstant, TimeConstant, TimedCommand, TimeVariable, TimeVariable, UISocketCommand, UISocketCommand, UISocketConstant, UISocketConstant, UISocketNotification, UISocketNotification, UISocketTimedCommand, UISocketVariable, UISocketVariable, VoidCommand, YearConstant, YearConstant, YearMonthConstant, YearMonthConstant, YearMonthVariable, YearMonthVariable, YearVariable, YearVariable

public interface IUISocketElement
extends java.lang.Cloneable

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:

Hemanth Vijayan

Method Summary

java.lang.Object	clone() Returnes a copy of the object
java.lang.String	getId() Returns the Id of the UISocketElement
java.lang.String	getType() Returns the type of this element.
java.lang.Object	getValue() Returns the current value of this element.
boolean	isWritable() Returns true if this element is writable.
void	parse(org.w3c.dom.Element rootElement) Parses the given element for the data required to create a UISocketElement
java.lang.String	toString() Returns a String representation of this object.

Method Detail

clone

java.lang.Object clone()

Returnes a copy of the object

Returns:

an Object value

getId

java.lang.String getId()

Returns the Id of the UISocketElement

Returns:

a String value

getType

java.lang.String getType()

Returns the type of this element.

Returns:

a String value

getValue

java.lang.Object getValue()

Returns the current value of this element.

Returns:

an Object value

isWritable

boolean isWritable()

Returns true if this element is writable.

Returns:

a boolean value

parse

void parse(org.w3c.dom.Element rootElement)
           throws UrcException

Parses the given element for the data required to create a UISocketElement

Parameters:

rootElement - the Element object to parse

Throws:

UrcException - if an error occurs

toString

java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a String value