lumis.doui.processaction
Interface IProcessActionHandler

Package class diagram package IProcessActionHandler
All Known Implementing Classes:
AddChatRoomProcessActionHandler, AddItemActionHandler, AddPrincipalProcessActionHandler, BannerAddDataProcessActionHandler, BannerDeleteDataProcessActionHandler, BannerProcessActionHandler, BannerUpdateDataProcessActionHandler, BaseTableDataProcessActionHandler, BreadCrumbPropertiesProcessActionHandler, CacheProcessActionHandler, CancelPublicSubscriptionProcessActionHandler, ChannelAclProcessActionHandler, ChannelProcessActionHandler, CheckAlbumDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckDuplicateFolderProcessActionHandler, CheckDuplicateFolderProcessActionHandler, ClusterProcessActionHandler, ColProcessActionHandler, ContactUsMailProcessActionHandler, ContentTableAddDataProcessActionHandler, ContentTableDeleteDataProcessActionHandler, ContentTableUpdateDataProcessActionHandler, ContentWizardDeleteProcessActionHandler, CssProcessActionHandler, DeleteChatRoomProcessActionHandler, DeleteProcessActionHandler, DeleteRelationCommentProcessActionHandler, DeploymentProcessActionHandler, DocumentDeleteProcessActionHandler, DocumentMoveProcessActionHandler, DocumentSelectProcessActionHandler, EditChatRoomProcessActionHandler, FieldsProcessActionHandler, FileListAddProcessActionHandler, FileListEditProcessActionHandler, FileSystemProcessActionHandler, FiltersProcessActionHandler, ForumProcessActionHandler, GenericAclActionHandler, GenericAclProcessActionHandler, GenericProcessActionHandler, GroupAclProcessActionHandler, GroupProcessActionHandler, HtmlEditProcessActionHandler, HtmlProcessActionHandler, ImageDeleteProcessActionHandler, ImageMoveProcessActionHandler, ImageSelectProcessActionHandler, ImportPrincipalsProcessActionHandler, InterfaceHolderPropertiesProcessActionHandler, InterfaceInstanceCustomPropertiesProcessActionHandler, LanguageProcessActionHandler, LocaleProcessActionHandler, LoginProcessActionHandler, MailMarketingBulletinAddDataProcessActionHandler, MailMarketingBulletinUpdateDataProcessActionHandler, MailMarketingSendTestEmailProcessActionHandler, MaxRowsProcessActionHandler, MonitorEventProcessActionHandler, NavigationProcessActionHandler, NewsletterModelAdminProcessActionHandler, ObserverProcessActionHandler, OrderByActionHandler, PageAclProcessActionHandler, PageCacheProcessActionHandler, PageLinkConstraintCheckProcessActionHandler, PageProcessActionHandler, PageTemplateAclProcessActionHandler, PageTemplateProcessActionHandler, ParticipateProcessActionHandler, PortalAclProcessActionHandler, PortletDeploymentProcessActionHandler, PrintProcessActionHandler, ProcessActionHandler, PublicDataFolderProcessActionHandler, PublishToPrincipalsProcessActionHandler, PublishToServiceInstancesProcessActionHandler, ReadPrincipalsProcessActionHandler, RegisterControlProcessActionHandler, RegisterMenuTypesProcessActionHandler, RegisterReportTypeProcessActionHandler, RegisterServiceProcessActionHandler, RegisterServiceTypesProcessActionHandler, ReportProcessActionHandler, ResourceValidatorProcessActionHandler, RoomDeleteValidatorProcessActionHandler, RssProcessActionHandler, ScheduleValidatorProcessActionHandler, SearchPropertiesProcessActionHandler, SelectImportFileProcessActionHandler, SelectPrincipalProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectWorkflowServiceInstanceProcessActionHandler, SendMailProcessActionHandler, SendToFriendMailProcessActionHandler, SerializationProcessActionHandler, ServiceAclProcessActionHandler, ServiceInstanceAclProcessActionHandler, ServiceInstanceCustomPropertiesProcessActionHandler, ServiceInstanceProcessActionHandler, ServiceInterfaceInstancePropertiesProcessActionHandler, SetCommentTotalInfoProcessActionHandler, SetMetaDataInfoProcessActionHandler, ShowReportProcessActionHandler, TableAddDataProcessActionHandler, TableAddMultiRowDataProcessActionHandler, TableDeleteDataProcessActionHandler, TableDeleteMultiRowDataProcessActionHandler, TableUpdateDataProcessActionHandler, TableUpdateMultiRowDataProcessActionHandler, TermRelationUpdateDataProcessActionHandler, UniqueMimeTypeValidatorProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserProcessActionHandler, UserSubscriptionProcessActionHandler, UserSubscriptionProcessActionHandler, VersionProcessActionHandler, VoteProcessActionHandler, WebPageProcessActionHandler, WebServiceViewerConfigurationProcessActionHandler, WebServiceViewerParametersProcessActionHandler, WorkflowProcessActionHandler, WorkflowServiceInstanceAclProcessActionHandler, XslCacheProcessActionHandler, XslEditorProcessActionHandler

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

All process action handlers must extend this interface.

Since:
4.0.0

Method Summary
 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

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


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.