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

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 on which the action is to be executed.

IsOperationOfType()

Determines whether the action is of the specified operation type.

bool IsOperationOfType(IAdmTop targetObject, string type)

Parameters

  • targetObject - The object on which the action is to be executed.
  • type - The operation type to check for.

GetOperationName()

Returns a description of the operation performed by the action.

string GetOperationName(string objectName, 
                        IAdmTop targetObject, 
                        ADM_ACTIONNAMEFORMAT_ENUM formatSettings)

Parameters

  • objectName - Specifies the name of the object on which the action is to be executed. If not specified, the name will be built on the basis of formatting settings. When the ADM_ACTIONNAMEFORMAT_SPECIFIC flag is set, the name will be built on the basis of the targetObject parameter. When the ADM_ACTIONNAMEFORMAT_GENERAL flag is set, a general object name will be used. Note that the object name is inserted as is.
  • targetObject - The object on which the action is to be executed. Can be null if the ADM_ACTIONNAMEFORMAT_SPECIFIC flag is not set.
  • formatSettings - Specifies formatting settings for the return value of the method.

GetOperationNameXml()

Gets an XML document containing a description of the operation performed by the action.

string GetOperationNameXml(string objectName, 
                           IAdmTop targetObject, 
                           ADM_ACTIONNAMEFORMAT_ENUM formatSettings)

Parameters

  • objectName - Specifies the name of the object on which the action is to be executed. If not specified, the name will be built on the basis of formatting settings. When the ADM_ACTIONNAMEFORMAT_SPECIFIC flag is set, the name will be built on the basis of the targetObject parameter. When the ADM_ACTIONNAMEFORMAT_GENERAL flag is set, a general object name will be used. Note that the object name is inserted as is.
  • targetObject - The object on which the action is to be executed. Can be null if the ADM_ACTIONNAMEFORMAT_SPECIFIC flag is not set.
  • formatSettings - Specifies formatting settings for the return value of the method.

Execute()

Executes the action.

object Execute(IAdmTop targetObject)

Parameters

The targetObject parameter specifies the object on which the action will be executed.

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: 2009.1

See also

© Softerra 2022. All rights reserved.
Send feedback