pt.digitalis.dif.dem.interfaces
Interface IStage

All Superinterfaces:
ICallback, IEntity, IRegistrable
All Known Subinterfaces:
IStageInstance
All Known Implementing Classes:
StageCGTemplate, StageInstanceCGTemplate

public interface IStage
extends IEntity, ICallback, IRegistrable

This interface represents a Stage entity on the DEM.

A Stage is related to a Service.

Author:
Pedro Viegas pviegas@digitalis.pt, Rodrigo Gonçalves rgoncalves@digitalis.pt
Created on:
2007/07/12

Method Summary
 IStage getDefaultErrorStage()
          Returns the default error Stage defined for this Stage
 ViewObject getDefaultErrorView()
          Returns the default error view defined for this Stage.
 ViewObject getDefaultView()
          Returns the default view.
 Map<EventType,List<String>> getEventHandlers()
          Returns the list of all the Stages submit handlers.
 Map<String,String> getInjectedErrorStages()
          Returns the list of all the error Stages injected in this Stage.
 Map<String,ViewObject> getInjectedErrorViews()
          Returns the list of all the error views injected in this Stage.
 List<String> getInjectedStages()
          Returns the list of all the Stages injected in this Stage.
 List<ViewObject> getInjectedViews()
          Returns the list of all the views injected in this Stage.
 IStageInstance getInstance()
          Return an instance of the stage for execution
 String getMessageForLanguage(String language, String messageID)
          Returns a message associated with a given ID
 Map<String,String> getMessagesForLanguage(String language)
          Returns all messages associated with the Entity.
 String getOverridesStageID()
           
 IParameters getParameters()
          Returns the parameters for the current stage
 IService getService()
          Returns the Stage service.
 String getStageInstanceClassName()
          Obtains the original stage class name
 boolean hasAuthentication()
          Defines if the stage has authentication.
 boolean hasAuthenticationErrorInjection()
          Registers if the stage has injected the authentication errors.
 boolean hasAuthorization()
          Defines if the stage has authorization.
 boolean hasInjectedContributions()
           
 boolean hasParameterErrorInjection()
          Registers if the stage has injected the parameter errors.
 boolean hasValidationLogicForForm(String formName)
          Checks if the current form has a validation logic handler for the given form
 
Methods inherited from interface pt.digitalis.dif.dem.interfaces.IEntity
getID, getName, getOriginalClassName, getUID
 
Methods inherited from interface pt.digitalis.dif.dem.interfaces.ICallback
getCallbackType, hasCallbackEnabled
 
Methods inherited from interface pt.digitalis.dif.dem.interfaces.IRegistrable
getLicenseEdition, isRegistered, isRegistrable, register, unregister
 

Method Detail

getDefaultErrorStage

IStage getDefaultErrorStage()
Returns the default error Stage defined for this Stage

Returns:
the default error Stage

getDefaultErrorView

ViewObject getDefaultErrorView()
Returns the default error view defined for this Stage.

Returns:
the default error view

getDefaultView

ViewObject getDefaultView()
Returns the default view.

Returns:
the default view

getEventHandlers

Map<EventType,List<String>> getEventHandlers()
Returns the list of all the Stages submit handlers.

Returns:
the list

getInjectedErrorStages

Map<String,String> getInjectedErrorStages()
Returns the list of all the error Stages injected in this Stage.

Returns:
the list of all the injected Stages

getInjectedErrorViews

Map<String,ViewObject> getInjectedErrorViews()
Returns the list of all the error views injected in this Stage.

Returns:
the list of all the injected ViewObject

getInjectedStages

List<String> getInjectedStages()
Returns the list of all the Stages injected in this Stage.

Returns:
the list of all the injected Stages

getInjectedViews

List<ViewObject> getInjectedViews()
Returns the list of all the views injected in this Stage.

Returns:
the list of all the injected ViewObject

getInstance

IStageInstance getInstance()
Return an instance of the stage for execution

Returns:
the stage instance

getMessageForLanguage

String getMessageForLanguage(String language,
                             String messageID)
Returns a message associated with a given ID

Parameters:
language - the language to get the messages in
messageID - the message ID
Returns:
the message with the given id

getMessagesForLanguage

Map<String,String> getMessagesForLanguage(String language)
Returns all messages associated with the Entity.

Parameters:
language - the language to get the messages in
Returns:
a map with all the messages related to the Entity

getOverridesStageID

String getOverridesStageID()
Returns:
the stage id of the stage that the present one overrides. Null otherwise.

getParameters

IParameters getParameters()
Returns the parameters for the current stage

Returns:
the parameters

getService

IService getService()
Returns the Stage service.

Returns:
the Stage service

getStageInstanceClassName

String getStageInstanceClassName()
Obtains the original stage class name

Returns:
the class name

hasAuthentication

boolean hasAuthentication()
Defines if the stage has authentication.

Returns:
T if the stage has , F otherwise

hasAuthenticationErrorInjection

boolean hasAuthenticationErrorInjection()
Registers if the stage has injected the authentication errors. If so the dispatcher will not fail on authentication errors and instead inject them so the stage may process them.

Returns:
T if the stage has injected the authentication errors onto an attribute

hasAuthorization

boolean hasAuthorization()
Defines if the stage has authorization.

Returns:
T if the stage has , F otherwise

hasInjectedContributions

boolean hasInjectedContributions()
Returns:
T if any attribute or method in annotated with Inject

hasParameterErrorInjection

boolean hasParameterErrorInjection()
Registers if the stage has injected the parameter errors. If not the framework must provide extra reporting of the errors. Else it is delegated to the business stage implementation.

Returns:
T if the stage has injected the errors onto an attribute

hasValidationLogicForForm

boolean hasValidationLogicForForm(String formName)
Checks if the current form has a validation logic handler for the given form

Parameters:
formName - the form name
Returns:
T if present


Copyright © 2014 Digitalis Informática Lda. All Rights Reserved.