All Superinterfaces:

IParameters

All Known Implementing Classes:

AbstractServiceInstanceCustomPropertiesProcessActionHandler, ActivateRevertDefaultConfigurationProcessActionHandler, ActivityStreamDeleteProcessActionHandler, ActivityStreamObjectTypesCustomPropertyProcessActionHandler, ActivityStreamScopesCustomPropertyProcessActionHandler, AddActivityProcessorProcessActionHandler, AddChatRoomProcessActionHandler, AddCommunityProcessActionHandler, AddFormAnswerProcessActionHandler, AddFormFieldProcessActionHandler, AddFormProcessActionHandler, AddItemActionHandler, AddMemberProcessActionHandler, AddMobileAppProcessActionHandler, AddPrincipalProcessActionHandler, AddProcessActionHandler, AddQuestionaireAnswerProcessActionHandler, AddQuestionaireProcessActionHandler, AddSeoRuleProcessActionHandler, AddSocialNetworkProcessActionHandler, AddTagProcessActionHandler, AddTransformationParametersProcessActionHandler, AddTreeExclusionProcessActionHandler, AddTreeItemProcessActionHandler, AddVariantProcessActionHandler, AddWidgetProcessActionHandler, AlbumAddMultipleProcessActionHandler, AnonymizeAllUsersWithoutConsentProcessActionHandler, APMMetricProcessActionHandler, ApplicationAccountProcessActionHandler, AssociationProcessActionHandler, AuditConfigProcessActionHandler, AuditProcessActionHandler, BannerAddDataProcessActionHandler, BannerDeleteDataProcessActionHandler, BannerProcessActionHandler, BannerUpdateDataProcessActionHandler, BaseImportLecProcessActionHandler, BaseSourceProcessActionHandler, BaseTableDataProcessActionHandler, BoostSearchProcessActionHandler, BreadCrumbPropertiesProcessActionHandler, BusinessContexPropertyBagProcessAction, BusinessContextProcessActionHandler, CacheProcessActionHandler, CallerInterfaceInstancePreferencesProcessActionHandler, CancelPublicSubscriptionProcessActionHandler, ChangeProcessPurposeProcessActionHandler, ChannelAclProcessActionHandler, ChannelProcessActionHandler, CheckAlbumAccessProcessActionHandler, CheckAlbumDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckDuplicateFolderProcessActionHandler, CheckDuplicateFolderProcessActionHandler, CheckUpdatePageSSIPropertyProcessActionHandler, ClockProcessActionHandler, ClonePortletProcessActionHandler, ClusterProcessActionHandler, ColProcessActionHandler, CommitAndPreviewProcessActionHandler, CommunityMemberProcessActionHandler, CommunityMembershipRequestProcessActionHandler, CommunityProcessActionHandler, ConfigurationProcessActionHandler, ConfigureURLShortenerProcessActionHandler, ConsumerConfigurationInterfaceProcessActionHandler, ContactUsMailProcessActionHandler, ContentAssociationProcessActionHandler, ContentLockProcessActionHandler, ContentLockProcessActionHandler, ContentTableAddDataProcessActionHandler, ContentTableAddFileMultiRowDataProcessActionHandler, ContentTableDeleteDataProcessActionHandler, ContentTableSourceAddDataProcessActionHandler, ContentTableSourceDeleteDataProcessActionHandler, ContentTableSourceUpdateDataProcessActionHandler, ContentTableUpdateDataProcessActionHandler, ContentWizardDeleteProcessActionHandler, CreateOrOverrideAutomationFlowProcessAction, CreateOrOverrideSegmentationProcessAction, CssProcessActionHandler, DatabaseViewGroupProcessActionHandler, DatabaseViewGroupTypeProcessActionHandler, DeleteActivityProcessActionHandler, DeleteActivityProcessorProcessActionHandler, DeleteApplicationProcessActionHandler, DeleteCommentProcessActionHandler, DeleteCommunityProcessActionHandler, DeleteMobileAppProcessActionHandler, DeleteProcessActionHandler, DeleteProcessActionHandler, DeleteQuestionnaireProcessActionHandler, DeleteQueueTaskProcessActionHandler, DeleteRelationCommentProcessActionHandler, DeleteReportProcessActionHandler, DeleteTermProcessActionHandler, DeleteTreeExclusionProcessActionHandler, DeleteTreeItemProcessActionHandler, DeleteTreeProcessActionHandler, DeleteUserJourneyInstanceProcessAction, DeleteWidgetProcessActionHandler, DeploymentProcessActionHandler, DeploymentProcessActionHandler, DetailsProcessActionHandler, DisableMonitoringProcessActionHandler, DocumentAddMultipleProcessActionHandler, DocumentDeleteProcessActionHandler, DocumentMoveProcessActionHandler, DocumentSelectProcessActionHandler, DouiRestInterfaceCachePropertiesProcessActionHandler, EditChatRoomProcessActionHandler, EditContentSeoProcessActionHandler, EditDashboardProcessActionHandler, EditImageProcessActionHandler, EditLifetimeProcessActionHandler, EditMobileAppProcessActionHandler, EditReportProcessActionHandler, EditTagProcessActionHandler, EditTransformationParametersProcessActionHandler, EditTreeExclusionProcessActionHandler, EditTreeItemProcessActionHandler, EditTreeProcessActionHandler, EditVariantProcessActionHandler, EncryptTextProcessActionHandler, ExecuteWorkflowActionProcessActionHandler, ExportProcessActionHandler, ExportStructureProcessActionHandler, FieldsProcessActionHandler, FileListAddProcessActionHandler, FileListEditProcessActionHandler, FileMacrotypeMappingProcessActionHandler, FileSystemProcessActionHandler, FiltersProcessActionHandler, ForceToPublishSynonymsProcessActionHandler, FormBuilderAddContentProcessActionHandler, FormBuilderValidateContentProcessActionHandler, ForumProcessActionHandler, GenerateDocumentationProcessActionHandler, GenerateSitemapProcessActionHandler, GenericAclActionHandler, GenericAclProcessActionHandler, GenericProcessActionHandler, GroupAclProcessActionHandler, GroupProcessActionHandler, GroupProcessActionHandler, GroupTypeProcessActionHandler, HierarchicalAddContentProcessActionHandler, HierarchicalContentClearServiceCacheProcessActionHandler, HierarchicalContentDeleteDataProcessActionHandler, HierarchicalContentHierarchyValidationProcessActionHandler, HierarchicalValidateContentProcessActionHandler, HtmlEditProcessActionHandler, HtmlProcessActionHandler, HtmlTemplateProcessActionHandler, ImportContentServiceInstanceProcessActionHandler, ImportPrincipalsProcessActionHandler, ImportProcessActionHandler, InterfaceHolderPropertiesProcessActionHandler, InterfaceInstanceCustomPropertiesProcessActionHandler, LanguageProcessActionHandler, LinkTranslatorProcessActionHandler, LoadMediasProcessActionHandler, LocaleConfigProcessActionHandler, LocaleProcessActionHandler, LockProcessActionHandler, LoginProcessActionHandler, MailMarketingBulletinAddDataProcessActionHandler, MailMarketingBulletinUpdateDataProcessActionHandler, MailMarketingSendTestEmailProcessActionHandler, MaxRowsProcessActionHandler, MediaAddMultipleProcessActionHandler, MediaAddMultipleProcessActionHandler, MediaAddProcessActionHandler, MediaAddPublicProcessActionHandler, MediaApproveProcessActionHandler, MediaDeleteProcessActionHandler, MediaDeleteProcessActionHandler, MediaMoveProcessActionHandler, MediaReorderProcessActionHandler, MediaSelectProcessActionHandler, MediaUpdateProcessActionHandler, MessageProcessActionHandler, MicroblogAttachmentsProcessActionHandler, MicroblogCommentProcessActionHandler, MicroblogHashProcessActionHandler, MicroblogPostsProcessActionHandler, MicroblogUserFollowsProcessActionHandler, MonitorConfigurationProcessActionHandler, MonitorEventProcessActionHandler, NavigationAddContentProcessActionHandler, NavigationProcessActionHandler, NavigationValidateContentProcessActionHandler, NewArticleLinkProcessActionHandler, NewsletterModelAdminProcessActionHandler, ObserverProcessActionHandler, OrderByActionHandler, OutbandRegistrationInterfaceProcessActionHandler, PageAclProcessActionHandler, PageCacheProcessActionHandler, PageLinkProcessActionHandler, PagePersonalizationContentTableAddProcessActionHandler, PagePersonalizationContentTableEditProcessActionHandler, PageProcessActionHandler, PageTemplateAclProcessActionHandler, PageTemplateProcessActionHandler, ParticipateProcessActionHandler, PortalAclProcessActionHandler, PortletDeploymentProcessActionHandler, PositionFieldUpdateProcessActionHandler, PostAddProcessActionHandler, PostEditProcessActionHandler, PrintProcessActionHandler, ProcessActionHandler, ProcessAnswerProcessActionHandler, ProducerAddInterfaceInstanceProcessActionHandler, ProducerAdministrationListDeleteProcessActionHandler, ProducerConfigurationInterfaceProcessActionHandler, PropertyBagProcessActionHandler, PublisherFiltersProcessActionHandler, PublishHeritageProcessActionHandler, PublishHeritageProcessActionHandler, PublishProcessActionHandler, PublishToPrincipalsProcessActionHandler, PublishToServiceInstancesProcessActionHandler, PublishToSocialNetworksProcessActionHandler, ReadPrincipalsProcessActionHandler, RecalculatePopularitiesProcessActionHandler, RecoverProcessActionHandler, RegisterControlProcessActionHandler, RegisterMenuTypesProcessActionHandler, RegisterServiceProcessActionHandler, RegisterServiceTypesProcessActionHandler, RegistrationAdministrationListDeleteProcessActionHandler, ReindexProcessActionHandler, RemotePortletConfigurationInterfaceProcessActionHandler, RemoveCloneProcessActionHandler, ReprocessFileTransformation, ReprocessQueueTaskProcessActionHandler, ResetPageProcessActionHandler, ResourceValidatorProcessActionHandler, RobotsTxtSitemapNameProcessActionHandler, RobotsTxtUserAgentNameProcessActionHandler, RoomDeleteValidatorProcessActionHandler, RssProcessActionHandler, ScheduleClearCacheProcessActionHandler, ScheduleValidatorProcessActionHandler, SearchFacetPropertiesProcessActionHandler, SearchProcessActionHandler, SearchPropertiesProcessActionHandler, SearchScopeProcessActionHandler, SelectAccountServiceInstanceProcessActionHandler, SelectImagesProcessActionHandler, SelectImportFileProcessActionHandler, SelectPrincipalProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRootChannelProcessActionHandler, SelectWorkflowServiceInstanceProcessActionHandler, SendMailProcessActionHandler, SendTestEmailProcessActionHandler, SendToFriendMailProcessActionHandler, SeoAfterCommitProcesActionHandler, SerializationProcessActionHandler, ServerConfigurationProcessActionHandler, ServiceAclProcessActionHandler, ServiceInstanceAclProcessActionHandler, ServiceInstanceCustomPropertiesProcessActionHandler, ServiceInstanceProcessActionHandler, ServiceInstanceTransformationProcessActionHandler, ServiceInterfaceInstancePropertiesProcessActionHandler, SetActivitiesAgeLimitProcessActionHandler, SetCommentTotalInfoProcessActionHandler, SetContactRequestCategoryNullProcessActionHandler, SetMainArticleProcessActionHandler, SetMetaDataInfoProcessActionHandler, SetValuesProcessActionHandler, SocialNetworkAuthenticationProcessActionHandler, SocialNetworkCallbackProcessActionHandler, SocialNetworkFacebookPublicationTokenProcessActionHandler, SocialProfileUpdateProcessActionHandler, SourceAddDataProcessActionHandler, SourceAddFileMultiRowDataProcessActionHandler, SourceAddMultiRowDataProcessActionHandler, SourceDeleteDataProcessActionHandler, SourceUpdateDataProcessActionHandler, SourceUpdateMultiRowDataProcessActionHandler, StructureEditorProcessActionHandler, TableAddDataProcessActionHandler, TableAddFileMultiRowDataProcessActionHandler, TableAddMultiRowDataProcessActionHandler, TableDeleteDataProcessActionHandler, TableUpdateDataProcessActionHandler, TableUpdateMultiRowDataProcessActionHandler, TestAutomationProcessActionHandler, ThemeProcessActionHandler, TogglePreviewModeProcessActionHandler, TransformFilesProcessActionHandler, UniqueMimeTypeValidatorProcessActionHandler, UpdateActivityProcessorProcessActionHandler, UpdateCategorizationRepositoryProcessActionHandler, UpdateChannelsProcessActionHandler, UpdateCommunityProcessActionHandler, UpdateConfigurationProcessActionHandler, UpdateFormFieldProcessActionHandler, UpdateFormProcessActionHandler, UpdateMetadataProcessActionHandler, UpdatePopularitiesConfigProcessActionHandler, UpdatePrivacyTermRepositoryProcessActionHandler, UpdateProcessActionHandler, UpdateQuestionaireProcessActionHandler, UpdateTermsParentProcessActionHandler, UpgradePortalProcessActionHandler, URLAccessibilityEvaluationProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserPostDeleteProcessActionHandler, UserProcessActionHandler, UserProcessActionHandler, UserSubscriptionProcessActionHandler, UserSubscriptionProcessActionHandler, ValidateArticleDeletionProcessActionHandler, ValidateArticleTitleProcessActionHandler, ValidateContentReferencesProcessActionHandler, ValidateExperimentProcessActionHandler, ValuesValidatorProcessAction, VersionProcessActionHandler, VoteProcessActionHandler, WebFileReplicationProcessActionHandler, WebPageProcessActionHandler, WebResourceServiceProcessActionHandler, WebServiceViewerConfigurationProcessActionHandler, WebServiceViewerParametersProcessActionHandler, WebsiteProcessActionHandler, WidgetSelectProcessActionHandler, WikiArticleSelectProcessActionHandler, WorkflowProcessActionHandler, WorkflowServiceInstanceAclProcessActionHandler, XslCacheProcessActionHandler, XslEditorProcessActionHandler
```
@StableMinor(version="14.0",
             sinceVersion="10.4")
public interface IProcessActionHandler
extends IParameters
```
All process action handlers must extend this interface.

Since:

4.0.0

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getId()`	Returns the identifier for the process action handler.
`Object`	`getParameter(String name)`	Returns the parameter value.
`<T> T`	`getParameter(String name, Class<T> expectedClass)`	Returns the parameter value converted to the expected class.
`void`	`init(Node processActionNode, ProcessActionContainer processActionContainer)`	Called by the process action container to initialize the process action.
`void`	`processAction()`	Executes the process action.
`void`	`setParameter(String name, Object value)`	All controls pass their values to a process action object via this method.

Methods inherited from interface lumis.util.parameter.IParameters
containsParameter

- Method Detail
  - init
```
void init(Node processActionNode,
          ProcessActionContainer processActionContainer)
   throws PortalException
```
    Called by the process action container to initialize the process action.
    The process action node is a copy of the node specified in the doui definition.
    
    Parameters:
    
    processActionNode -
    
    processActionContainer -
    
    Throws:
    
    PortalException
    
    Since:
    
    4.0.0
  - getId
```
String getId()
      throws PortalException
```
    Returns the identifier for the process action handler.
    
    Returns:
    
    the process action identifier.
    
    Throws:
    
    PortalException
    
    Since:
    
    5.0.0
  - processAction
```
void processAction()
            throws PortalException
```
    Executes the process action.
    This method may execute the process action based on the parameters and node specifications passed to it earlier.
    
    Throws:
    
    PortalException
    
    Since:
    
    4.0.0
  - setParameter
```
void setParameter(String name,
                  Object value)
```
    All controls pass their values to a process action object via this method.
    The controls call this method before the processAction() method is called.
    
    Parameters:
    
    name -
    
    value -
    
    Since:
    
    4.0.0
  - getParameter
```
Object getParameter(String name)
```
    Returns the parameter value.
    
    Specified by:
    
    getParameter in interface IParameters
    
    Parameters:
    
    name -
    
    Returns:
    
    Since:
    
    4.0.0
  - getParameter
```
<T> T getParameter(String name,
                   Class<T> expectedClass)
```
    Returns the parameter value converted to the expected class.
    
    Type Parameters:
    
    T - the expected class.
    
    Parameters:
    
    name - the parameter name.
    
    expectedClass - the expected class.
    
    Returns:
    
    the parameter value, converted to the expected class, or null if there is no such parameter value set.
    
    Since:
    
    4.0.4

Interface IProcessActionHandler

Method Summary

Methods inherited from interface lumis.util.parameter.IParameters

Method Detail

init

getId

processAction

setParameter

getParameter

getParameter