lumis.content.control.workflow

Class WorkflowMetaDataControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl<ContentTableSource>

lumis.content.control.workflow.WorkflowMetaDataControl

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

AutoLayoutWorkflowInformationControl, WorkflowActionControl, WorkflowAssignedToControl, WorkflowSendToControl, WorkflowStateControl

public abstract class WorkflowMetaDataControl
extends DataBoundControl<ContentTableSource>

Base control for controls that uses data in the content workflow meta data. This class contains methods that gives access to the current content workflow meta data.

Since:

4.0.0

Version:

$Revision: 16037 $ $Date: 2013-11-21 22:58:50 +0000 (Thu, 21 Nov 2013) $

Field Summary

Fields

Modifier and Type	Field and Description
protected String	primaryKeyFieldId
protected WorkflowConfig	workflow

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor and Description
WorkflowMetaDataControl()

Method Summary

Modifier and Type	Method and Description
void	buildSubControls()
protected ContentWorkflowMetaData	getContentWorkflowMetaData() Returns the content workflow metadata.
protected ContentWorkflowMetaData	getContentWorkflowMetaData(ContentTableSource source)
protected String	getItemId()
List<IResource>	getResources() Returns the localization resources to be used in the value render.
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
protected void	setValueFromSource(ContentTableSource source) Reads the value corresponding to the current control from the control source.

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRequestHelpDefinition, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, loadFromRequest, setDefaultValue, setRawValue, setReload, setRenderData, setSourceParameter, setValid, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getRequestParameterName, getValue, getValue, getValueClass, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setSourceParameter, setSourceParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getScriptActionValidation, getStringsToLocalize, getType, getValidationScript, getWindowProperties, getWindowProperties, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getControlResource, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Field Detail

primaryKeyFieldId

protected String primaryKeyFieldId

workflow

protected WorkflowConfig workflow

Constructor Detail

WorkflowMetaDataControl

public WorkflowMetaDataControl()

Method Detail

getItemId

protected String getItemId()
                    throws PortalException

Throws:

PortalException

getContentWorkflowMetaData

protected ContentWorkflowMetaData getContentWorkflowMetaData(ContentTableSource source)
                                                      throws PortalException

Throws:

PortalException

getContentWorkflowMetaData

protected ContentWorkflowMetaData getContentWorkflowMetaData()
                                                      throws PortalException

Returns the content workflow metadata. The content workflow metadata will be available through this method only after the DataBoundControl.setValueFromSource(Source) method has executed.

Throws:

PortalException

init

public void init(Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException

Specified by:

init in interface IControl

Overrides:

init in class DataBoundControl<ContentTableSource>

Throws:

PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl<ContentTableSource>

Throws:

PortalException

setValueFromSource

protected void setValueFromSource(ContentTableSource source)
                           throws PortalException

Description copied from class: DataBoundControl

Reads the value corresponding to the current control from the control source. By default the value that is taken from the source is from the first row of the source tabular data. However, if the control has the dataRow specified, the value taken from the source tabular data corresponds to specified row.

Overrides:

setValueFromSource in class DataBoundControl<ContentTableSource>

Throws:

PortalException

getResources

public List<IResource> getResources()
                             throws PortalException

Description copied from interface: IRenderer

Returns the localization resources to be used in the value render.

Specified by:

getResources in interface IControl

Specified by:

getResources in interface IRenderer

Overrides:

getResources in class Control

Returns:

the localization resources to be used in the value render.

Throws:

PortalException