org.cybergarage.upnp
Class StateVariable

java.lang.Object
  extended by org.cybergarage.upnp.xml.NodeData
      extended by org.cybergarage.upnp.StateVariable

public class StateVariable
extends NodeData


Field Summary
static String ELEM_NAME
           
 
Constructor Summary
StateVariable()
           
StateVariable(Node serviceNode, Node stateVarNode)
           
 
Method Summary
 AllowedValueList getAllowedValueList()
           
 AllowedValueRange getAllowedValueRange()
           
 String getDataType()
           
 String getDefaultValue()
          Get the value of DefaultValue of this StateVariable
 String getName()
           
 QueryListener getQueryListener()
           
 QueryResponse getQueryResponse()
           
 UPnPStatus getQueryStatus()
           
 Service getService()
           
 Node getServiceNode()
           
 StateVariableData getStateVariableData()
           
 Node getStateVariableNode()
           
 UPnPStatus getStatus()
           
 Object getUserData()
           
 String getValue()
           
 boolean hasAllowedValueList()
           
 boolean hasAllowedValueRange()
           
 boolean isSendEvents()
           
static boolean isStateVariableNode(Node node)
           
 boolean performQueryListener(QueryRequest queryReq)
           
 boolean postQuerylAction()
           
 void set(StateVariable stateVar)
           
 void setAllowedValueList(AllowedValueList avl)
          This method ovverride the value of the AllowedValueList Node
of this object.
 void setAllowedValueRange(AllowedValueRange avr)
          This method ovverride the value of the AllowedValueRange Node
of this object.
 void setDataType(String value)
           
 void setDefaultValue(String value)
          This method ovverride the value of the DefaultValue of this object.
 void setName(String value)
           
 void setQueryListener(QueryListener listener)
           
 void setSendEvents(boolean state)
           
 void setStatus(int code)
           
 void setStatus(int code, String descr)
           
 void setUserData(Object data)
           
 void setValue(int value)
           
 void setValue(long value)
           
 void setValue(String value)
           
 
Methods inherited from class org.cybergarage.upnp.xml.NodeData
getNode, setNode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEM_NAME

public static final String ELEM_NAME
See Also:
Constant Field Values
Constructor Detail

StateVariable

public StateVariable()

StateVariable

public StateVariable(Node serviceNode,
                     Node stateVarNode)
Method Detail

getServiceNode

public Node getServiceNode()

getService

public Service getService()

getStateVariableNode

public Node getStateVariableNode()

isStateVariableNode

public static boolean isStateVariableNode(Node node)

setName

public void setName(String value)

getName

public String getName()

setDataType

public void setDataType(String value)

getDataType

public String getDataType()

setSendEvents

public void setSendEvents(boolean state)

isSendEvents

public boolean isSendEvents()

set

public void set(StateVariable stateVar)

getStateVariableData

public StateVariableData getStateVariableData()

setValue

public void setValue(String value)

setValue

public void setValue(int value)

setValue

public void setValue(long value)

getValue

public String getValue()

getAllowedValueList

public AllowedValueList getAllowedValueList()

setAllowedValueList

public void setAllowedValueList(AllowedValueList avl)
This method ovverride the value of the AllowedValueList Node
of this object.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.
Note2: The enforce the constraint of the SCPD rule the
AllowedValueList and AllowedValueRange are mutal exclusive
the last set will be the only present

Parameters:
avl - The new AllowedValueList

hasAllowedValueList

public boolean hasAllowedValueList()

getAllowedValueRange

public AllowedValueRange getAllowedValueRange()

setAllowedValueRange

public void setAllowedValueRange(AllowedValueRange avr)
This method ovverride the value of the AllowedValueRange Node
of this object.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.
Note2: The enforce the constraint of the SCPD rule the
AllowedValueList and AllowedValueRange are mutal exclusive
the last set will be the only present

Parameters:
avr - The new AllowedValueRange

hasAllowedValueRange

public boolean hasAllowedValueRange()

getQueryListener

public QueryListener getQueryListener()

setQueryListener

public void setQueryListener(QueryListener listener)

performQueryListener

public boolean performQueryListener(QueryRequest queryReq)

getQueryResponse

public QueryResponse getQueryResponse()

getQueryStatus

public UPnPStatus getQueryStatus()

postQuerylAction

public boolean postQuerylAction()

setStatus

public void setStatus(int code,
                      String descr)

setStatus

public void setStatus(int code)

getStatus

public UPnPStatus getStatus()

getDefaultValue

public String getDefaultValue()
Get the value of DefaultValue of this StateVariable


setDefaultValue

public void setDefaultValue(String value)
This method ovverride the value of the DefaultValue of this object.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.

Parameters:
value - The new String value

setUserData

public void setUserData(Object data)

getUserData

public Object getUserData()


Copyright © 2008 DomoWare. All Rights Reserved.