net.user1.union.api
Interface Account

All Superinterfaces:

AttributeHolder

public interface Account
extends AttributeHolder

An Account represents a persistent user in the Union Server.

Method Summary

Client	getClient() Returns the currently connected client for this account if the account is logged in.
java.lang.String	getPassword() Return the password for the account.
java.lang.String	getUserID() Return the userID for the account.
boolean	isModerator() Returns true if the account has moderator privileges.
void	setModerator(boolean isModerator) Sets the account moderator status.

Methods inherited from interface net.user1.union.core.attribute.AttributeHolder

getAttribute, getAttribute, getAttributes, getAttributes, getAttributesByScope, getAttributeValue, getAttributeValue, onChangeAttribute, onRemoveAttribute, removeAttribute, removeAttribute, setAttribute

Method Detail

getUserID

java.lang.String getUserID()

Return the userID for the account.

Returns:

the userID for the account

getPassword

java.lang.String getPassword()

Return the password for the account.

Returns:

the password for the account

getClient

Client getClient()

Returns the currently connected client for this account if the account is logged in. If no client has logged in for this account then it returns null.

Returns:

the client for the account

isModerator

boolean isModerator()

Returns true if the account has moderator privileges.

Returns:

true if the account is a moderator

setModerator

void setModerator(boolean isModerator)
                  throws DatasourceException

Sets the account moderator status.

Parameters:

isModerator - - true if the account should be a moderator

Throws:

DatasourceException - if the Datasource could not persist the new moderator status.