component var Element attributes (N1 Service Provisioning System 4.1 Reference Guide)

N1 Service Provisioning System 4.1 Reference Guide

component var Element attributes

Name	Type	Required	Configurable	Description
access	access Enum	No	No	The access mode of the variable, as described below. Default is PUBLIC.
modifier	modifier Enum	No	No	The modifier of the variable, as described below.
name	identifier	Yes	No	The name of the substitution variable. The name must be unique among every other substitution variable in the enclosing <varList>.
default	String	Yes 1	Yes	The default value of the substitution variable, which may include references to other substitution variables, target host attributes, and installed component variables.

1 May not be included in abstract variables.

var access Attribute

The "access" attribute of the <var> element specifies the accessibility of the variable.

If PUBLIC, access is not restricted in any way.

If PROTECTED, access is limited to derived components and entities in the same path.

If PATH, access is limited to entities in the same path.

If PRIVATE, access is limited to this component.

var modifier Attribute

The "modifier" attribute of the <var> element specifies the override requirements for the variable.

If ABSTRACT, the variable "default" attribute is omitted and must be specified by non-abstract derived components. Variables may only be declared abstract if the component is also declared abstract. Abstract variables may not be private. Non-abstract variables must declare a default value.

If FINAL, the variable may not be overridden by derived components.

If unspecified, then derived components can choose whether or not to override the variable.