Index (Page Flow 4.0.0 API)

A C D E F G H I M N O P R S T
All Classes All Packages

A

addAllErrors(Map<String, Errors>) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
addAllErrors(Map<String, Errors>) - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Add an application specific map of Errors, each entry of which is paired with name and Errors object to this PageState.
addErrors(String, Errors) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
addErrors(String, Errors) - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Add an application specific Errors by the name to this PageState.
addItem(ErrorItem) - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Add an ErrorItem to this Errors.
addItem(ErrorItem) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
addPageFlowDefinition(PageFlowDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry
addPageStateDefinition(PageStateDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
addPageTransitionDefinition(PageTransitionDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
addPageTransitionDefinition(PageTransitionDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition

C

clear() - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Clear out all the ErrorItems in this Errors.
clear() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
clearAllErrors() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
clearAllErrors() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Clear all the application specific Errors in this PageState.
clearPageFlowDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry
clearPageFlowDefinitions() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinitionRegistry: Clear all the registered PageFlowDefinitions in the registry.
clearPageTransitionDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
clearPageTransitionDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
completePageFlow(HttpServletRequest, PageFlow) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
completePageFlow(HttpServletRequest, PageFlow) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl
createPageFlow(HttpServletRequest, PageFlowDefinition) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlowFactory
createPageFlow(HttpServletRequest, PageFlowDefinition) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowFactory: Create a PageFlow instance by PageFlowDefinition.
createPageFlowControl(HttpServletRequest) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Create a PageFlowControl for this request.

D

DefaultErrorItem - Class in org.onehippo.forge.pageflow.core.rt.impl
DefaultErrorItem(ResourceBundle, Locale, String) - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
DefaultErrorItem(ResourceBundle, Locale, String, Object[]) - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
DefaultErrorItem(ResourceBundle, Locale, String, Object[], String) - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
DefaultErrors - Class in org.onehippo.forge.pageflow.core.rt.impl
DefaultErrors() - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
DefaultErrors(ErrorItem...) - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
DefaultHstPageFlowControl - Class in org.onehippo.forge.pageflow.hst.sitemapitemhandler: Default generic PageFlowControl implementation for an HST-based site web application to integrate with Page Flow module.
DefaultHstPageFlowControl() - Constructor for class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultHstPageFlowControl
DefaultPageFlow - Class in org.onehippo.forge.pageflow.core.rt.impl
DefaultPageFlow(String, StateMachine<PageState, String>) - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
DefaultPageFlowControl - Class in org.onehippo.forge.pageflow.core.rt: Default generic PageFlowControl implementation in a web application.
DefaultPageFlowControl() - Constructor for class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
DefaultPageFlowControlHstSiteMapItemHandler - Class in org.onehippo.forge.pageflow.hst.sitemapitemhandler: Default generic HstSiteMapItemHandler implementation to integrate with Page Flow module.
DefaultPageFlowControlHstSiteMapItemHandler() - Constructor for class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler
DefaultPageFlowDefinition - Class in org.onehippo.forge.pageflow.core.def.impl: Default PageFlowDefinition model implementation.
DefaultPageFlowDefinition(String, String, String) - Constructor for class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
DefaultPageFlowFactory - Class in org.onehippo.forge.pageflow.core.rt.impl
DefaultPageFlowFactory() - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlowFactory
DefaultPageState - Class in org.onehippo.forge.pageflow.core.rt.impl
DefaultPageState(String, String, String, int, Map<String, String>) - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
DefaultPageStateDefinition - Class in org.onehippo.forge.pageflow.core.def.impl: Default PageStateDefinition model implementation.
DefaultPageStateDefinition(String, String, String, Map<String, String>) - Constructor for class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
DefaultPageTransitionDefinition - Class in org.onehippo.forge.pageflow.core.def.impl: Default PageTransitionDefinition model implementation.
DefaultPageTransitionDefinition(String, String) - Constructor for class org.onehippo.forge.pageflow.core.def.impl.DefaultPageTransitionDefinition

E

equals(Object) - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
equals(Object) - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
equals(Object) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
equals(Object) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
equals(Object) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageTransitionDefinition
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Compares the specified object with this PageFlowDefinition for equality.
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Compares the specified object with this PageStateDefinition for equality.
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.def.PageTransitionDefinition: Compares the specified object with this PageTransitionDefinition for equality.
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.rt.ErrorItem: Compares the specified object with this ErrorItem for equality.
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Compares the specified object with this Errors for equality.
equals(Object) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
equals(Object) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
equals(Object) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
equals(Object) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Compares the specified object with this PageFlow for equality.
equals(Object) - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Compares the specified object with this PageState for equality.
ErrorItem - Interface in org.onehippo.forge.pageflow.core.rt: Error Item abstraction which is part of Errors.
Errors - Interface in org.onehippo.forge.pageflow.core.rt: Errors abstraction for an application subject (e.g, a field in a form of an application).
EventDefInfo - Class in org.onehippo.forge.pageflow.cms.editor.field: Event Definition Information model.
EventDefInfo() - Constructor for class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
EventDefInfo(String, String) - Constructor for class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo

F

findPageFlowId(HttpServletRequest) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
findPageFlowId(HttpServletRequest) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultHstPageFlowControl

G

getActivePageFlow(HttpServletRequest, PageFlowControl) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Return an active PageFlow instance for this request.
getAttribute(String) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
getAttribute(String) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Find and return the attribute model object of this PageFlow by the name.
getAttributeMap() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
getAttributeMap() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return an unmodifiable attributes map of this PageFlow.
getCode() - Method in interface org.onehippo.forge.pageflow.core.rt.ErrorItem: Return the error code.
getCode() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
getConfigurationProperty(String, ResolvedSiteMapItem, Class<T>, T) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Get the configuration property value on the resolvedSiteMapItem.
getDefault(ServletRequest) - Static method in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl
getDefaultPageFlowId() - Method in interface org.onehippo.forge.pageflow.hst.channel.PageFlowSiteInfo: Return the identifier of the default Page Flow of this channel.
getDefaultResourceBundleIds() - Method in interface org.onehippo.forge.pageflow.hst.channel.PageFlowSiteInfo: Return the default (comma-separated) resource bundle ID(s) of this channel.
getDocumentDescription(ExternalDocumentServiceContext, EventDefInfo, Locale) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
getDocumentDescription(ExternalDocumentServiceContext, PageStateInfo, Locale) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade
getDocumentIconLink(ExternalDocumentServiceContext, EventDefInfo, Locale) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
getDocumentIconLink(ExternalDocumentServiceContext, PageStateInfo, Locale) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade
getDocumentTitle(ExternalDocumentServiceContext, EventDefInfo, Locale) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
getDocumentTitle(ExternalDocumentServiceContext, PageStateInfo, Locale) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade
getErrorsMap() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
getErrorsMap() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return an application specific map of Errors, each entry of which is paired with name and Errors object in this PageState.
getEvent() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageTransitionDefinition
getEvent() - Method in interface org.onehippo.forge.pageflow.core.def.PageTransitionDefinition: Return the source event name causing this page transition.
getFieldExternalDocuments(ExternalDocumentServiceContext) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
getFieldExternalDocuments(ExternalDocumentServiceContext) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade
getId() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
getId() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
getId() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Return the identifier of a PageFlowDefinition.
getId() - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Return the identifier of the PageStateDefinition.
getId() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
getId() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
getId() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return the identifier of the PageFlow instance.
getId() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return the identifier of this PageState.
getIndex() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
getIndex() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return the internal index, which is the same as definition order in the backend, of the PageState.
getItems() - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Return an unmodifiable list of ErrorItems in this Errors.
getItems() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
getLabel() - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
getMessage() - Method in interface org.onehippo.forge.pageflow.core.rt.ErrorItem: Return the (human readable) error message.
getMessage() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
getMetadata() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
getMetadata() - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Return an unmodifiable metadata map of the PageStateDefinition.
getMetadata() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
getMetadata() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return an unmodifiable metadata map of the PageState.
getName() - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
getName() - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
getName() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
getName() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
getName() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Return the (human readable) name of a PageFlowDefinition.
getName() - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Return the (human readable) name of the PageStateDefinition.
getName() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
getName() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return the (human readable) name of this PageState.
getPageFlow(HttpServletRequest) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
getPageFlow(HttpServletRequest) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl
getPageFlow(HttpServletRequest, String) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
getPageFlow(HttpServletRequest, String) - Method in class org.onehippo.forge.pageflow.core.rt.impl.HttpSessionPageFlowStore
getPageFlow(HttpServletRequest, String) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowStore: Find and retrieve the PageFlow instance by the identifier of the PageFlow (flowId) from the backend storage.
getPageFlowControl(HttpServletRequest) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Get a PageFlowControl instance for this request.
getPageFlowDefinition(String) - Method in class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry
getPageFlowDefinition(String) - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinitionRegistry: Retrieve the PageFlowDefinition by the identifier (flowId).
getPageFlowDefinition(String) - Method in class org.onehippo.forge.pageflow.hst.def.impl.RepositoryMapPageFlowDefinitionRegistry
getPageFlowDefinitionRegistry() - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
getPageFlowDefinitionRegistry() - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultHstPageFlowControl
getPageFlowFactory() - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
getPageFlowFactory() - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultHstPageFlowControl
getPageFlowStore() - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
getPageFlowStore() - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultHstPageFlowControl
getPageState() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
getPageState() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return the current PageState instance in the PageFlow.
getPageStateDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
getPageStateDefinitions() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Return an unmodifiable list of PageStateDefinitions of this PageFlowDefinition.
getPageStates() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
getPageStates() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return an unmodifiable list of the PageState of this PageFlow.
getPageTransitionDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
getPageTransitionDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
getPageTransitionDefinitions() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Return an unmodifiable list of the global PageTransitionDefinitions of this PageFlowDefinition.
getPageTransitionDefinitions() - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Return an unmodifiable list of the PageStateDefinition level PageTransitionDefinitions.
getPath() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
getPath() - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Return the logical path info of the PageStateDefinition.
getPath() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
getPath() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return the logical path info of the PageState.
getSiteMapItemHandlerConfiguration() - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Return SiteMapItemHandlerConfiguration.
getStateId() - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
getTargetPageStateDefinitionId() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageTransitionDefinition
getTargetPageStateDefinitionId() - Method in interface org.onehippo.forge.pageflow.core.def.PageTransitionDefinition: Return the target PageStateDefinition's ID.
getUuid() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
getUuid() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Return the optional UUID of a PageFlowDefinition, possibly reflecting the backend storage level UUID such as JCR.

H

hashCode() - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
hashCode() - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
hashCode() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
hashCode() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
hashCode() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageTransitionDefinition
hashCode() - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinition: Returns the hash code value for this PageFlowDefinition.
hashCode() - Method in interface org.onehippo.forge.pageflow.core.def.PageStateDefinition: Returns the hash code value for this PageStateDefinition.
hashCode() - Method in interface org.onehippo.forge.pageflow.core.def.PageTransitionDefinition: Returns the hash code value for this PageTransitionDefinition.
hashCode() - Method in interface org.onehippo.forge.pageflow.core.rt.ErrorItem: Returns the hash code value for this ErrorItem.
hashCode() - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Returns the hash code value for this Errors.
hashCode() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
hashCode() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
hashCode() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
hashCode() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
hashCode() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Returns the hash code value for this PageFlow.
hashCode() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Returns the hash code value for this PageState.
HttpSessionPageFlowStore - Class in org.onehippo.forge.pageflow.core.rt.impl
HttpSessionPageFlowStore() - Constructor for class org.onehippo.forge.pageflow.core.rt.impl.HttpSessionPageFlowStore

I

init(ServletContext, SiteMapItemHandlerConfiguration) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler
isComplete() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
isComplete() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return true if this PageFlow instance is completed.
isEmpty() - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Return true if there's no errors.
isEmpty() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
isErrorsEmpty() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
isErrorsEmpty() - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Return true if there's no application error at runtime in this PageState.
isRequestForPageState(HttpServletRequest, PageState) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Return true if the current request is for the specific pageState by comparing the pathInfo of the request with the path of the pageState.
isStarted() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
isStarted() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return true if this PageFlow instance has started.
isStopped() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
isStopped() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Return true if this PageFlow instance has stopped.

M

MapPageFlowDefinitionRegistry - Class in org.onehippo.forge.pageflow.core.def.impl: Generic purpose Map based PageFlowDefinitionRegistry implementation.
MapPageFlowDefinitionRegistry() - Constructor for class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry
MapPageFlowDefinitionRegistry(Map<String, PageFlowDefinition>) - Constructor for class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry

N

NULL_PAGE_FLOW_DEF - Static variable in class org.onehippo.forge.pageflow.hst.def.impl.RepositoryMapPageFlowDefinitionRegistry

O

onEvent(EventIterator) - Method in class org.onehippo.forge.pageflow.hst.def.impl.PageFlowDefinitionEventListener
onEventListenersContainerRefreshed() - Method in class org.onehippo.forge.pageflow.hst.def.impl.PageFlowDefinitionEventListener
onEventListenersContainerStarted() - Method in class org.onehippo.forge.pageflow.hst.def.impl.PageFlowDefinitionEventListener
onEventListenersContainerStopped() - Method in class org.onehippo.forge.pageflow.hst.def.impl.PageFlowDefinitionEventListener
org.onehippo.forge.pageflow.cms.editor.field - package org.onehippo.forge.pageflow.cms.editor.field: The CMS Authoring Plugin Package for some custom editor picker plugins for Page Flow Definition documents.
org.onehippo.forge.pageflow.core - package org.onehippo.forge.pageflow.core: The core APIs of Page Flow Module.
org.onehippo.forge.pageflow.core.def - package org.onehippo.forge.pageflow.core.def: The core APIs of Page Flow Definitions.
org.onehippo.forge.pageflow.core.def.impl - package org.onehippo.forge.pageflow.core.def.impl: The Implementation for core APIs of Page Flow Definitions.
org.onehippo.forge.pageflow.core.rt - package org.onehippo.forge.pageflow.core.rt: The core APIs of Page Flow Runtime.
org.onehippo.forge.pageflow.core.rt.impl - package org.onehippo.forge.pageflow.core.rt.impl: The Implementation for core APIs of Page Flow Runtime.
org.onehippo.forge.pageflow.hst - package org.onehippo.forge.pageflow.hst: The HST Delivery tier modules that helps apply Page Flow Module in HST-based web applications.
org.onehippo.forge.pageflow.hst.channel - package org.onehippo.forge.pageflow.hst.channel: The default ChannelInfo definition(s) for a channel integrated with Page Flow Module.
org.onehippo.forge.pageflow.hst.def.impl - package org.onehippo.forge.pageflow.hst.def.impl: JCR and HST based Page Flow Definition implementation package.
org.onehippo.forge.pageflow.hst.sitemapitemhandler - package org.onehippo.forge.pageflow.hst.sitemapitemhandler: HstSiteMapItemHandler implementation(s) to integrate an HST based web application with Page Flow Module.

P

PAGE_FLOW_CONTROL_ATTR_NAME - Static variable in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl: The servlet context or request attribute name by which a PageFlowControl instance is stored for an application.
PAGE_FLOW_ID_ATTR_NAME - Static variable in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl
PAGE_FLOW_ID_PROP_NAME - Static variable in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl: The request parameter name by which the identifier of a PageFlow could be inferred if provided.
PageFlow - Interface in org.onehippo.forge.pageflow.core.rt: Page Flow runtime abstraction.
PageFlowControl - Interface in org.onehippo.forge.pageflow.core.rt: Page Flow Control abstraction, which provides applications with an easier way to retrieve the current PageFlow instance from the HttpServletRequest, to send redirection to a specific PageState and to complete a PageFlow.
PageFlowDefinition - Interface in org.onehippo.forge.pageflow.core.def: Page Flow Definition abstraction.
PageFlowDefinitionEventListener - Class in org.onehippo.forge.pageflow.hst.def.impl: JCR Observation Event listener to unregister Page Flow Definitions from the registry on definition content changes in JCR.
PageFlowDefinitionEventListener(PageFlowDefinitionRegistry) - Constructor for class org.onehippo.forge.pageflow.hst.def.impl.PageFlowDefinitionEventListener
PageFlowDefinitionRegistry - Interface in org.onehippo.forge.pageflow.core.def: Page Flow Definition Registry abstraction which is responsible for retrieval, removing or clearing PageFlowDefinition instances.
PageFlowException - Exception in org.onehippo.forge.pageflow.core: Generic Page Flow Exception.
PageFlowException() - Constructor for exception org.onehippo.forge.pageflow.core.PageFlowException
PageFlowException(String) - Constructor for exception org.onehippo.forge.pageflow.core.PageFlowException
PageFlowException(String, Throwable) - Constructor for exception org.onehippo.forge.pageflow.core.PageFlowException
PageFlowException(Throwable) - Constructor for exception org.onehippo.forge.pageflow.core.PageFlowException
PageFlowFactory - Interface in org.onehippo.forge.pageflow.core.rt: Factory abstraction which is responsible for creating a PageFlow instance from a PageFlowDefinition.
PageFlowSiteInfo - Interface in org.onehippo.forge.pageflow.hst.channel: Default Page Flow module based ChannelInfo definition, allowing to configure the identifier of the default Page Flow of the channel and the default resource bundle ID(s) (as comma separated string) for the channel.
PageFlowStore - Interface in org.onehippo.forge.pageflow.core.rt: Backend Page Flow Store abstraction.
PageState - Interface in org.onehippo.forge.pageflow.core.rt: Page State runtime abstraction, which is part of a PageFlow.
PageStateDefinition - Interface in org.onehippo.forge.pageflow.core.def: Page State Definition abstraction which is part of a Page Flow Definition.
PageStateInfo - Class in org.onehippo.forge.pageflow.cms.editor.field: Page State Information model.
PageStateInfo() - Constructor for class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
PageStateInfo(String, String) - Constructor for class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
PageTransitionDefinition - Interface in org.onehippo.forge.pageflow.core.def: Page Transition Definition abstraction, defining the source event name and target PageStateDefinition's ID.
PARAM_AUTO_REDIRECTION_ENABLED - Static variable in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler
PARAM_ENABLED - Static variable in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler
process(ResolvedSiteMapItem, HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler
processDefaultResolvedSiteMapItem(HttpServletRequest, HttpServletResponse, FilterChain, ResolvedSiteMapItem) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler: Process the current resolved sitemap item by the default behavior, without any custom behavior from Page Flow Module.

R

removeAllPageStateDefinitions() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
removeErrors(String) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
removeErrors(String) - Method in interface org.onehippo.forge.pageflow.core.rt.PageState: Remove the application specific Errors by the name from this PageState.
removeItem(ErrorItem) - Method in interface org.onehippo.forge.pageflow.core.rt.Errors: Remove the given ErrorItem (item) from this Errors.
removeItem(ErrorItem) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
removePageFlow(HttpServletRequest, String) - Method in class org.onehippo.forge.pageflow.core.rt.impl.HttpSessionPageFlowStore
removePageFlow(HttpServletRequest, String) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowStore: Remove the associated pageFlow from the backend storage by the flowId.
removePageFlowDefinition(String) - Method in class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry
removePageFlowDefinition(String) - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinitionRegistry: Remove the PageFlowDefinition by the identifier (flowId) of the PageFlowDefinition.
removePageFlowDefinitionByUuid(String) - Method in class org.onehippo.forge.pageflow.core.def.impl.MapPageFlowDefinitionRegistry
removePageFlowDefinitionByUuid(String) - Method in interface org.onehippo.forge.pageflow.core.def.PageFlowDefinitionRegistry: Remove the PageFlowDefinition by the optional uuid of the PageFlowDefinition.
removePageStateDefinition(PageStateDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
removePageTransitionDefinition(PageTransitionDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
removePageTransitionDefinition(PageTransitionDefinition) - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
RepositoryMapPageFlowDefinitionRegistry - Class in org.onehippo.forge.pageflow.hst.def.impl: Generic purpose JCR based PageFlowDefinitionRegistry implementation.
RepositoryMapPageFlowDefinitionRegistry() - Constructor for class org.onehippo.forge.pageflow.hst.def.impl.RepositoryMapPageFlowDefinitionRegistry

S

searchExternalDocuments(ExternalDocumentServiceContext, String) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
searchExternalDocuments(ExternalDocumentServiceContext, String) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade
sendEvent(String) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
sendEvent(String) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Send an event to the PageFlow, which might cause a Page Transition as a result.
sendRedirect(HttpServletRequest, HttpServletResponse, PageState) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
sendRedirect(HttpServletRequest, HttpServletResponse, PageState) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowControl
sendRedirect(HttpServletRequest, HttpServletResponse, PageState) - Method in class org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultHstPageFlowControl
setAttribute(String, Object) - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
setAttribute(String, Object) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Set the attribute by the name on this PageFlow.
setFieldExternalDocuments(ExternalDocumentServiceContext, ExternalDocumentCollection<EventDefInfo>) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
setFieldExternalDocuments(ExternalDocumentServiceContext, ExternalDocumentCollection<PageStateInfo>) - Method in class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade
setLabel(String) - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
setName(String) - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
setName(String) - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
setPageFlowDefinitionRegistry(PageFlowDefinitionRegistry) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
setPageFlowFactory(PageFlowFactory) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
setPageFlowStore(PageFlowStore) - Method in class org.onehippo.forge.pageflow.core.rt.DefaultPageFlowControl
setStateId(String) - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
start() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
start() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Start this PageFlow instance.
stop() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
stop() - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlow: Stop this PageFlow instance.
storePageFlow(HttpServletRequest, String, PageFlow) - Method in class org.onehippo.forge.pageflow.core.rt.impl.HttpSessionPageFlowStore
storePageFlow(HttpServletRequest, String, PageFlow) - Method in interface org.onehippo.forge.pageflow.core.rt.PageFlowStore: Store the pageFlow into the backend storage by the flowId.

T

toString() - Method in class org.onehippo.forge.pageflow.cms.editor.field.EventDefInfo
toString() - Method in class org.onehippo.forge.pageflow.cms.editor.field.PageStateInfo
toString() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageFlowDefinition
toString() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageStateDefinition
toString() - Method in class org.onehippo.forge.pageflow.core.def.impl.DefaultPageTransitionDefinition
toString() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrorItem
toString() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultErrors
toString() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageFlow
toString() - Method in class org.onehippo.forge.pageflow.core.rt.impl.DefaultPageState
TransitionSourceEventDefServiceFacade - Class in org.onehippo.forge.pageflow.cms.editor.field: ExternalDocumentServiceFacade implementation to retrieve/select Page Flow Transition Source Event.
TransitionSourceEventDefServiceFacade() - Constructor for class org.onehippo.forge.pageflow.cms.editor.field.TransitionSourceEventDefServiceFacade
TransitionTargetPageStateServiceFacade - Class in org.onehippo.forge.pageflow.cms.editor.field: ExternalDocumentServiceFacade implementation to retrieve/select Page Flow Transition Target Page State.
TransitionTargetPageStateServiceFacade() - Constructor for class org.onehippo.forge.pageflow.cms.editor.field.TransitionTargetPageStateServiceFacade

A C D E F G H I M N O P R S T
All Classes All Packages