All Known Subinterfaces:

IProcessActionHandler

All Known Implementing Classes:

AbstractServiceInstanceCustomPropertiesProcessActionHandler, AccessProcessActionHandler, ActivateRevertDefaultConfigurationProcessActionHandler, ActivityStreamDeleteProcessActionHandler, ActivityStreamObjectTypesCustomPropertyProcessActionHandler, ActivityStreamScopesCustomPropertyProcessActionHandler, AddActivityProcessorProcessActionHandler, AddChatRoomProcessActionHandler, AddCommunityProcessActionHandler, AddFormAnswerProcessActionHandler, AddFormFieldProcessActionHandler, AddFormProcessActionHandler, AddHtmlTemplateProcessActionHandler, AddItemActionHandler, AddMemberProcessActionHandler, AddPrincipalProcessActionHandler, AddProcessActionHandler, AddQuestionaireAnswerProcessActionHandler, AddQuestionaireProcessActionHandler, AddSeoRuleProcessActionHandler, AddSocialNetworkProcessActionHandler, AddTagProcessActionHandler, AddTransformationParametersProcessActionHandler, AddTreeExclusionProcessActionHandler, AddTreeItemProcessActionHandler, AddVariantProcessActionHandler, AddWebsiteCreatingVirtualHostProcessActionHandler, AddWidgetProcessActionHandler, AdministrationViewModeProcessActionHandler, AlbumAddMultipleProcessActionHandler, AnonymizeAllUsersWithoutConsentProcessActionHandler, APMMetricProcessActionHandler, ApplicationAccountProcessActionHandler, ApplyVariantProcessActionHandler, AssociationProcessActionHandler, AuditConfigProcessActionHandler, AuditProcessActionHandler, BannerAddDataProcessActionHandler, BannerDeleteDataProcessActionHandler, BannerProcessActionHandler, BannerUpdateDataProcessActionHandler, BaseImportLecProcessActionHandler, BaseSourceProcessActionHandler, BaseTableDataProcessActionHandler, BoostSearchProcessActionHandler, BreadCrumbPropertiesProcessActionHandler, BusinessContexPropertyBagProcessAction, BusinessContextProcessActionHandler, CacheProcessActionHandler, CallerInterfaceInstancePreferencesProcessActionHandler, CancelPublicSubscriptionProcessActionHandler, ChangePasswordProcessActionHandler, ChangeProcessPurposeProcessActionHandler, ChannelAclProcessActionHandler, ChannelProcessActionHandler, CheckAlbumAccessProcessActionHandler, CheckAlbumDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckCategoryDeleteProcessActionHandler, CheckDuplicateFolderProcessActionHandler, CheckDuplicateFolderProcessActionHandler, CheckTagCategoryDeleteProcessActionHandler, CheckUpdatePageSSIPropertyProcessActionHandler, ClockProcessActionHandler, CloneDataProcessActionHandler, 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, DeleteAllInactiveVersionProcessActionHandler, DeleteApplicationProcessActionHandler, DeleteCommentProcessActionHandler, DeleteCommunityProcessActionHandler, DeleteInactiveVersionProcessActionHandler, DeleteProcessActionHandler, DeleteProcessActionHandler, DeleteQuestionnaireProcessActionHandler, DeleteQueueTaskProcessActionHandler, DeleteRelationCommentProcessActionHandler, DeleteReportProcessActionHandler, DeleteTermProcessActionHandler, DeleteTreeExclusionProcessActionHandler, DeleteTreeItemProcessActionHandler, DeleteTreeProcessActionHandler, DeleteUserJourneyInstanceProcessAction, DeleteVariantProcessActionHandler, DeleteWidgetProcessActionHandler, DeploymentProcessActionHandler, DeploymentProcessActionHandler, DetailsProcessActionHandler, DisableMonitoringProcessActionHandler, DocumentAddMultipleProcessActionHandler, DocumentDeleteProcessActionHandler, DocumentMoveProcessActionHandler, DocumentSelectProcessActionHandler, DouiRestInterfaceCachePropertiesProcessActionHandler, EditChatRoomProcessActionHandler, EditContentSeoProcessActionHandler, EditDashboardProcessActionHandler, EditImageProcessActionHandler, EditLifetimeProcessActionHandler, EditReportProcessActionHandler, EditTagProcessActionHandler, EditTransformationParametersProcessActionHandler, EditTreeExclusionProcessActionHandler, EditTreeItemProcessActionHandler, EditTreeProcessActionHandler, EditVariantProcessActionHandler, EncryptTextProcessActionHandler, ExecuteWorkflowActionProcessActionHandler, ExportProcessActionHandler, ExportStructureProcessActionHandler, FieldsProcessActionHandler, FileListAddProcessActionHandler, FileListEditProcessActionHandler, FileMacrotypeMappingProcessActionHandler, FileSystemProcessActionHandler, FiltersProcessActionHandler, ForceToPublishSynonymsProcessActionHandler, FormBuilderAddContentProcessActionHandler, FormBuilderAddFieldsProcessActionHandler, FormBuilderValidateContentProcessActionHandler, FormBuilderValidateHtmlFieldContentProcessActionHandler, ForumProcessActionHandler, GenerateDocumentationProcessActionHandler, GenerateSitemapProcessActionHandler, GenericAclActionHandler, GenericAclProcessActionHandler, GenericProcessActionHandler, GroupAclProcessActionHandler, GroupProcessActionHandler, GroupProcessActionHandler, GroupTypeProcessActionHandler, HierarchicalAddContentProcessActionHandler, HierarchicalContentDeleteDataProcessActionHandler, HierarchicalContentHierarchyValidationProcessActionHandler, HierarchicalContentPageLayoutsProcessActionHandler, 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, MfaLoginProcessActionHandler, MicroblogAttachmentsProcessActionHandler, MicroblogCommentProcessActionHandler, MicroblogHashProcessActionHandler, MicroblogPostsProcessActionHandler, MicroblogUserFollowsProcessActionHandler, MonitorConfigurationProcessActionHandler, MonitorEventProcessActionHandler, NavigationAddContentProcessActionHandler, NavigationProcessActionHandler, NavigationValidateContentProcessActionHandler, NewArticleLinkProcessActionHandler, NewsletterModelAdminProcessActionHandler, ObserverProcessActionHandler, OrderByActionHandler, OutbandRegistrationInterfaceProcessActionHandler, PageAclProcessActionHandler, PageCacheProcessActionHandler, PageLinkProcessActionHandler, PagePersonalizationContentTableAddProcessActionHandler, PagePersonalizationContentTableEditProcessActionHandler, PageProcessActionHandler, PageTemplateAclProcessActionHandler, PageTemplateProcessActionHandler, Parameters, 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, ReindexMetadataProcessActionHandler, ReindexProcessActionHandler, RemotePortletConfigurationInterfaceProcessActionHandler, RemoveCloneProcessActionHandler, ReprocessFileTransformation, ReprocessQueueTaskProcessActionHandler, ResetPageProcessActionHandler, ResourceValidatorProcessActionHandler, RobotsTxtSitemapNameProcessActionHandler, RobotsTxtUserAgentNameProcessActionHandler, RoomDeleteValidatorProcessActionHandler, RssProcessActionHandler, SaveAIConfigProcessActionHandler, ScheduleClearCacheProcessActionHandler, ScheduleValidatorProcessActionHandler, SearchFacetPropertiesProcessActionHandler, SearchProcessActionHandler, SearchPropertiesProcessActionHandler, SearchScopeProcessActionHandler, SelectAccountServiceInstanceProcessActionHandler, SelectImagesProcessActionHandler, SelectImportFileProcessActionHandler, SelectPrincipalProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRepositoryProcessActionHandler, SelectRootChannelProcessActionHandler, SelectWorkflowServiceInstanceProcessActionHandler, SendMailProcessActionHandler, SendMFATestEmailProcessActionHandler, SendTestEmailProcessActionHandler, SendTestMail, 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, ThreadDumpGenerateProcessActionHandler, TogglePreviewModeProcessActionHandler, TransformFilesProcessActionHandler, UniqueMimeTypeValidatorProcessActionHandler, UpdateActivityProcessorProcessActionHandler, UpdateCategorizationRepositoryProcessActionHandler, UpdateChannelsProcessActionHandler, UpdateCommunityProcessActionHandler, UpdateConfigurationProcessActionHandler, UpdateFormFieldProcessActionHandler, UpdateFormProcessActionHandler, UpdateHtmlTemplateProcessActionHandler, UpdateMetadataProcessActionHandler, UpdatePopularitiesConfigProcessActionHandler, UpdatePrivacyTermRepositoryProcessActionHandler, UpdateProcessActionHandler, UpdateQuestionaireProcessActionHandler, UpdateRepositoryProcessActionHandler, UpdateTermsParentProcessActionHandler, UpgradePortalProcessActionHandler, URLAccessibilityEvaluationProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserCancelSubscriptionProcessActionHandler, UserPostDeleteProcessActionHandler, UserProcessActionHandler, UserProcessActionHandler, UserSubscriptionProcessActionHandler, UserSubscriptionProcessActionHandler, ValidateArticleDeletionProcessActionHandler, ValidateArticleTitleProcessActionHandler, ValidateExperimentProcessActionHandler, ValuesValidatorProcessAction, VersionProcessActionHandler, VoteProcessActionHandler, WebFileReplicationProcessActionHandler, WebPageProcessActionHandler, WebResourceServiceProcessActionHandler, WebServiceViewerConfigurationProcessActionHandler, WebServiceViewerParametersProcessActionHandler, WebsiteProcessActionHandler, WidgetSelectProcessActionHandler, WikiArticleSelectProcessActionHandler, WorkflowProcessActionHandler, WorkflowServiceInstanceAclProcessActionHandler, XslCacheProcessActionHandler, XslEditorProcessActionHandler
```
@StableMinor(version="17.0",
             sinceVersion="10.4")
public interface IParameters
```
Interface for parameters

Since:

4.0.0

Version:

$Revision$ $Date$

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static IParameters`	`asParameters(java.lang.Object obj)`	Returns a IParameters adapter for the given object.
`boolean`	`containsParameter(java.lang.String name)`	Returns whether a parameter is set in this parameters.
`static IParameters`	`emptyParameters()`	Returns a `IParameters` object that does not contain any parameter.
`java.lang.Object`	`getParameter(java.lang.String name)`
`static IParameters`	`removeParameter(IParameters parameters, java.lang.String fieldId)`	Returns a IParameters removing the parameter with the given id.
`static IParameters`	`setParameter(IParameters parameters, java.lang.String fieldId, java.lang.Object newValue)`	Returns a IParameters setting the parameter with the given id.

- Method Detail
  - getParameter
```
java.lang.Object getParameter(java.lang.String name)
```
  - containsParameter
```
boolean containsParameter(java.lang.String name)
```
    Returns whether a parameter is set in this parameters.
    This is useful to differ a null value parameter from a non-existing parameter.
    
    Parameters:
    
    name - the parameter name.
    
    Returns:
    
    true if the parameter is set, false otherwise.
    
    Since:
    
    10.4.0
  - emptyParameters
```
static IParameters emptyParameters()
```
    Returns a IParameters object that does not contain any parameter.
    
    Returns:
    
    an empty IParameters object.
    
    Since:
    
    10.4.0
  - asParameters
```
static IParameters asParameters(java.lang.Object obj)
```
    Returns a IParameters adapter for the given object.
    Parameters:
    
    obj - the object to adapt as parameters. It may be:
    
    null, in this case emptyParameters() is returned.
    
    IParameters, in this case obj is returned.
    
    Map with String keys. Each map entry will correspond to a parameter where the entry key is the parameter name and the entry value is the parameter value.
    
    Otherwise it is assumed to be a Java Bean and the parameters are read from its properties.
    
    Returns:
    
    a parameters object according to the given object.
    
    Since:
    
    10.4.0
  - removeParameter
```
static IParameters removeParameter(IParameters parameters,
                                   java.lang.String fieldId)
```
    Returns a IParameters removing the parameter with the given id.
    
    Parameters:
    
    parameters - the parameters
    
    fieldId - the parameter id
    
    Returns:
    
    the new parameters
    
    Since:
    
    17.0.0
  - setParameter
```
static IParameters setParameter(IParameters parameters,
                                java.lang.String fieldId,
                                java.lang.Object newValue)
```
    Returns a IParameters setting the parameter with the given id. It's important to notice, though, that passing null value will not remove the parameter. Instead, it will set the parameter value to be null but containsParameter(String) will return true. To remove the parameter, use removeParameter(IParameters, String) instead.
    
    Parameters:
    
    parameters - the parameters
    
    fieldId - the parameter id
    
    newValue - the new value
    
    Returns:
    
    the new parameters
    
    Since:
    
    17.0.0

Interface IParameters

Method Summary

Method Detail

getParameter

containsParameter

emptyParameters

asParameters

removeParameter

setParameter