net.sbbi.upnp.services
Class ServiceAction

java.lang.Object
  extended bynet.sbbi.upnp.services.ServiceAction

public class ServiceAction
extends java.lang.Object

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

Version:
1.0
Author:
SuperBonBon

Method Summary
 ServiceActionArgument getActionArgument(java.lang.String argumentName)
          Look for an ServiceActionArgument for a given name
 java.util.List getActionArguments()
          The action in and out arguments ServiceActionArgument objects list
 ServiceActionArgument getInputActionArgument(java.lang.String argumentName)
          Look for an input ServiceActionArgument for a given name
 java.util.List getInputActionArguments()
          Return a list containing input ( when a response is sent ) arguments objects
 java.util.List getInputActionArgumentsNames()
          Return a list containing input ( when a response is sent ) arguments names
 java.lang.String getName()
          The action name
 ServiceActionArgument getOutputActionArgument(java.lang.String argumentName)
          Look for an output ServiceActionArgument for a given name
 java.util.List getOutputActionArguments()
          Return a list containing output ( when a response is received ) arguments objects
 java.util.List getOutputActionArgumentsNames()
          Return a list containing output ( when a response is received ) arguments names
 UPNPService getParent()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getParent

public UPNPService getParent()

getActionArguments

public java.util.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(java.lang.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

getInputActionArguments

public java.util.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(java.lang.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 java.util.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(java.lang.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 java.util.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 java.util.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 java.lang.String getName()
The action name

Returns:
The action name


Copyright © 2005 SuperBonBon Industries. All Rights Reserved.