Package com.openxava.naviox

Class Modules

java.lang.Object

com.openxava.naviox.Modules

All Implemented Interfaces:

java.io.Serializable

public class Modules
extends java.lang.Object
implements java.io.Serializable

Author:

Javier Paniza

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FIRST_STEPS

Constructor Summary

Constructors

Constructor	Description
Modules()

Method Summary

Modifier and Type	Method	Description
void	bookmarkCurrentModule(javax.servlet.http.HttpServletRequest request)
static void	clearCurrent()
java.util.List	getAll(javax.servlet.http.HttpServletRequest request)
java.lang.String	getApplicationLabel(javax.servlet.http.HttpServletRequest request)
java.util.Collection	getBookmarkModules(javax.servlet.http.HttpServletRequest request)
java.lang.String	getCurrent(javax.servlet.http.HttpServletRequest request)
java.lang.String	getCurrentModuleDescription(javax.servlet.http.HttpServletRequest request)
java.lang.String	getCurrentModuleLabel()
java.lang.String	getCurrentModuleName()
java.util.Collection	getFixedModules(javax.servlet.http.HttpServletRequest request)
java.util.Collection<MetaModule>	getMenuModules(javax.servlet.http.HttpServletRequest request)
java.lang.String	getModuleURI(javax.servlet.http.HttpServletRequest request, MetaModule module)
java.lang.String	getOrganizationName(javax.servlet.http.HttpServletRequest request)
java.util.List	getRegularModules(javax.servlet.http.HttpServletRequest request)
java.util.Collection<MetaModule>	getTopModules()
java.lang.String	getUserAccessModule(javax.servlet.ServletRequest request)
boolean	hasModules(javax.servlet.http.HttpServletRequest request)
static void	init(java.lang.String applicationName)
boolean	isBookmarked(javax.servlet.http.HttpServletRequest request, MetaModule module)
boolean	isCurrentBookmarked(javax.servlet.http.HttpServletRequest request)
boolean	isModuleAuthorized(javax.servlet.http.HttpServletRequest request)
boolean	isModuleAuthorized(javax.servlet.http.HttpServletRequest request, java.lang.String module)
boolean	isModuleAuthorized(javax.servlet.http.HttpServletRequest request, MetaModule module)
boolean	isModuleInMenu(javax.servlet.http.HttpServletRequest request, MetaModule module)
void	removeModule(int index)
void	reset()
void	setCurrent(javax.servlet.http.HttpServletRequest request)
void	setCurrent(javax.servlet.http.HttpServletRequest request, java.lang.String application, java.lang.String module)
boolean	showsIndexLink()
boolean	showsSearchModules(javax.servlet.http.HttpServletRequest request)
void	unbookmarkCurrentModule(javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_STEPS

public static final java.lang.String FIRST_STEPS

See Also:

Constant Field Values

Constructor Detail

Modules

public Modules()

Method Detail

init

public static void init(java.lang.String applicationName)

reset

public void reset()

clearCurrent

public static void clearCurrent()

Since:

7.2.3

hasModules

public boolean hasModules(javax.servlet.http.HttpServletRequest request)

setCurrent

public void setCurrent(javax.servlet.http.HttpServletRequest request,
                       java.lang.String application,
                       java.lang.String module)

setCurrent

public void setCurrent(javax.servlet.http.HttpServletRequest request)

showsIndexLink

public boolean showsIndexLink()

showsSearchModules

public boolean showsSearchModules(javax.servlet.http.HttpServletRequest request)

getCurrent

public java.lang.String getCurrent(javax.servlet.http.HttpServletRequest request)

getOrganizationName

public java.lang.String getOrganizationName(javax.servlet.http.HttpServletRequest request)

Since:

6.0

getApplicationLabel

public java.lang.String getApplicationLabel(javax.servlet.http.HttpServletRequest request)

getCurrentModuleDescription

public java.lang.String getCurrentModuleDescription(javax.servlet.http.HttpServletRequest request)

getCurrentModuleLabel

public java.lang.String getCurrentModuleLabel()

getCurrentModuleName

public java.lang.String getCurrentModuleName()

bookmarkCurrentModule

public void bookmarkCurrentModule(javax.servlet.http.HttpServletRequest request)

unbookmarkCurrentModule

public void unbookmarkCurrentModule(javax.servlet.http.HttpServletRequest request)

isCurrentBookmarked

public boolean isCurrentBookmarked(javax.servlet.http.HttpServletRequest request)

isBookmarked

public boolean isBookmarked(javax.servlet.http.HttpServletRequest request,
                            MetaModule module)

isModuleAuthorized

public boolean isModuleAuthorized(javax.servlet.http.HttpServletRequest request)

isModuleAuthorized

public boolean isModuleAuthorized(javax.servlet.http.HttpServletRequest request,
                                  java.lang.String module)

Since:

5.7

getModuleURI

public java.lang.String getModuleURI(javax.servlet.http.HttpServletRequest request,
                                     MetaModule module)

isModuleAuthorized

public boolean isModuleAuthorized(javax.servlet.http.HttpServletRequest request,
                                  MetaModule module)

isModuleInMenu

public boolean isModuleInMenu(javax.servlet.http.HttpServletRequest request,
                              MetaModule module)

Since:

6.5

getBookmarkModules

public java.util.Collection getBookmarkModules(javax.servlet.http.HttpServletRequest request)

getFixedModules

public java.util.Collection getFixedModules(javax.servlet.http.HttpServletRequest request)

Since:

6.0

getAll

public java.util.List getAll(javax.servlet.http.HttpServletRequest request)

getRegularModules

public java.util.List getRegularModules(javax.servlet.http.HttpServletRequest request)

Since:

6.0

getUserAccessModule

public java.lang.String getUserAccessModule(javax.servlet.ServletRequest request)

getTopModules

public java.util.Collection<MetaModule> getTopModules()

getMenuModules

public java.util.Collection<MetaModule> getMenuModules(javax.servlet.http.HttpServletRequest request)

Since:

7.0

removeModule

public void removeModule(int index)