|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.felix.upnp.sample.clock.GetTimeAction
public class GetTimeAction
Constructor Summary | |
---|---|
GetTimeAction(TimeStateVariable time)
|
Method Summary | |
---|---|
String[] |
getInputArgumentNames()
Lists all input arguments for this action. |
String |
getName()
Returns the action name. |
String[] |
getOutputArgumentNames()
List all output arguments for this action. |
String |
getReturnArgumentName()
Returns the name of the designated return argument. |
UPnPStateVariable |
getStateVariable(String argumentName)
Finds the state variable associated with an argument name. |
Dictionary |
invoke(Dictionary args)
Invokes the action. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetTimeAction(TimeStateVariable time)
Method Detail |
---|
public String getName()
UPnPAction
name
field in the
actionList
of the service description.
X_
nor A_
.X_
.
getName
in interface UPnPAction
public String getReturnArgumentName()
UPnPAction
One of the output arguments can be flagged as a designated return argument.
getReturnArgumentName
in interface UPnPAction
null
if
none is marked.public String[] getInputArgumentNames()
UPnPAction
Each action may have zero or more input arguments.
getInputArgumentNames
in interface UPnPAction
null
if no input
arguments.UPnPStateVariable
public String[] getOutputArgumentNames()
UPnPAction
getOutputArgumentNames
in interface UPnPAction
null
if there are no
output arguments.UPnPStateVariable
public UPnPStateVariable getStateVariable(String argumentName)
UPnPAction
getStateVariable
in interface UPnPAction
argumentName
- The name of the UPnP action argument.
null
if there is no such argument.UPnPStateVariable
public Dictionary invoke(Dictionary args) throws Exception
UPnPAction
Dictionary
objects. Each entry in the Dictionary
object has a
String
object as key representing the argument name and the
value is the argument itself. The class of an argument value must be
assignable from the class of the associated UPnP state variable.
The input argument Dictionary
object must contain exactly
those arguments listed by getInputArguments
method. The output
argument Dictionary
object will contain exactly those
arguments listed by getOutputArguments
method.
invoke
in interface UPnPAction
args
- A Dictionary
of arguments. Must contain the correct set and
type of arguments for this action. May be null
if no
input arguments exist.
Dictionary
with the output arguments.
null
if the action has no output arguments.
UPnPException
- A UPnP error has occured.
Exception
- The execution fails for some reason.UPnPStateVariable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |