au.edu.swin.synergy.plugin.syndicate
Class BSyndCmdLine

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.syndicate.BSyndCmdLine

public class BSyndCmdLine

extends BPlugin

This class provides the command line tools to run syndicate. To load type: load au.edu.swin.synergy.plugin.syndicate.BSyndCmdLine

Inner Class Summary

class	BSyndCmdLine.BAddLogCL This class is used for adding worklog entries.
class	BSyndCmdLine.BAddTaskCL This class is used for adding tasks.
class	BSyndCmdLine.BGetTasksCL This class is used for listing tasks.
class	BSyndCmdLine.BMainSyndicateCL This class is used for dispatching syndicate commands to all other command line things.
class	BSyndCmdLine.BSyndicateCL This class is provided to give a common root for all syndicate command line classes.
class	BSyndCmdLine.BSyndRefreshCL This class is used for restarting the server and/or refreshing the server information.

Field Summary

static String

kMainCmdName

Fields inherited from class au.edu.swin.synergy.kernel.BPlugin

kernel

Constructor Summary

BSyndCmdLine()
Creates a new BSyndCmdLine object.

Method Summary

protected int	doAddLog(BSyndAddLogCE addLogCE, BStringList params, PrintStream out) This parses the command line for adding worlogs, and prints errors, etc.
protected int	doAddTask(BSyndAddTaskCE addTaskCE, BStringList params, PrintStream out) This parses the command line for adding tasks, and prints errors, etc.
protected int	doGetTask(BSyndGetTasksCE getTaskCE, BStringList params, PrintStream out) This parses the command line for getting tasks, and prints errors, etc.
void	onBCommandEvent(Object sender, BCommandEvent event) This method receives events from the kernel.
void	setup(BStringList params) This method is called when the kernel is loading the plugins

Methods inherited from class au.edu.swin.synergy.kernel.BPlugin

dispatchEvent, dispatchEventAndWait, dispatchEventServer, dispatchEventServerAndWait, dispatchEventTo, dispatchEventToAndWait, getDependancies, getKernel, setKernel, setup, unload

Methods inherited from class java.lang.Object

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

Field Detail

kMainCmdName

public static final String kMainCmdName

Constructor Detail

BSyndCmdLine

public BSyndCmdLine()

Creates a new BSyndCmdLine object.

Method Detail

setup

public void setup(BStringList params)

This method is called when the kernel is loading the plugins

Overrides:

setup in class BPlugin

onBCommandEvent

public void onBCommandEvent(Object sender,
                            BCommandEvent event)

This method receives events from the kernel.

Parameters:

sender - The object that generated the event.

event - The event itself.

Overrides:

onBCommandEvent in class BPlugin

doGetTask

protected int doGetTask(BSyndGetTasksCE getTaskCE,
                        BStringList params,
                        PrintStream out)

This parses the command line for getting tasks, and prints errors, etc.

Parameters:

getTaskCE - The event to be dispatched.

params - The list of parameters.

out - The stream for output.

Returns:

The return status of the command, 0 = fine.

doAddLog

protected int doAddLog(BSyndAddLogCE addLogCE,
                       BStringList params,
                       PrintStream out)

This parses the command line for adding worlogs, and prints errors, etc.

Parameters:

addLogCE - The event to be dispatched.

params - The list of parameters.

out - The stream for output.

Returns:

The return status of the command, 0 = fine.

doAddTask

protected int doAddTask(BSyndAddTaskCE addTaskCE,
                        BStringList params,
                        PrintStream out)

This parses the command line for adding tasks, and prints errors, etc.

Parameters:

addTaskCE - The event to be dispatched.

params - The list of parameters.

out - The stream for output.

Returns:

The return status of the command, 0 = fine.