net.sbbi.upnp.services
Class ServiceAction

java.lang.Object
  net.sbbi.upnp.services.ServiceAction

public class ServiceAction
extends Object

An object to represent a service action proposed by an UPNP service

Version:

1.0

Author:

SuperBonBon

Field Summary

protected String	name
protected UPNPService	parent

Constructor Summary

protected

ServiceAction()

Method Summary

ServiceActionArgument	getActionArgument(String argumentName) Look for an ServiceActionArgument for a given name
List	getActionArguments() The action in and out arguments ServiceActionArgument objects list
ServiceActionArgument	getInputActionArgument(String argumentName) Look for an input ServiceActionArgument for a given name
List	getInputActionArguments() Return a list containing input ( when a response is sent ) arguments objects
List	getInputActionArgumentsNames() Return a list containing input ( when a response is sent ) arguments names
String	getName() The action name
ServiceActionArgument	getOutputActionArgument(String argumentName) Look for an output ServiceActionArgument for a given name
List	getOutputActionArguments() Return a list containing output ( when a response is received ) arguments objects
List	getOutputActionArgumentsNames() Return a list containing output ( when a response is received ) arguments names
UPNPService	getParent()
protected void	setActionArguments(List orderedActionArguments)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

parent

protected UPNPService parent

Constructor Detail

ServiceAction

protected ServiceAction()

Method Detail

getParent

public UPNPService getParent()

getActionArguments

public List getActionArguments()

The action in and out arguments ServiceActionArgument objects list

Returns:

the list with ServiceActionArgument objects or null if the action has no params

getActionArgument

public ServiceActionArgument getActionArgument(String argumentName)

Look for an ServiceActionArgument for a given name

Parameters:

argumentName - the argument name

Returns:

the argument or null if not found or not available

setActionArguments

protected void setActionArguments(List orderedActionArguments)

getInputActionArguments

public List getInputActionArguments()

Return a list containing input ( when a response is sent ) arguments objects

Returns:

a list containing input arguments ServiceActionArgument objects or null when nothing is needed for such operation

getInputActionArgument

public ServiceActionArgument getInputActionArgument(String argumentName)

Look for an input ServiceActionArgument for a given name

Parameters:

argumentName - the input argument name

Returns:

the argument or null if not found or not available

getOutputActionArguments

public List getOutputActionArguments()

Return a list containing output ( when a response is received ) arguments objects

Returns:

a list containing output arguments ServiceActionArgument objects or null when nothing returned for such operation

getOutputActionArgument

public ServiceActionArgument getOutputActionArgument(String argumentName)

Look for an output ServiceActionArgument for a given name

Parameters:

argumentName - the input argument name

Returns:

the argument or null if not found or not available

getInputActionArgumentsNames

public List getInputActionArgumentsNames()

Return a list containing input ( when a response is sent ) arguments names

Returns:

a list containing input arguments names as Strings or null when nothing is needed for such operation

getOutputActionArgumentsNames

public List getOutputActionArgumentsNames()

Return a list containing output ( when a response is received ) arguments names

Returns:

a list containing output arguments names as Strings or null when nothing returned for such operation

getName

public String getName()

The action name

Returns:

The action name