IAdmAction
The IAdmAction interface is the base interface for all action objects that are used in business rules, custom commands, and scheduled tasks. All interfaces that represent action objects of different types are inherited from IAdmAction.
Inheritance: IUnknown
Methods
-
Method
-
Description
-
GetOperationTypes()
-
Returns an array containing a list of operation types that this action performs.
-
IsOperationOfType()
-
Determines whether the action is of the specified operation type.
-
GetOperationName()
-
Returns the operation description that includes the target object name.
-
GetOperationNameByType()
-
Returns the operation description that includes the target object type.
-
GetOperationNameXml()
-
Returns an XML document that contains the operation description with the target object name.
-
GetOperationNameByTypeXml()
-
Returns an XML document that contains the operation description with the target object type.
-
Execute()
-
Executes the action.
Properties
-
Property
-
Description
-
IgnoreAlreadyDoneErrors
-
Gets or sets a value that indicates whether to throw an exception when execution of the action fails because the operation has already been completed before.
Details
GetOperationTypes()
Returns an array containing a list of operation types that this action performs.
string[] GetOperationTypes(IAdmTop targetObject)
Parameters
The targetObject parameter specifies the object that the action will target.
IsOperationOfType()
Determines whether the action is of the specified operation type.
bool IsOperationOfType(IAdmTop targetObject, string type)
Parameters
- targetObject – The object that the action will target.
- type – The operation type to check for.
GetOperationName()
Returns the operation description that includes the target object name.
string GetOperationName(IAdmTop targetObject, ADM_ACTIONNAMEFORMAT_ENUM format)
Parameters
- targetObject – The object that the action will target.
- format – Formatting options.
GetOperationNameByType()
Returns the operation description that includes the target object type.
string GetOperationNameByType(string objectType, ADM_ACTIONNAMEFORMAT_ENUM format)
Parameters
- objectType – The type of the target object, e.g. user.
- format – Formatting options.
Remarks
If the action type is adm-CreateObjectAction, this method cannot be used to obtain the description that includes the object type.
Instead, use the GetOperationName method and specify ADM_ACTIONNAMEFORMAT_OBJECTTYPE in the format parameter.
GetOperationNameXml()
Returns an XML document that contains the operation description with the target object name.
string GetOperationNameXml(IAdmTop targetObject, ADM_ACTIONNAMEFORMAT_ENUM format)
Parameters
- targetObject – The object that the action will target.
- format – Formatting options.
GetOperationNameByTypeXml()
Returns an XML document that contains the operation description with the target object type.
string GetOperationNameByTypeXml(string objectType, ADM_ACTIONNAMEFORMAT_ENUM format)
Parameters
- objectType – The type of the target object, e.g. user.
- format – Formatting options.
Remarks
If the action type is adm-CreateObjectAction, this method cannot be used to obtain the description that includes the object type.
Instead, use the GetOperationNameXml method and specify ADM_ACTIONNAMEFORMAT_OBJECTTYPE in the format parameter.
Execute()
Executes the action.
object Execute(IAdmTop targetObject)
Parameters
The targetObject parameter specifies the object that the action should target.
Return value
The method returns an object containing the result of the operation. The value depends on the action type.
IgnoreAlreadyDoneErrors
Gets or sets a value that indicates whether to throw an exception when execution of the action fails because the operation has already been completed before. When set to true, exceptions will not be thrown.
- Type:
- bool
- Access:
- Read/Write
Requirements
Minimum required version: 2025.1