org.qtunes.core
Annotation Type ControlMethod


@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ControlMethod

The ControlMethod annotation marks a method as being publically callable via one of the Controllers (which will call the org.qtunes.control.ControlMethodInvoker to do it's work.


Required Element Summary
 java.lang.String help
          A description of the method
 java.lang.String[] params
          A list of parameter names in the order the method takes them
 
Optional Element Summary
 java.lang.String auth
          The authorization required to run this method.
 

Element Detail

params

public abstract java.lang.String[] params
A list of parameter names in the order the method takes them


help

public abstract java.lang.String help
A description of the method

auth

public abstract java.lang.String auth
The authorization required to run this method. The default is "" which means no session is required. A value of "*" means any valid session will do, and other values like "play" or "edit" will require a Session with that allowance.

Default:
""