com.aol.acc
Class AccCommand

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccCommand

public class AccCommand
extends AccBase

The IAccCommand interface is for enumerating commands on a plugin.


Method Summary
 void exec(AccVariant usernames)
          Executes the command on the specified users.

 int getFlags()
          The flags for the Command, from AccCommandFlags
 int getId()
          Gets command id.

 int getParentId()
          Associated in UI with its parent command (e.g., in a submenu).
 java.lang.String getSmallIconUrl()
          The URL for an icon to display with the command
 java.lang.String getText()
          The text for the command
 boolean queryStatus(AccVariant usernames)
          Indicates whether this command could be executed on certain user(s).
If an error is returned, or "enabled" is false, the command would
not be allowed, so it should be disabled in the user interface.

 void setFlags(int Flags)
          The flags for the Command, from AccCommandFlags
 void setParentId(int ParentId)
          Associated in UI with its parent command (e.g., in a submenu).
 void setSmallIconUrl(java.lang.String SmallIconUrl)
          The URL for an icon to display with the command
 void setText(java.lang.String Text)
          The text for the command
 
Methods inherited from class com.aol.acc.AccBase
compareHandle, equals
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getId

public int getId()
          throws AccException
Gets command id.

Throws:
AccException

queryStatus

public boolean queryStatus(AccVariant usernames)
                    throws AccException
Indicates whether this command could be executed on certain user(s).
If an error is returned, or "enabled" is false, the command would
not be allowed, so it should be disabled in the user interface.

Throws:
AccException

exec

public void exec(AccVariant usernames)
          throws AccException
Executes the command on the specified users.

Throws:
AccException

getText

public java.lang.String getText()
                         throws AccException
The text for the command

Throws:
AccException

setText

public void setText(java.lang.String Text)
             throws AccException
The text for the command

Throws:
AccException

getSmallIconUrl

public java.lang.String getSmallIconUrl()
                                 throws AccException
The URL for an icon to display with the command

Throws:
AccException

setSmallIconUrl

public void setSmallIconUrl(java.lang.String SmallIconUrl)
                     throws AccException
The URL for an icon to display with the command

Throws:
AccException

getFlags

public int getFlags()
             throws AccException
The flags for the Command, from AccCommandFlags

Throws:
AccException

setFlags

public void setFlags(int Flags)
              throws AccException
The flags for the Command, from AccCommandFlags

Throws:
AccException

getParentId

public int getParentId()
                throws AccException
Associated in UI with its parent command (e.g., in a submenu).

Throws:
AccException

setParentId

public void setParentId(int ParentId)
                 throws AccException
Associated in UI with its parent command (e.g., in a submenu).

Throws:
AccException