com.levelonelabs.aimbot.modules
Class ScheduleModule

java.lang.Object
  com.levelonelabs.aimbot.BotModule
      com.levelonelabs.aimbot.modules.ScheduleModule

All Implemented Interfaces:

XMLizable

public class ScheduleModule

extends BotModule

implements XMLizable

A class to handle scheduling commands to happen at certain times

Author:

Steve Zingelewicz

Field Summary

Fields inherited from class com.levelonelabs.aimbot.BotModule

bot

Constructor Summary

ScheduleModule(AIMBot bot)
Constructor for the ReminderModule object

Method Summary

void	addEvent(AIMBuddy buddy, java.util.Date eventDate, java.lang.String command) Add a reminder for a buddy
void	addEvent(AIMBuddy buddy, long period, java.lang.String command) Add a reminder for a buddy
void	clearEvents(AIMBuddy buddy) clear reminders for a buddy
java.lang.String	getName() Gets the name attribute of the SchedulerModule object
java.util.ArrayList	getServices() Gets the services attribute of the SchedulerModule object
java.lang.String	help() Describes the usage of the module
void	performService(AIMBuddy buddy, java.lang.String query) Handle a messaging query
void	readState(org.w3c.dom.Element fullStateElement) Read info from the Element
boolean	removeEvent(AIMBuddy buddy, int i) Remove Specific Reminder
boolean	retrieveEvents(AIMBuddy buddy) Grabs and sends any stored reminders for a buddy
void	writeState(org.w3c.dom.Element emptyStateElement) Write current into the Element

Methods inherited from class com.levelonelabs.aimbot.BotModule

addAIMListener, addBuddies, addBuddy, denyBuddy, getBuddy, getBuddyNames, getPermitMode, permitBuddy, removeBuddies, removeBuddy, sendMessage, sendWarning, setAvailable, setPermitMode, setUnavailable

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleModule

public ScheduleModule(AIMBot bot)

Constructor for the ReminderModule object

Parameters:

bot -

Method Detail

getName

public java.lang.String getName()

Gets the name attribute of the SchedulerModule object

Specified by:

getName in class BotModule

Returns:

The name value

getServices

public java.util.ArrayList getServices()

Gets the services attribute of the SchedulerModule object

Specified by:

getServices in class BotModule

Returns:

The services value

help

public java.lang.String help()

Describes the usage of the module

Specified by:

help in class BotModule

Returns:

the usage of the module

retrieveEvents

public boolean retrieveEvents(AIMBuddy buddy)

Grabs and sends any stored reminders for a buddy

Parameters:

buddy -

Returns:

whether any messages where found

performService

public void performService(AIMBuddy buddy,
                           java.lang.String query)

Handle a messaging query

Specified by:

performService in class BotModule

Parameters:

buddy -

query -

removeEvent

public boolean removeEvent(AIMBuddy buddy,
                           int i)

Remove Specific Reminder

Parameters:

buddy - buddy

i - list item number

Returns:

true if remove took place

clearEvents

public void clearEvents(AIMBuddy buddy)

clear reminders for a buddy

Parameters:

buddy - buddy

addEvent

public void addEvent(AIMBuddy buddy,
                     long period,
                     java.lang.String command)

Add a reminder for a buddy

Parameters:

buddy - buddy

period - Delay for timer

addEvent

public void addEvent(AIMBuddy buddy,
                     java.util.Date eventDate,
                     java.lang.String command)

Add a reminder for a buddy

Parameters:

buddy - buddy

eventDate - Date of scheduled event

writeState

public void writeState(org.w3c.dom.Element emptyStateElement)

Description copied from interface: XMLizable

Write current into the Element

Specified by:

writeState in interface XMLizable

Parameters:

emptyStateElement - DOM element to write to

See Also:

XMLizable.writeState(Element)

readState

public void readState(org.w3c.dom.Element fullStateElement)

Description copied from interface: XMLizable

Read info from the Element

Specified by:

readState in interface XMLizable

Parameters:

fullStateElement - DOM element to read from

See Also:

XMLizable.readState(Element)