ks.protocol
Class UserManagerMessage

java.lang.Object
  ks.common.ArgumentList
      ks.common.message.Message
          ks.protocol.UserManagerMessage

All Implemented Interfaces:

java.io.Serializable

public class UserManagerMessage

extends Message

Base class for all usermanager messages.

See Also:

Serialized Form

Field Summary

static java.lang.String	actionArg Action that was taken.
static java.lang.String	adminArg Is admin message?
static java.lang.String	resultArg Result of action.

Constructor Summary

UserManagerMessage(java.lang.String fromUser)
Construct default message from specific user.

Method Summary

java.lang.String	getAction() Get the action.
boolean	isAdmin() Determines if message is an administrator message.
void	setAction(java.lang.String action) Describes the action taken.
void	setAdmin(boolean admin) Determines if this messages is an administer message.
void	setResult(boolean result) Determines result of action.
java.lang.String	toString() proper string representation of object.

Methods inherited from class ks.common.message.Message

getFromUser, getScope, getTargetUser, getUser, setFromUser, setScope, setTargetUser

Methods inherited from class ks.common.ArgumentList

addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, addArgMulti, clearArg, clearArg, clearArgMulti, clearArgMulti, getArg, getArg, getArgMulti, getArgMulti, multiArgs, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, removeArgMulti, setArg, setArg, singleArgs

Methods inherited from class java.lang.Object

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

Field Detail

adminArg

public static final java.lang.String adminArg

Is admin message?

See Also:

Constant Field Values

actionArg

public static final java.lang.String actionArg

Action that was taken.

See Also:

Constant Field Values

resultArg

public static final java.lang.String resultArg

Result of action.

See Also:

Constant Field Values

Constructor Detail

UserManagerMessage

public UserManagerMessage(java.lang.String fromUser)

Construct default message from specific user.

Parameters:

fromUser -

Method Detail

getAction

public java.lang.String getAction()

Get the action.

Returns:

String representing action.

isAdmin

public boolean isAdmin()

Determines if message is an administrator message.

Returns:

true if message is intended for administrators only.

setAdmin

public void setAdmin(boolean admin)

Determines if this messages is an administer message.

Parameters:

admin -

setResult

public void setResult(boolean result)

Determines result of action.

Parameters:

result -

setAction

public void setAction(java.lang.String action)

Describes the action taken.

Parameters:

action -

toString

public java.lang.String toString()

proper string representation of object.

Overrides:

toString in class Message

Returns:

String representing the message.