org.symphonyoss.client.ai

Class AiCommand

java.lang.Object

org.symphonyoss.client.ai.AiCommand

public class AiCommand
extends java.lang.Object

A model for ai commands. Used to compare input and command, and check for a match.

Constructor Summary

Constructors

Constructor and Description
AiCommand(java.lang.String command, int numArguments, java.lang.String usage)

Method Summary

Modifier and Type	Method and Description
void	addAction(AiAction action)
void	addPermission(AiPermission permission)
java.util.Set<AiAction>	getActions()
java.lang.String	getArguments(int argumentIndex)
java.lang.String	getCommand()
int	getNumArguments()
java.util.Set<AiPermission>	getPermissions()
java.lang.String	getPrefixRequirement(int argumentIndex)
java.util.Set<AiResponseSequence>	getResponses(MlMessageParser mlMessageParser, SymMessage message) Executes all the command's actions.
java.lang.String	getUsage()
boolean	isCommand(java.lang.String[] chunks) Checks to see if the user's input fulfills the ai command requirements
void	removeAction(AiAction action)
void	removePermission(AiPermission permission)
void	resizePrefixesArguments()
void	setActions(java.util.Set<AiAction> actions)
void	setAllArguments(java.lang.String[] placeHolders)
void	setAllPrefixRequirements(java.lang.String[] prefixRequirements)
void	setArgument(int argumentIndex, java.lang.String holder)
void	setCommand(java.lang.String command)
void	setNumArguments(int numArguments)
void	setPermissions(java.util.Set<AiPermission> permissions)
void	setPrefixRequirement(int argumentIndex, java.lang.String requirement)
void	setUsage(java.lang.String usage)
java.lang.String	toMLCommand() Creates a HTML string, that can be used to instruct users how to use this command.
boolean	userIsPermitted(java.lang.Long userID) Determines if a user is allowed to use this command

Methods inherited from class java.lang.Object

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

Constructor Detail

AiCommand

public AiCommand(java.lang.String command,
                 int numArguments,
                 java.lang.String usage)

Method Detail

isCommand

public boolean isCommand(java.lang.String[] chunks)

Checks to see if the user's input fulfills the ai command requirements

Parameters:

chunks - the user's input in text chunks

Returns:

if the user input fulfills the command requirements

toMLCommand

public java.lang.String toMLCommand()

Creates a HTML string, that can be used to instruct users how to use this command.

Returns:

the usage string in HTML

userIsPermitted

public boolean userIsPermitted(java.lang.Long userID)

Determines if a user is allowed to use this command

Parameters:

userID - the user's id

Returns:

if the user is permitted to use this command

getResponses

public java.util.Set<AiResponseSequence> getResponses(MlMessageParser mlMessageParser,
                                                      SymMessage message)

Executes all the command's actions. Receives back all the response sequences from the actions.

Parameters:

mlMessageParser - a parser that contains the input in ML

message - the received message

Returns:

a set of responses, given by completing all the commands actions

resizePrefixesArguments

public void resizePrefixesArguments()

getNumArguments

public int getNumArguments()

setNumArguments

public void setNumArguments(int numArguments)

setPrefixRequirement

public void setPrefixRequirement(int argumentIndex,
                                 java.lang.String requirement)

setAllPrefixRequirements

public void setAllPrefixRequirements(java.lang.String[] prefixRequirements)

getPrefixRequirement

public java.lang.String getPrefixRequirement(int argumentIndex)

setArgument

public void setArgument(int argumentIndex,
                        java.lang.String holder)

setAllArguments

public void setAllArguments(java.lang.String[] placeHolders)

getArguments

public java.lang.String getArguments(int argumentIndex)

getCommand

public java.lang.String getCommand()

setCommand

public void setCommand(java.lang.String command)

getPermissions

public java.util.Set<AiPermission> getPermissions()

setPermissions

public void setPermissions(java.util.Set<AiPermission> permissions)

getActions

public java.util.Set<AiAction> getActions()

setActions

public void setActions(java.util.Set<AiAction> actions)

addPermission

public void addPermission(AiPermission permission)

addAction

public void addAction(AiAction action)

removePermission

public void removePermission(AiPermission permission)

removeAction

public void removeAction(AiAction action)

getUsage

public java.lang.String getUsage()

setUsage

public void setUsage(java.lang.String usage)