AccCommand

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.aol.acc
Class AccCommand

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

public class AccCommand
extends AccBase
extends AccBase

The IAccCommand interface is for getting information about plugin commands.

Method Summary
`void`	`exec(AccVariant names)` Executes the command on the specified users or groups.
`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 names)` Indicates whether this command could be executed on specified users or groups.
`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 names)
                    throws AccException

Indicates whether this command could be executed on specified users
or groups. If an error is returned, or "enabled" is false, the command
would not be allowed, so it should be disabled in the user interface. If
AccCommandFlags_GroupUi is set, "names" should contain group names;
otherwise, it should contain user names.

Throws:: AccException

exec

public void exec(AccVariant names)
          throws AccException

Executes the command on the specified users or groups. If
AccCommandFlags_GroupUi is set, "names" should contain
group names; otherwise, it should contain user names.

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