Package lumis.doui.control

Interface IDataControl

All Superinterfaces:

IControl

All Known Subinterfaces:

IDataBoundControl

All Known Implementing Classes:

AccessErrorMessageTranslator, AccountServiceInstancePaneControl, AddDynamicListSourceControl, AddHtmlSnippetIsAiEnabledControl, AddHtmlSnippetTabularDataControl, AdvancedTabularDataControl, AllFieldGroupsControl, AllFieldsControl, AnnouncementTabularDataControl, AreaTagsControl, AssociationTabularDataControl, AutoAdministrationBreadCrumbTreeItemControl, AutoLayoutAssociationInformationControl, AutoLayoutGenericAssociationInformationControl, AutoLayoutWorkflowInformationControl, AutoRefreshControl, BusinessContextForCacheAdvancedTabularDataControl, CalendarControl, ChannelAclControl, ChannelInheritedPageTemplateControl, ChatMessageListControl, ChatSendMessageControl, CheckBoxControl, CheckBoxListControl, CommentAreaListControl, CommentsControl, CommunityTabularDataControl, ConfigurationTagsControl, ConsumerConfigurationInterfaceDropDownListControl, ContentIdHolderControl, ContentPickerControl, CurrentContentLocaleIdControl, CustomerExperienceCommonsControl, CustomHtmlInputControl, CustomHtmlInputSubControl, CustomInputHiddenControl, CustomInputTextAreaControl, DataBoundControl, DataControl, DataGridControl, DateTimePickerControl, DefaultPageTemplateControl, DetailsControl, DocumentPickerControl, DropDownListControl, DynamicListControl, EditServiceInstanceTabbedControl, EmailControl, EnviromentPropertiesControl, ErrorSummaryControl, EventAnalyticsControl, FieldsControl, FilesPickerControl, FileSystemTabularData, FileUploadControl, FlowEditorControl, ForumMessageListInputHiddenControl, ForumMessageListPaginationControl, GenericAclControl, GroupAclControl, HierarchicalContentHtmlTextAreaControl, HierarchicalTabularDataControl, HtmlEditorControl, InputCategoryControl, InputEmailControl, InputHiddenControl, InputProfileImageControl, InputTagControl, InputTextAreaControl, InputTextControl, InputTextProxyControl, InterfaceInstanceInContextEditSupportControl, InterfaceSelectionDropDownListControl, ItemPickerControl, LanguageControl, LanguageFilterControl, LastContentsAdvancedTabularDataControl, LastWeekDateTimePickerControl, LazySourceDropDownListControl, LicenseTypeInputHiddenControl, LinkTabularDataControl, LinkToRuntimeTabularDataControl, LinkToRuntimeTabularDataControl, LoadTransformationFromDataBaseControl, LocalePickerControl, LogoutOriginalWebResourcePathInputHiddenControl, MediaPickerControl, MonthPickerControl, MultiFileUploadControl, MultiItemPickerControl, NavigationControl, NavigationHtmlTextAreaControl, OptionListControl, OrderedMultiItemPickerControl, PageAclControl, PageCacheConfirmMessageControl, PageTemplateAclControl, PaginationControl, PaneControl, PasswordControl, PortalAclControl, PrimaryKeyControl, PrincipalPickerControl, ProducerAdminListTabularDataControl, ProducerConfigurationInterfaceVersionDropDownListControl, ProgressControl, ProgressPanelControl, PublisherFiltersAutoLayoutFieldsControl, PublishToPrincipalsControl, PublishToPrincipalsListControl, PublishToServiceInstancesControl, PublishToServiceInstancesListControl, PublishToSocialNetworkControl, RadioButtonControl, RadioButtonListControl, ScheduleDateTimePickerControl, ScheduleStartDateTimePickerControl, SearchAggregationControl, SearchOrderByDropDownListControl, SearchQueryInputText, SelectAccountServiceInstanceAdvancedTabularDataControl, SelectChannelChildControl, SelectChannelControl, SelectChannelControl, SelectChannelOrChannelTemplateControl, SelectChannelOrChannelTemplateControlWithCustomCallbackFunction, SelectChannelTemplateControl, SelectContentParentContentControl, SelectDocumentServiceInstanceControl, SelectEmailTemplateServiceInstanceControl, SelectImportFileControl, SelectItemTabularDataControl, SelectMediaServiceInstanceControl, SelectMFAServiceInstanceControl, SelectPageControl, SelectPageControl, SelectPageOrPageTemplateControl, SelectPagePersonalizationServiceInstanceControl, SelectPageTemplateControl, SelectParentContentControl, SelectParentContentTreeControl, SelectServiceInstanceControl, SelectTagServiceInstanceControl, SelectWebsiteChannelControl, SelectWorkflowControl, ServiceAclControl, ServiceInstanceAclControl, ServiceInstancePrincipalPickerControl, ServiceInterfacePickerControl, ServiceReindexProgressControl, SetWebsiteNameFromChannelControl, TabbedControl, TabularDataControl, TagControl, TermDynamicListControl, TermPickerControl, TextControl, TimePickerControl, TreeLanguageFilterControl, UserEmailVerifierControl, UserEmailVerifierControl, UserSegmentationControl, VersionControl, VersionNumberInputHiddenControl, WebFileReplicationPropertiesControl, WebsiteURLControl, WikiViewArticlePaneControl, WorkflowActionControl, WorkflowActionControl, WorkflowAssignedToControl, WorkflowAssignedToControl, WorkflowAssignedToFilterControl, WorkflowMetaDataControl, WorkflowMetaDataControl, WorkflowSendToControl, WorkflowSendToControl, WorkflowServiceInstanceAclControl, WorkflowStateControl, WorkflowStateControl, WorkflowStateFilterControl, WorkflowStatusAdvancedTabularDataControl, WSRPCheckBoxListControl, XslEditorControl, XslFileEditorControl

@StableMinor(version="17.0",
             sinceVersion="4.0")
public interface IDataControl
extends IControl

Control that holds data

Since:

4.0.4

Version:

$Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

Method Summary

Modifier and Type	Method	Description
IConverter	getConverter()	Returns the converter that is able to convert this control's value.
java.util.Set<java.lang.String>	getProcessActionIds()	Returns the process action identifiers for which this control sets parameters to.
IDataControlRequestHelpDefinition	getRequestHelpDefinition()	Returns the request parameters help definition.
java.lang.Object	getValue()
<T> T	getValue(java.lang.Class<T> expectedClass)
void	loadFromRequest()
void	setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)	Sets the control parameters for the process action handler.
void	setValue(java.lang.Object value)

Methods inherited from interface lumis.doui.control.IControl

buildSubControls, createContainer, disconnect, getChildControls, getControlResource, getId, getName, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, init, isValid, registerOnEventScript, removeChild, removeChildren, setRenderData, setRuntimeAttributes, setValid

Method Detail

loadFromRequest

void loadFromRequest()
              throws PortalException

Throws:

PortalException

getValue

java.lang.Object getValue()
                   throws PortalException

Throws:

PortalException

getValue

<T> T getValue(java.lang.Class<T> expectedClass)
        throws PortalException

Throws:

PortalException

setValue

void setValue(java.lang.Object value)
       throws PortalException

Throws:

PortalException

getProcessActionIds

java.util.Set<java.lang.String> getProcessActionIds()
                                             throws PortalException

Returns the process action identifiers for which this control sets parameters to. A return value of null indicates that the control sets parameters in all process action handlers.

Returns:

the set of process action identifiers.

Throws:

PortalException

Since:

5.0.0

setProcessActionHandlerParameters

void setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)
                                throws PortalException

Sets the control parameters for the process action handler.

Parameters:

processActionHandler -

Throws:

PortalException

getConverter

IConverter getConverter()
                 throws PortalException

Returns the converter that is able to convert this control's value.

Returns:

the converter or null if this control has no converter.

Throws:

PortalException

Since:

4.0.4

getRequestHelpDefinition

IDataControlRequestHelpDefinition getRequestHelpDefinition()
                                                    throws PortalException

Returns the request parameters help definition. Used in process action REST API help. Must not return null.

Returns:

the request parameters help definition. Used in process action REST API help. Must not return null.

Throws:

PortalException

Since:

10.4.0