Attributes for the <uninstallSteps> Element

The <uninstallSteps> element has the following attributes:

• access – An optional attribute of type accessEnum, which specifies the accessibility of the uninstall block. The following values are permitted:

  • PUBLIC – Access is unrestricted, which is the default.

  • PROTECTED – Access is limited to derived components and entities that are in the same path.

  • PATH – Access is limited to entities that are in the same path.

  • PRIVATE – Access is limited to this component.

  Only PUBLIC blocks can be run directly from the component.

• modifier – An optional attribute of type modifierEnum, which specifies the override requirements for the uninstall block. The following values are permitted:

  • ABSTRACT – The block cannot include a body because it must be specified by nonabstract derived components. Uninstall blocks can only be declared abstract if the component is also declared abstract. Abstract blocks cannot be private. Nonabstract blocks must declare a body.

  • FINAL – The uninstall block cannot be overridden by derived components.

  If this attribute is omitted, derived components can choose whether to override the block.

• name – A required attribute of type entityName, which is the name of the uninstall block. The name must be unique among all uninstall blocks in the containing <uninstallList>.

• description – An optional attribute, which is a string that describes the uninstall block. This attribute is useful for documentation purposes.

• returns – An optional attribute that indicates that the block must return a value. Valid values are true or false. If returns=true is specified, then each execution step within the block must end with either a <return> step or an uncaught <raise> step. The default is false.