CanDelete

This event is triggered before ALM deletes an object from the server, to check if the object can be deleted.

Syntax

<entity>_CanDelete(Entity)

Type

Function

Returns

True or False

Availability

  • AnalysisItem_CanDelete

  • AnalysisItemFolder_CanDelete

  • Baseline_CanDelete

  • Bug_CanDelete

  • BusinessModel_CanDelete

  • BusinessModelFolder_CanDelete

  • BusinessModelPath_CanDelete

  • Component_CanDelete

  • ComponentFolder_CanDelete

  • Cycle_CanDelete

  • DashboardFolder_CanDelete

  • DashboardPage_CanDelete

  • Library_CanDelete

  • LibraryFolder_CanDelete

  • Release_CanDelete

  • ReleaseFolder_CanDelete

  • Req_CanDelete

  • Resource_CanDelete

  • ResourceFolder_CanDelete

  • Test_CanDelete

  • TestConfiguration_CanDelete

  • TestFolder_CanDelete

  • TestSet_CanDelete

  • TestSetFolder_CanDelete

For purposes of backward compatibility, the following syntaxes are also available for certain objects. However, we recommend you use CanDelete instead.

  • The syntax for tests or test subject folders:

    Syntax

    Test_CanDelete(Entity, IsTest)

    where:

    • Entity is the test or subject folder.

    • If IsTest is True, Entity refers to an ITest object.
      If IsTest is False, Entity refers to an ISubjectNode object. For details on ITest and ISubjectNode, refer to the ALM Open Test Architecture API Reference.

    Type

    Function

    Returns

    True or False

    Availability

    Test_CanDelete

  • The syntax for test sets or test set folders:

    Syntax

    TestSet_CanDelete(Entity, IsTestSet)

    where:

    • Entity is the test set or test set folder.

    • If IsTestSet is True, Entity refers to an ITestSet object.
      If IsTestSet is False, Entity refers to an ITestSetFolder object. For details on ITestSet and ITestSetFolder, refer to the ALM Open Test Architecture API Reference.

    Type

    Function

    Returns

    True or False

    Availability

    TestSet_CanDelete

  • The syntax for business components or business component folders:

    Syntax

    Component_CanDelete(Entity, IsComponent)

    where:

    • Entity is the component or component folder.

    • If IsComponent is True, Entity refers to an IComponent object.
      If IsComponent is False, Entity refers to an IComponentFolder object. For details on IComponent and IComponentFolder, refer to the ALM Open Test Architecture API Reference.

    Type

    Function

    Returns

    True or False

    Availability

    Component_CanDelete