lumis.doui.processaction
Interface IProcessActionHandler

All Known Implementing Classes:

AddChatRoomProcessActionHandler, AddItemActionHandler, AddPrincipalProcessActionHandler, AssociationProcessActionHandler, BannerAddDataProcessActionHandler, BannerDeleteDataProcessActionHandler, BannerProcessActionHandler, BannerUpdateDataProcessActionHandler, BaseTableDataProcessActionHandler, BreadCrumbPropertiesProcessActionHandler, CacheProcessActionHandler, CancelPublicSubscriptionProcessActionHandler, ChannelAclProcessActionHandler, ChannelProcessActionHandler, CheckAlbumAccessProcessActionHandler, CheckAlbumDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckDuplicateFolderProcessActionHandler, CheckDuplicateFolderProcessActionHandler, ClockProcessActionHandler, ClusterProcessActionHandler, ColProcessActionHandler, CommitAndPreviewProcessActionHandler, ConsumerConfigurationInterfaceProcessActionHandler, ContactUsMailProcessActionHandler, ContentAssociationProcessActionHandler, ContentTableAddDataProcessActionHandler, ContentTableDeleteDataProcessActionHandler, ContentTableUpdateDataProcessActionHandler, ContentWizardDeleteProcessActionHandler, CssProcessActionHandler, DatabaseViewGroupProcessActionHandler, DatabaseViewGroupTypeProcessActionHandler, DeleteChatRoomProcessActionHandler, DeleteProcessActionHandler, DeleteRelationCommentProcessActionHandler, DeploymentProcessActionHandler, DeploymentProcessActionHandler, DocumentDeleteProcessActionHandler, DocumentMoveProcessActionHandler, DocumentSelectProcessActionHandler, EditChatRoomProcessActionHandler, FieldsProcessActionHandler, FileListAddProcessActionHandler, FileListEditProcessActionHandler, FileSystemProcessActionHandler, FiltersProcessActionHandler, ForumProcessActionHandler, GenericAclActionHandler, GenericAclProcessActionHandler, GenericProcessActionHandler, GroupAclProcessActionHandler, GroupProcessActionHandler, GroupProcessActionHandler, GroupTypeProcessActionHandler, HtmlEditProcessActionHandler, HtmlProcessActionHandler, ImageDeleteProcessActionHandler, ImageMoveProcessActionHandler, ImageSelectProcessActionHandler, ImportPrincipalsProcessActionHandler, InterfaceHolderPropertiesProcessActionHandler, InterfaceInstanceCustomPropertiesProcessActionHandler, LanguageProcessActionHandler, LinkTranslatorProcessActionHandler, LocaleProcessActionHandler, LoginProcessActionHandler, MailMarketingBulletinAddDataProcessActionHandler, MailMarketingBulletinUpdateDataProcessActionHandler, MailMarketingSendTestEmailProcessActionHandler, MaxRowsProcessActionHandler, MonitorEventProcessActionHandler, NavigationProcessActionHandler, NewArticleLinkProcessActionHandler, NewsletterModelAdminProcessActionHandler, ObserverProcessActionHandler, OrderByActionHandler, PageAclProcessActionHandler, PageCacheProcessActionHandler, PageLinkConstraintCheckProcessActionHandler, PageProcessActionHandler, PageTemplateAclProcessActionHandler, PageTemplateProcessActionHandler, ParticipateProcessActionHandler, PortalAclProcessActionHandler, PortletDeploymentProcessActionHandler, PrintProcessActionHandler, ProcessActionHandler, ProducerAddInterfaceInstanceProcessActionHandler, ProducerAdministrationListDeleteProcessActionHandler, ProducerConfigurationInterfaceProcessActionHandler, PropertyBagProcessActionHandler, PublicDataFolderProcessActionHandler, PublishToPrincipalsProcessActionHandler, PublishToServiceInstancesProcessActionHandler, ReadPrincipalsProcessActionHandler, RegisterControlProcessActionHandler, RegisterMenuTypesProcessActionHandler, RegisterReportTypeProcessActionHandler, RegisterServiceProcessActionHandler, RegisterServiceTypesProcessActionHandler, RemotePortletConfigurationInterfaceProcessActionHandler, ReportProcessActionHandler, ResourceValidatorProcessActionHandler, RobotsTxtSitemapNameProcessActionHandler, RobotsTxtUserAgentNameProcessActionHandler, RoomDeleteValidatorProcessActionHandler, RssProcessActionHandler, ScheduleValidatorProcessActionHandler, SearchPropertiesProcessActionHandler, SelectImportFileProcessActionHandler, SelectPrincipalProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectWorkflowServiceInstanceProcessActionHandler, SendMailProcessActionHandler, SendToFriendMailProcessActionHandler, SerializationProcessActionHandler, ServiceAclProcessActionHandler, ServiceInstanceAclProcessActionHandler, ServiceInstanceCustomPropertiesProcessActionHandler, ServiceInstanceProcessActionHandler, ServiceInterfaceInstancePropertiesProcessActionHandler, SetCommentTotalInfoProcessActionHandler, SetContactRequestCategoryNullProcessActionHandler, SetMainArticleProcessActionHandler, SetMetaDataInfoProcessActionHandler, ShowReportProcessActionHandler, TableAddDataProcessActionHandler, TableAddMultiRowDataProcessActionHandler, TableDeleteDataProcessActionHandler, TableDeleteMultiRowDataProcessActionHandler, TableUpdateDataProcessActionHandler, TableUpdateMultiRowDataProcessActionHandler, UniqueMimeTypeValidatorProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserProcessActionHandler, UserProcessActionHandler, UserSubscriptionProcessActionHandler, UserSubscriptionProcessActionHandler, ValidateArticleDeletionProcessActionHandler, ValidateArticleTitleProcessActionHandler, ValidateContentReferencesProcessActionHandler, ValidateSitemapChannelNameProcessAction, ValidateSitemapNameProcessActionHandler, VersionProcessActionHandler, VoteProcessActionHandler, WebPageProcessActionHandler, WebResourceServiceProcessActionHandler, WebServiceViewerConfigurationProcessActionHandler, WebServiceViewerParametersProcessActionHandler, WikiArticleSelectProcessActionHandler, WorkflowProcessActionHandler, WorkflowServiceInstanceAclProcessActionHandler, XslCacheProcessActionHandler, XslEditorProcessActionHandler

@StableMinor(version="5.5",
             sinceVersion="4.0")
public interface IProcessActionHandler

All process action handlers must extend this interface.

Since:

4.0.0

Method Summary

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.

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)
                  throws PortalException

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 -

Throws:

PortalException

Since:

4.0.0

getParameter

Object getParameter(String name)
                    throws PortalException

Returns the parameter value.

Parameters:

name -

Returns:

Throws:

PortalException

Since:

4.0.0

getParameter

<T> T getParameter(String name,
                   Class<T> expectedClass)
               throws PortalException

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.

Throws:

PortalException

Since:

4.0.4