net.ontopia.topicmaps.nav2.core
Interface UserIF

All Known Implementing Classes:

User

public interface UserIF

INTERNAL: interface for classes which implement user data management usually stored in the session.

Field Summary

static java.lang.String	COMMON_USER Default User identifier
static java.lang.String	DEFAULT_MODEL Default Model name
static java.lang.String	DEFAULT_SKIN Default Skin/CSS
static java.lang.String	DEFAULT_VIEW Default View/Template

Method Summary

void	addLogMessage(java.lang.String message) INTERNAL: Adds a message to the user's log.
void	addWorkingBundle(java.lang.String bundle_id, java.lang.Object object) INTERNAL: Stores a working bundle of objects under the specified id.
void	clearLog() INTERNAL: Clears the user's log.
UserFilterContextStore	getFilterContext() INTERNAL: Gets the Filter Context object which stores for each topicmap a set of themes the user has selected.
HistoryMap	getHistory() INTERNAL: Gets the last used objects (instances of Object, specialisation through the web application) which the user has visited.
java.lang.String	getId() INTERNAL: Gets the user identifier.
org.slf4j.Logger	getLogger() Deprecated. Use addLogMessage() instead
java.util.List	getLogMessages() INTERNAL: Gets the current log messages from the ring buffer.
java.lang.String	getModel() Get Model Setting for MVS.
java.lang.String	getSkin() Get Skin (Stylesheet) Setting for MVS.
java.lang.String	getView() Get View (Template) Setting for MVS.
java.lang.Object	getWorkingBundle(java.lang.String bundle_id) INTERNAL: Gets an ordered lists of objects (parameter name as key, list of objects as value) grouped together by the given identifier id.
void	removeWorkingBundle(java.lang.String bundle_id) INTERNAL: Removes the specified working bundle.
void	setHistory(HistoryMap hm) INTERNAL: Sets the last used objects that are in relation to the user and his path through the web application.
void	setModel(java.lang.String model) Set Model Setting.
void	setSkin(java.lang.String skin) Set Skin Setting.
void	setView(java.lang.String view) Set View Setting.

Field Detail

COMMON_USER

static final java.lang.String COMMON_USER

Default User identifier

See Also:

Constant Field Values

DEFAULT_MODEL

static final java.lang.String DEFAULT_MODEL

Default Model name

See Also:

Constant Field Values

DEFAULT_VIEW

static final java.lang.String DEFAULT_VIEW

Default View/Template

See Also:

Constant Field Values

DEFAULT_SKIN

static final java.lang.String DEFAULT_SKIN

Default Skin/CSS

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

INTERNAL: Gets the user identifier.

getFilterContext

UserFilterContextStore getFilterContext()

INTERNAL: Gets the Filter Context object which stores for each topicmap a set of themes the user has selected.

getHistory

HistoryMap getHistory()

INTERNAL: Gets the last used objects (instances of Object, specialisation through the web application) which the user has visited.

Since:

1.2.5

setHistory

void setHistory(HistoryMap hm)

INTERNAL: Sets the last used objects that are in relation to the user and his path through the web application.

Since:

1.2.5

getLogger

org.slf4j.Logger getLogger()

Deprecated. Use addLogMessage() instead

INTERNAL: Gets the Slf4J Logger object to which the User object should transmit the log messages. This method is now deprecated, and we recommend using addLogMessage() instead.

Since:

1.3.2

addLogMessage

void addLogMessage(java.lang.String message)

INTERNAL: Adds a message to the user's log. The order of these messages is preserved, but if too many messages are added, the latest ones are lost.

clearLog

void clearLog()

INTERNAL: Clears the user's log.

getLogMessages

java.util.List getLogMessages()

INTERNAL: Gets the current log messages from the ring buffer.

Since:

1.3.2

addWorkingBundle

void addWorkingBundle(java.lang.String bundle_id,
                      java.lang.Object object)

INTERNAL: Stores a working bundle of objects under the specified id.

Since:

1.3.2

getWorkingBundle

java.lang.Object getWorkingBundle(java.lang.String bundle_id)

INTERNAL: Gets an ordered lists of objects (parameter name as key, list of objects as value) grouped together by the given identifier id.

Since:

1.3.2

removeWorkingBundle

void removeWorkingBundle(java.lang.String bundle_id)

INTERNAL: Removes the specified working bundle.

Since:

1.3.2

getModel

java.lang.String getModel()

Get Model Setting for MVS.

setModel

void setModel(java.lang.String model)

Set Model Setting.

getView

java.lang.String getView()

Get View (Template) Setting for MVS.

setView

void setView(java.lang.String view)

Set View Setting.

getSkin

java.lang.String getSkin()

Get Skin (Stylesheet) Setting for MVS.

setSkin

void setSkin(java.lang.String skin)

Set Skin Setting.