com.fullspan.kat.app
Class KatSessionBase

java.lang.Object
  com.fullspan.kat.app.KatSessionBase

All Implemented Interfaces:

IKatSession, com.fullspan.util.IMessageAndErrorList

Direct Known Subclasses:

KatSessionStandalone, KatSessionWeb

public abstract class KatSessionBase

extends java.lang.Object

implements IKatSession

Author:

Mitch Stuart

Field Summary

protected KatUser	m_identityUser
protected com.fullspan.util.MessageAndErrorList	m_messageList

Constructor Summary

KatSessionBase()

Method Summary

void	addError(java.lang.String key)
void	addError(java.lang.String key, java.lang.Object arg)
void	addError(java.lang.String key, java.lang.Object[] args)
void	addError(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1)
void	addError(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
void	addMessage(java.lang.String key)
void	addMessage(java.lang.String key, java.lang.Object arg)
void	addMessage(java.lang.String key, java.lang.Object[] args)
void	addMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1)
void	addMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2)
void	addMessagesAndErrors(com.fullspan.util.IMessageAndErrorList messageAndErrorList)
void	addRawError(java.lang.String msg)
void	addRawMessage(java.lang.String msg)
void	addResourceBundle(java.util.ResourceBundle bundle)
void	clearErrors()
void	clearMessages()
void	clearMessagesAndErrors()
java.util.List	getErrors()
boolean	getHasErrors()
boolean	getHasMessages()
KatUser	getIdentityUser()
java.lang.String	getIdentityUserId()
java.lang.String	getIdentityUserLoginid()
boolean	getIsUserAdmin()
boolean	getIsUserAuthor()
boolean	getIsUserLoggedIn()
java.util.List	getMessages()
int	getUsertype()
boolean	login(KatUser user, java.lang.String password) Log a user into the session.
void	logout()
protected void	setIdentityUser(KatUser identityUser)

Methods inherited from class java.lang.Object

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

Field Detail

m_identityUser

protected KatUser m_identityUser

m_messageList

protected com.fullspan.util.MessageAndErrorList m_messageList

Constructor Detail

KatSessionBase

public KatSessionBase()

Method Detail

getIdentityUser

public KatUser getIdentityUser()

Specified by:

getIdentityUser in interface IKatSession

setIdentityUser

protected void setIdentityUser(KatUser identityUser)

getIsUserLoggedIn

public boolean getIsUserLoggedIn()

Specified by:

getIsUserLoggedIn in interface IKatSession

login

public boolean login(KatUser user,
                     java.lang.String password)

Description copied from interface: IKatSession

Log a user into the session. Generally speaking, clients should not call this directly. Rather, they should use KatLoginService, which calls this method.

Specified by:

login in interface IKatSession

logout

public void logout()

Specified by:

logout in interface IKatSession

getIdentityUserLoginid

public java.lang.String getIdentityUserLoginid()

Specified by:

getIdentityUserLoginid in interface IKatSession

getIdentityUserId

public java.lang.String getIdentityUserId()

Specified by:

getIdentityUserId in interface IKatSession

getIsUserAdmin

public boolean getIsUserAdmin()

Specified by:

getIsUserAdmin in interface IKatSession

getIsUserAuthor

public boolean getIsUserAuthor()

Specified by:

getIsUserAuthor in interface IKatSession

getUsertype

public int getUsertype()

Specified by:

getUsertype in interface IKatSession

addMessagesAndErrors

public void addMessagesAndErrors(com.fullspan.util.IMessageAndErrorList messageAndErrorList)

Specified by:

addMessagesAndErrors in interface com.fullspan.util.IMessageAndErrorList

Parameters:

messageAndErrorList -

addError

public void addError(java.lang.String key)

Specified by:

addError in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

addError

public void addError(java.lang.String key,
                     java.lang.Object arg)

Specified by:

addError in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

arg -

addError

public void addError(java.lang.String key,
                     java.lang.Object arg0,
                     java.lang.Object arg1)

Specified by:

addError in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

arg0 -

arg1 -

addError

public void addError(java.lang.String key,
                     java.lang.Object arg0,
                     java.lang.Object arg1,
                     java.lang.Object arg2)

Specified by:

addError in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

arg0 -

arg1 -

arg2 -

addError

public void addError(java.lang.String key,
                     java.lang.Object[] args)

Specified by:

addError in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

args -

addMessage

public void addMessage(java.lang.String key)

Specified by:

addMessage in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

addMessage

public void addMessage(java.lang.String key,
                       java.lang.Object arg)

Specified by:

addMessage in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

arg -

addMessage

public void addMessage(java.lang.String key,
                       java.lang.Object arg0,
                       java.lang.Object arg1)

Specified by:

addMessage in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

arg0 -

arg1 -

addMessage

public void addMessage(java.lang.String key,
                       java.lang.Object arg0,
                       java.lang.Object arg1,
                       java.lang.Object arg2)

Specified by:

addMessage in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

arg0 -

arg1 -

arg2 -

addMessage

public void addMessage(java.lang.String key,
                       java.lang.Object[] args)

Specified by:

addMessage in interface com.fullspan.util.IMessageAndErrorList

Parameters:

key -

args -

addRawError

public void addRawError(java.lang.String msg)

Specified by:

addRawError in interface com.fullspan.util.IMessageAndErrorList

Parameters:

msg -

addRawMessage

public void addRawMessage(java.lang.String msg)

Specified by:

addRawMessage in interface com.fullspan.util.IMessageAndErrorList

Parameters:

msg -

addResourceBundle

public void addResourceBundle(java.util.ResourceBundle bundle)

Specified by:

addResourceBundle in interface com.fullspan.util.IMessageAndErrorList

Parameters:

bundle -

clearMessagesAndErrors

public void clearMessagesAndErrors()

Specified by:

clearMessagesAndErrors in interface com.fullspan.util.IMessageAndErrorList

clearErrors

public void clearErrors()

Specified by:

clearErrors in interface com.fullspan.util.IMessageAndErrorList

clearMessages

public void clearMessages()

Specified by:

clearMessages in interface com.fullspan.util.IMessageAndErrorList

getErrors

public java.util.List getErrors()

Specified by:

getErrors in interface com.fullspan.util.IMessageAndErrorList

Returns:

the error list

getHasErrors

public boolean getHasErrors()

Specified by:

getHasErrors in interface com.fullspan.util.IMessageAndErrorList

Returns:

true if the error list contains errors, otherwise false

getHasMessages

public boolean getHasMessages()

Specified by:

getHasMessages in interface com.fullspan.util.IMessageAndErrorList

Returns:

true if the message list contains messages, otherwise false

getMessages

public java.util.List getMessages()

Specified by:

getMessages in interface com.fullspan.util.IMessageAndErrorList

Returns:

the message list