pt.digitalis.dif.presentation.views.jsp.taglibs.interfaces
Interface ITagExecutionContext

All Known Implementing Classes:

AbstractActionsComponent, AbstractAJAXRequestActionTag, AbstractCheckListContainer, AbstractFormComponent, AbstractFormInput, AbstractGridTag, AbstractInnerDIFTag, AbstractPanelContainer, AbstractTreeItemContainer, Accordion, ActionItem, Actions, AjaxRequest, Breadcrumbs, Chart, CheckBoxField, CheckList, CheckListItem, CollapsibleArea, CollapsibleAreaLink, Column, ColumnGroup, ComboField, Component, ContainerBox, ContentEditor, Contribution, DateField, DateTime, Dialog, DialogButton, DialogJSCondition, DialogJSHandler, DocumentGenerator, Download, DownloadList, ErrorMessage, Failure, FieldSet, FileUploadField, Footnote, Footnotes, Form, FormActions, FormCRUD, FormText, GetError, Grid, GridCRUD, GridTreeSelect, Help, HiddenField, IndentFields, LanguageSelector, Login, Logout, MemoField, Menu, MenuItem, MenuText, MessageBox, Mode, ModeConditional, ModeOthers, MultiSelect, PageContainer, Panel, PanelActions, PanelContainer, ParameterErrors, PerfilMenu, PropertiesEditor, RadioField, RadioGroup, RequestParameter, Search, ServerProcess, StageLink, Success, Summary, SummaryItem, Tabs, TextField, Tree, TreeItem, UserInfo, WebUIModeSelector, WebUIThemeSelector, Wizard, WizardStage

public interface ITagExecutionContext

Author:

Pedro Viegas pviegas@digitalis.pt

Created on:

2010/10/20

Method Summary

java.lang.String	getApplicationID()
java.lang.String	getComponentGeneratedId()
DocumentContributions	getContributions()
java.lang.String	getId()
java.lang.String	getLanguage()
java.lang.String	getLoggedProfileID()
java.lang.String	getLoggedProfileName()
java.lang.String	getLoggedUserFullName()
java.util.Set<java.lang.String>	getLoggedUserGroupIDs()
java.lang.String	getLoggedUsername()
java.lang.String	getMainRequestedStageID()
java.lang.String	getSecurityToken() Inspector for the 'token' attribute.
java.lang.String	getServiceID()
java.lang.String	getStageID()
java.lang.String	getTabIndexAttribute() Generates the tabindex tag
java.lang.String	getTabIndexAttribute(boolean active) Generates the tabindex tag.
int	getTabIndexNumber() Generates a new tabindex sequential number
java.lang.String	getTagMessage(java.lang.String id) Returns a specific message from the list of messages available for the Tag
java.util.Map<java.lang.String,java.lang.String>	getTagMessages() Returns the list of messages available for the Tag
UILevel	getUILevel()
boolean	hasAccessToStage(java.lang.String stageID) Validates if the current user has access to a given stage
boolean	isAjaxMode()
boolean	isComponentMode()
boolean	isHelpMode()
boolean	isLogged()
boolean	isPopupMode()
boolean	isTemplateMode()

Method Detail

getApplicationID

java.lang.String getApplicationID()

Returns:

the application that was requested

getComponentGeneratedId

java.lang.String getComponentGeneratedId()

Returns:

a generated component id

getContributions

DocumentContributions getContributions()

Returns:

the document contributions

getId

java.lang.String getId()

Returns:

the tag ID element

getLanguage

java.lang.String getLanguage()

Returns:

the current language

getLoggedProfileID

java.lang.String getLoggedProfileID()

Returns:

the currently logged user profile ID or Null if no user in session

getLoggedProfileName

java.lang.String getLoggedProfileName()

Returns:

the currently logged user profile name or Null if no user in session

getLoggedUserFullName

java.lang.String getLoggedUserFullName()

Returns:

the currently logged user full name of Null if no user in session

getLoggedUserGroupIDs

java.util.Set<java.lang.String> getLoggedUserGroupIDs()

Returns:

the currently logged user associated group IDs or empty list if no user in session

getLoggedUsername

java.lang.String getLoggedUsername()

Returns:

the currently logged username of Null if no user in session

getMainRequestedStageID

java.lang.String getMainRequestedStageID()

Returns:

the main stage that was requested

getSecurityToken

java.lang.String getSecurityToken()

Inspector for the 'token' attribute.

Returns:

the token value

getServiceID

java.lang.String getServiceID()

Returns:

the service that was requested

getStageID

java.lang.String getStageID()

Returns:

the stage that was requested

getTabIndexAttribute

java.lang.String getTabIndexAttribute()

Generates the tabindex tag

Returns:

the generated HTML tag code

getTabIndexAttribute

java.lang.String getTabIndexAttribute(boolean active)

Generates the tabindex tag. Only if active is T

Parameters:

active - if the tabindex should be present

Returns:

the generated HTML tag code

getTabIndexNumber

int getTabIndexNumber()

Generates a new tabindex sequential number

Returns:

the generated HTML tag code

getTagMessage

java.lang.String getTagMessage(java.lang.String id)

Returns a specific message from the list of messages available for the Tag

Parameters:

id - the message id to retrive

Returns:

the message

getTagMessages

java.util.Map<java.lang.String,java.lang.String> getTagMessages()

Returns the list of messages available for the Tag

Returns:

the tag Messages

getUILevel

UILevel getUILevel()

Returns:

the uiLevel

hasAccessToStage

boolean hasAccessToStage(java.lang.String stageID)

Validates if the current user has access to a given stage

Parameters:

stageID - the stage to validate access

Returns:

T if the user has access to the stage

isAjaxMode

boolean isAjaxMode()

Returns:

T if the stage is being rendered in component mode

isComponentMode

boolean isComponentMode()

Returns:

T if the stage is being rendered in component mode

isHelpMode

boolean isHelpMode()

Returns:

T if the stage is being rendered in help mode

isLogged

boolean isLogged()

Returns:

T if the current session has a user logged

isPopupMode

boolean isPopupMode()

Returns:

T if the stage is being rendered in popup mode

isTemplateMode

boolean isTemplateMode()

Returns:

T if the stage is being rendered in template mode