Package fr.Alphart.BAT.Modules.Comment

Class Comment

java.lang.Object

fr.Alphart.BAT.Modules.Comment.Comment

All Implemented Interfaces:

IModule

public class Comment
extends Object
implements IModule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Comment.CommentConfig

Field Summary

Fields inherited from interface fr.Alphart.BAT.Modules.IModule

ANY_SERVER, GLOBAL_SERVER, NO_REASON, OFF_STATE, ON_STATE

Constructor Summary

Constructors

Constructor	Description
Comment(BAT plugin)

Method Summary

Modifier and Type	Method	Description
String	clearComments(String entity, int commentID)	Clear all the comments and warning of an entity or the specified one
List<BATCommand>	getCommands()	Get commands used by this module
List<CommentEntry>	getComments(String entity)	Get the notes relative to an entity
Comment.CommentConfig	getConfig()	Get the configuration section of this module
String	getMainCommand()	Get main command name
List<CommentEntry>	getManagedComments(String staff)
String	getName()
void	insertComment(String entity, String comment, CommentEntry.Type type, String author)
boolean	load()	Load the module
boolean	unload()	Unload the module

Methods inherited from class java.lang.Object

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

Constructor Details

Comment

public Comment(BAT plugin)

Method Details

getCommands

public List<BATCommand> getCommands()

Description copied from interface: IModule

Get commands used by this module

Specified by:

getCommands in interface IModule

Returns:

list of commands

getName

public String getName()

Specified by:

getName in interface IModule

getMainCommand

public String getMainCommand()

Description copied from interface: IModule

Get main command name

Specified by:

getMainCommand in interface IModule

Returns:

name of the main command without a slash

getConfig

public Comment.CommentConfig getConfig()

Description copied from interface: IModule

Get the configuration section of this module

Specified by:

getConfig in interface IModule

Returns:

configuration section of this module

load

public boolean load()

Description copied from interface: IModule

Load the module

Specified by:

load in interface IModule

Returns:

true if everything's ok otherwise false

unload

public boolean unload()

Description copied from interface: IModule

Unload the module

Specified by:

unload in interface IModule

Returns:

true if everything's ok otherwise false

getComments

public List<CommentEntry> getComments(String entity)

Get the notes relative to an entity

Parameters:

entity - | can be an ip or a player name

Returns:

getManagedComments

public List<CommentEntry> getManagedComments(String staff)

insertComment

public void insertComment(String entity,
 String comment,
 CommentEntry.Type type,
 String author)

clearComments

public String clearComments(String entity,
 int commentID)

Clear all the comments and warning of an entity or the specified one

Parameters:

entity -

commentID - | use -1 to remove all the comments

Returns: