Overview Package Class Deprecated Help

fm
AdditionalTextPolicy

Defines a particular database Additional Text policy

public class AdditionalTextPolicy

Properties
applyToAllObjectTypes Indicates whether this policy has to be applied to all affected object types

type=boolean
default=false
Displayed(tab/group)=Apply Policy to all Object Types
description Description of the additional text policy

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
domain Indicates the package of the alarmed object affected by the additional text policy

type=string
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Domain
fm.AdditionalTextAttribute-Set type=Children-Set
objectType Indicates the class name of the config form backing object of which the additional text attribute was selected to be applied

type=string
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Object Type
overwrite Indicates whether to override the current additional text field or to append to it

type=boolean
default=false
Displayed(tab/group)=Overwrite existing
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configureAdditionalTextPolicy

Configure additional text policy
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
domain : string - The domain of the additional text policy
objectType : string - The object type of the additional text policy
additionalTextAttributeConfigInfo : List (generic.CommonManagedEntityConfigurationInformation) - The additional text attribute config info
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string - Returns the full name of the additional text attribute instance
Exceptions:
fm.AdditionalTextPolicy.configureAdditionalTextPolicyException