Package com.jalios.jcms.shortcut

Interface ShortcutPolicyFilter

All Superinterfaces:

java.lang.Comparable, PluginComponent, PolicyFilter

All Known Implementing Classes:

BasicShortcutPolicyFilter, WorkspaceApplicationShortcutPolicyFilter

public interface ShortcutPolicyFilter
extends PolicyFilter

This interface provides hooks for shortcut badge.

Since:

jcms-10.0.0

Author:

kevin.bransard@jalios.com

Method Summary

Modifier and Type	Method	Description
ApplicationMenuBadge	getApplicationMenuBadge(Member mbr)	Returns an ApplicationMenuBadge which will be displayed on topbar application menu item
ApplicationMenuBadge	getApplicationMenuBadge(Member mbr, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpSession session)	Returns an ApplicationMenuBadge which will be displayed on topbar application menu item
AbstractShortcut	getShortcut()	Used for filtering on getApplicationMenuBadge(Member)
ShortcutInfo	getShortcutInfo(AbstractShortcut shortcut, Member loggedMember)	Returns a ShortcutInfo which is used to synchronously query the shortcut badge for topbar application menu items (When the menu is opened)
java.lang.String	getShortcutInfoAsync(AbstractShortcut shortcut)	Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)
boolean	showShortcut(AbstractShortcut shortcut, Member mbr)	Show or hide the AbstractShortcut in the application menu

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.jalios.jcms.plugin.PluginComponent

init

Method Detail

getShortcutInfo

ShortcutInfo getShortcutInfo(AbstractShortcut shortcut,
                             Member loggedMember)

Returns a ShortcutInfo which is used to synchronously query the shortcut badge for topbar application menu items (When the menu is opened)

Parameters:

shortcut - the AbstractShortcut

loggedMember - the Member

Returns:

a ShortcutInfo for current Shortcut and given Member

getShortcutInfoAsync

java.lang.String getShortcutInfoAsync(AbstractShortcut shortcut)

Returns an url which is used to asynchronously query the shortcut badge for topbar application menu items (When the menu is opened)

Parameters:

shortcut - the AbstractShortcut

Returns:

an url

getApplicationMenuBadge

ApplicationMenuBadge getApplicationMenuBadge(Member mbr)

Returns an ApplicationMenuBadge which will be displayed on topbar application menu item

Parameters:

mbr - the Member

Returns:

an ApplicationMenuBadge for given user

getApplicationMenuBadge

ApplicationMenuBadge getApplicationMenuBadge(Member mbr,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpSession session)

Returns an ApplicationMenuBadge which will be displayed on topbar application menu item

Parameters:

mbr - the Member

request - the current HttpServletRequest

session - the current HttpSession

Returns:

an ApplicationMenuBadge for given user

getShortcut

AbstractShortcut getShortcut()

Used for filtering on getApplicationMenuBadge(Member)

Returns:

the AbstractShortcut

showShortcut

boolean showShortcut(AbstractShortcut shortcut,
                     Member mbr)

Show or hide the AbstractShortcut in the application menu

Parameters:

shortcut - AbstractShortcut

mbr -

Returns:

true if the AbstractShortcut must be displayed in the application menu