upnp.device.model
Class BrisaAction

java.lang.Object
  upnp.device.model.BrisaAction

public class BrisaAction
extends java.lang.Object

class Brisa::BrisaAction brisaaction.h BrisaUpnp/BrisaAction \brief Template method class that represents each service's action. If any of the returned output arguments is not defined in the service description file, BrisaAction will show an error message at the debug output stream and send an error message to the control point.

Author:

wendell

Constructor Summary

BrisaAction()

BrisaAction(java.lang.String name)

BrisaAction(java.lang.String name, BrisaService service)

Method Summary

void	addArgument(BrisaArgument argument) Adds given \a argument to this action's list of arguments.
void	addArgument(java.lang.String name, java.lang.String direction, java.lang.String relatedStateVariable) Adds an argument with given \a name, \a direction and \a relatedStateVariable to this action's list of arguments.
void	addArguments(java.util.ArrayList<BrisaArgument> arguments) Adds given list of \a arguments to this action's list of arguments.
boolean	call(BrisaArgument inArguments, BrisaArgument outArguments)
void	clearArgumentList() Clears this action's argument list.
java.util.ArrayList<BrisaArgument>	getArgumentList() Returns this action's list of arguments.
BrisaArgument	getInArgument(java.lang.String name) Returns the related input argument with the given \a name.
java.lang.reflect.Method	getMethod() !
java.lang.String	getName()
BrisaArgument	getOutArgument(java.lang.String name) Returns the related output argument with the given \a name.
BrisaService	getService()
BrisaStateVariable	getStateVariable(java.lang.String name) Returns the related service's state variable with the given \a name.
boolean	removeArgument(BrisaArgument argument) Remove given \a argument from this action's list of arguments.
void	setArgumentList(java.util.ArrayList<BrisaArgument> argumentList)
void	setMethod(java.lang.reflect.Method method, BrisaService service) Sets the method to be invoked when the action is executed.
void	setName(java.lang.String name)
void	setService(BrisaService service)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrisaAction

public BrisaAction(java.lang.String name,
                   BrisaService service)

BrisaAction

public BrisaAction(java.lang.String name)

BrisaAction

public BrisaAction()

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getService

public BrisaService getService()

setService

public void setService(BrisaService service)

setArgumentList

public void setArgumentList(java.util.ArrayList<BrisaArgument> argumentList)

getArgumentList

public java.util.ArrayList<BrisaArgument> getArgumentList()

Returns this action's list of arguments.

addArgument

public void addArgument(java.lang.String name,
                        java.lang.String direction,
                        java.lang.String relatedStateVariable)

Adds an argument with given \a name, \a direction and \a relatedStateVariable to this action's list of arguments.

addArgument

public void addArgument(BrisaArgument argument)

Adds given \a argument to this action's list of arguments.

addArguments

public void addArguments(java.util.ArrayList<BrisaArgument> arguments)

Adds given list of \a arguments to this action's list of arguments.

clearArgumentList

public void clearArgumentList()

Clears this action's argument list.

removeArgument

public boolean removeArgument(BrisaArgument argument)

Remove given \a argument from this action's list of arguments.

call

public boolean call(BrisaArgument inArguments,
                    BrisaArgument outArguments)

getStateVariable

public BrisaStateVariable getStateVariable(java.lang.String name)

Returns the related service's state variable with the given \a name. If it cannot find its related service or the state variable, then it returns a null pointer.

setMethod

public void setMethod(java.lang.reflect.Method method,
                      BrisaService service)

Sets the method to be invoked when the action is executed.

getMethod

public java.lang.reflect.Method getMethod()

! Returns the method to be invoked when the action is executed.

getInArgument

public BrisaArgument getInArgument(java.lang.String name)

Returns the related input argument with the given \a name.

getOutArgument

public BrisaArgument getOutArgument(java.lang.String name)

Returns the related output argument with the given \a name.