com.saperion.ngc.authorization

Interface AuthorizationView

All Superinterfaces:

Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, Serializable

All Known Implementing Classes:

AuthorizationViewImpl

public interface AuthorizationView
extends org.zkoss.zk.ui.Component

Interface for authorization views.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEAR_USER_AND_MANDANT Parameter name of ClearUserAndMandant option.

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Method Summary

Modifier and Type	Method and Description
void	disableAuthorizationView() Disable view.
void	enableAuthorizationView() Enable view.
void	invalidateSession() Invalidates the current running session.
void	onLogon(org.zkoss.zk.ui.event.Event event) Event handler for LogonEvent.
void	onPasswordExpired(org.zkoss.zk.ui.event.Event event) Event handler for PasswordExpiredEvent.
void	postErrorLogEvent(LogMessage message) Posts an error log event.
void	postInfoLogEvent(LogMessage message) Posts an info log event.
void	postLogonEvent(LogonEvent.LogonResult result, String userName) Post a logon event.
void	setLocaleList(List<Locale> localeList) Set locales.
void	setLogoffWarningDisabled(boolean disabled) The WebClient displays a warning-message when a user closes the browser window or navigates to another page without having logged off from the system before.
void	setRedirectAfterLogoffDisabled(boolean disabled) For security reasons the WebClient redirects to self after a user has logged of.
void	setSelectedLocale(Locale currentLocale) setSelectedLocale in Language Combobox .
void	setSelectedUserType(UserType userType) setSelectedUserType in userType.
void	setSingleMandant(boolean isSingleMandant) Set single mandant.
void	setUserTypeList(List<UserType> userTypeList) Set user types.

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Field Detail

CLEAR_USER_AND_MANDANT

static final String CLEAR_USER_AND_MANDANT

Parameter name of ClearUserAndMandant option.

See Also:

Constant Field Values

Method Detail

enableAuthorizationView

void enableAuthorizationView()

Enable view.

disableAuthorizationView

void disableAuthorizationView()

Disable view.

setUserTypeList

void setUserTypeList(List<UserType> userTypeList)

Set user types.

Parameters:

userTypeList - user types

setLocaleList

void setLocaleList(List<Locale> localeList)

Set locales.

Parameters:

localeList - locale

setSingleMandant

void setSingleMandant(boolean isSingleMandant)

Set single mandant.

Parameters:

isSingleMandant - isSingleMandant

invalidateSession

void invalidateSession()

Invalidates the current running session.

postLogonEvent

void postLogonEvent(LogonEvent.LogonResult result,
                    String userName)

Post a logon event.

Parameters:

result - logon result

userName - user name

postErrorLogEvent

void postErrorLogEvent(LogMessage message)

Posts an error log event.

Parameters:

message - the error message

postInfoLogEvent

void postInfoLogEvent(LogMessage message)

Posts an info log event.

Parameters:

message - the info message

setSelectedLocale

void setSelectedLocale(Locale currentLocale)

setSelectedLocale in Language Combobox .

Parameters:

currentLocale - currentLocale

setSelectedUserType

void setSelectedUserType(UserType userType)

setSelectedUserType in userType.

Parameters:

userType - userType

setLogoffWarningDisabled

void setLogoffWarningDisabled(boolean disabled)

The WebClient displays a warning-message when a user closes the browser window or navigates to another page without having logged off from the system before. By setting this parameter to true, this warning message can be disabled.

Parameters:

disabled - true to disabled warning message

setRedirectAfterLogoffDisabled

void setRedirectAfterLogoffDisabled(boolean disabled)

For security reasons the WebClient redirects to self after a user has logged of. By setting this parameter to true, the redirecting is disabled. This might be required when parts of the WebClient are included in a portal or some other page.

Parameters:

disabled - true to disable redirecting after logoff

onLogon

void onLogon(org.zkoss.zk.ui.event.Event event)

Event handler for LogonEvent.

Parameters:

event - event to handle

onPasswordExpired

void onPasswordExpired(org.zkoss.zk.ui.event.Event event)

Event handler for PasswordExpiredEvent.

Parameters:

event - event to handle