Package org.hippoecm.addon.workflow

Class StdWorkflow<T extends Workflow>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.hippoecm.addon.workflow.ActionDescription

org.hippoecm.addon.workflow.StdWorkflow<T>

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable, IWorkflowInvoker

Direct Known Subclasses:

BranchAwareStdWorkflow, CompatibilityWorkflowPlugin.WorkflowAction, FeedbackStdWorkflow

public abstract class StdWorkflow<T extends Workflow>
extends ActionDescription

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hippoecm.addon.workflow.ActionDescription

ActionDescription.ActionDisplay

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
StdWorkflow(String id, String name)
StdWorkflow(String id, String name, org.apache.wicket.request.resource.ResourceReference iconReference, IPluginContext pluginContext, RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)	Deprecated. Old-style constructor Use a constructor with explicit model argument.
StdWorkflow(String id, String name, IPluginContext pluginContext, RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)	Deprecated. Old-style constructor Use a constructor with explicit model argument.
StdWorkflow(String id, org.apache.wicket.model.IModel<String> name)
StdWorkflow(String id, org.apache.wicket.model.IModel<String> name, org.apache.wicket.request.resource.ResourceReference iconReference, WorkflowDescriptorModel model)
StdWorkflow(String id, org.apache.wicket.model.IModel<String> name, org.apache.wicket.request.resource.ResourceReference iconReference, IPluginContext pluginContext, WorkflowDescriptorModel model)
StdWorkflow(String id, org.apache.wicket.model.IModel<String> name, WorkflowDescriptorModel model)
StdWorkflow(String id, org.apache.wicket.model.IModel<String> name, IPluginContext pluginContext, WorkflowDescriptorModel model)
StdWorkflow(String id, org.apache.wicket.model.StringResourceModel name, org.apache.wicket.request.resource.ResourceReference iconReference, IPluginContext pluginContext, RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)	Deprecated. Old-style constructor Use a constructor with explicit model argument.
StdWorkflow(String id, org.apache.wicket.model.StringResourceModel name, IPluginContext pluginContext, RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)	Deprecated. Old-style constructor Use a constructor with explicit model argument.

Method Summary

Modifier and Type	Method	Description
protected IDialogService.Dialog	createRequestDialog()
protected IDialogService.Dialog	createResponseDialog(Exception ex)
protected IDialogService.Dialog	createResponseDialog(String message)
protected void	execute()
protected void	execute(WorkflowDescriptorModel model)
protected String	execute(T workflow)
protected org.apache.wicket.request.resource.ResourceReference	getIcon()	Deprecated. This method is deprecated in favor of getIcon(String id) which gives the developer the freedom to return a component like a HippoIcon if desired.
protected org.apache.wicket.Component	getIcon(String id)
WorkflowDescriptorModel	getModel()
protected final String	getName()
protected org.apache.wicket.model.IModel<String>	getTitle()
protected org.apache.wicket.model.IModel<String>	getTooltip()
protected void	invoke()
protected boolean	invokeOnFormError()
void	invokeWorkflow()
void	invokeWorkflowNoReject()
protected void	onDetach()

Methods inherited from class org.hippoecm.addon.workflow.ActionDescription

add, add, getCssClass, getFragment, getSubMenu, invokeAsPromise, isFormSubmitted, reject, resolve, run

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

StdWorkflow

@Deprecated
public StdWorkflow(String id,
 String name,
 IPluginContext pluginContext,
 RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)

Deprecated.

Old-style constructor Use a constructor with explicit model argument. The WorkflowDescriptorModel is available in workflow plugin constructor.

StdWorkflow

@Deprecated
public StdWorkflow(String id,
 org.apache.wicket.model.StringResourceModel name,
 IPluginContext pluginContext,
 RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)

Deprecated.

Old-style constructor Use a constructor with explicit model argument. The WorkflowDescriptorModel is available in workflow plugin constructor..

StdWorkflow

@Deprecated
public StdWorkflow(String id,
 org.apache.wicket.model.StringResourceModel name,
 org.apache.wicket.request.resource.ResourceReference iconReference,
 IPluginContext pluginContext,
 RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)

Deprecated.

Old-style constructor Use a constructor with explicit model argument. The WorkflowDescriptorModel is available in workflow plugin constructor..

StdWorkflow

@Deprecated
public StdWorkflow(String id,
 String name,
 org.apache.wicket.request.resource.ResourceReference iconReference,
 IPluginContext pluginContext,
 RenderPlugin<? extends WorkflowDescriptor> enclosingPlugin)

Deprecated.

Old-style constructor Use a constructor with explicit model argument. The WorkflowDescriptorModel is available in workflow plugin constructor..

StdWorkflow

public StdWorkflow(String id,
 String name)

StdWorkflow

public StdWorkflow(String id,
 org.apache.wicket.model.IModel<String> name)

StdWorkflow

public StdWorkflow(String id,
 org.apache.wicket.model.IModel<String> name,
 WorkflowDescriptorModel model)

StdWorkflow

public StdWorkflow(String id,
 org.apache.wicket.model.IModel<String> name,
 IPluginContext pluginContext,
 WorkflowDescriptorModel model)

StdWorkflow

public StdWorkflow(String id,
 org.apache.wicket.model.IModel<String> name,
 org.apache.wicket.request.resource.ResourceReference iconReference,
 WorkflowDescriptorModel model)

StdWorkflow

public StdWorkflow(String id,
 org.apache.wicket.model.IModel<String> name,
 org.apache.wicket.request.resource.ResourceReference iconReference,
 IPluginContext pluginContext,
 WorkflowDescriptorModel model)

Method Details

getModel

public WorkflowDescriptorModel getModel()

getName

protected final String getName()

getTitle

protected org.apache.wicket.model.IModel<String> getTitle()

getTooltip

protected org.apache.wicket.model.IModel<String> getTooltip()

getIcon

@Deprecated
protected org.apache.wicket.request.resource.ResourceReference getIcon()

Deprecated.

This method is deprecated in favor of getIcon(String id) which gives the developer the freedom to return a component like a HippoIcon if desired.

getIcon

protected org.apache.wicket.Component getIcon(String id)

createRequestDialog

protected IDialogService.Dialog createRequestDialog()

createResponseDialog

protected IDialogService.Dialog createResponseDialog(String message)

createResponseDialog

protected IDialogService.Dialog createResponseDialog(Exception ex)

invokeOnFormError

protected boolean invokeOnFormError()

invoke

protected void invoke()

Specified by:

invoke in class ActionDescription

execute

protected void execute()
                throws Exception

Throws:

Exception

execute

protected void execute(WorkflowDescriptorModel model)
                throws Exception

Throws:

Exception

execute

protected String execute(T workflow)
                  throws Exception

Throws:

Exception

invokeWorkflow

public void invokeWorkflow()
                    throws Exception

Specified by:

invokeWorkflow in interface IWorkflowInvoker

Overrides:

invokeWorkflow in class ActionDescription

Throws:

Exception

invokeWorkflowNoReject

public void invokeWorkflowNoReject()
                            throws Exception

Throws:

Exception

onDetach

protected void onDetach()

Overrides:

onDetach in class org.apache.wicket.MarkupContainer