Equipment Holder ABE UML Documentation

Element

Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE
Class EquipmentHolder

This class is based on the M.3100 specification, and is a base class that represents physical objects that are both manageable as well as able to host, hold, or contain other physical objects. Examples of physical objects that can be represented by instances of this object class are Racks, Chassis, Shelfs, and Slots.

The difference between subclasses of EquipmentHolder (such as a Slot or a Chassis) and subclasses of Equipment that have a Holder role (such as a Card) is that the subclasses of EquipmentHolder are dedicated to holding other Hardware. The subclasses of Equipment that have a holder role have a holding capability as a secondary capability, usually for expansion. Their primary function, however, is not to hold other objects.

Attributes
Equipment	_equipment
Hardware	_hardware2
HolderComposite	_holderComposite
String	acceptableEquipmentList
String	acceptableEquipmentTypeList	This attribute identifies the types of equipment that can be supported by the Equipment Holder.
ObjectName	asapRef	This attribute indicates the assignment of an Alarm Severity Assignment Profile (ASAP) to the EquipmentHolder.
ObjectName	expectedOrInstalledEquipmentRef	This attribute identifies the equipment object expected or installed in the equipment holder, if any. Null if the equipment holder is empty or if it only contains other equipment holders.
Integer	holderStatus	This attribute, based on M.3100, indicates the status of the EquipmentHolder. Values include: 0: Unknown 1: Installed And Acceptable 2: Installed And Not Acceptable 3: Not Installed 4: Mismatch Of Installed and Acceptable 5: Unavailable This is an optional attribute.
Boolean	isReportingAlarms	This attribute provides an indication of whether alarm reporting for this Equipment Holder is enabled (true) or disabled (false).
Boolean	isSolitaryHolder	This is a Boolean attribute that, if TRUE, defines this EquipmentHolder as containing only one ManagedComponent. If this is FALSE, then this EquipmentHolder contains nested ManagedComponents. This is a REQUIRED attrinbute.
«preliminary, likelyToChange» ItuArcStateAndStatusList	ituArcStateAndStatusList	See R_TMF518_NRB_I_0001 and R_TMF518_NRB_I_0004. See supporting document SD1-8_encodingX731M3100...\..\Framework\SD\SD1-8_encodingX731M3100.pdf
String	manufacturer	This attribute identifies the Equipment Holder manufacturer name. It is defined as a non-empty free format string with no semantics.
String	state	This attribute identifies the state of the Equipment Holder.
String	type	This attribute identifies the type of the Holder (e.g., Rack (or Bay), Shelf, Sub-shelf, Slot, Subslot, Remote-unit or Remote-subslot).
Integer	typeOfHolder	This is an enumerated integer that identifies the type of the Holder that this object instance is. It is based on M.3100 but includes additional values: 0: Unknown 1: Rack 2: Bay 3: Chassis 4: Shelf 5: Slot 6: Sub-Slot 7: Sub-Rack This is a REQUIRED attribute.

Attributes inherited from SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Hardware ABE::PhysicalContainer
hotSwappable, removable, replaceable, _physicalCapacity

Attributes inherited from SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Hardware ABE::ManagedHardware
additionalInfo, administrativeState, physicalAlarmReportingEnabled, physicalAlarmStatus, coolingRequirements, hardwarePurpose, _hardwareRole

Attributes inherited from SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Hardware ABE::Hardware
depth, height, measurementUnits, weight, weightUnits, width, _physicalConnector, _hardware, _hardware1, _physicalLink, _physicalDevice, _device, _equipmentHolder, _commonPlatformEnumeration

Attributes inherited from SID Models::Resource Domain::Resource ABE::Physical Resource ABE::PhysicalResource
_uniqueRepresentation, _place2, _localPlace, _replacementSet, manufactureDate, otherIdentifier, powerState, serialNumber, versionNumber, _product2, physicalResourceRole, logicalResource

Attributes inherited from SID Models::Resource Domain::Resource ABE::Resource
_managementDomain, _businessInteractionItem, _resourceRole, _resourceSpecification, _resourceUsage, usageState, _place, _performance2, _resourceFacingService, _product, _resourceCharacteristicValue, _resourceSecurityEntity, _securityEventCollectionMethod, _serviceAccessPoint, _securityThreatTool, _commonResourceInfo, _partyRole3, _partyRole, resourceCapacity, resourceCapacityDemand, _resourceInvolvementRole, _resourceUser, runningSoftwareStatistics, software, compoundResource, resourceConfiguration, resourceConfigSpec, resourceTest, resourceRelationship, resourceRelationship2, resource, resource22, problem2, problem, _alarm_3, _alarm_2, _alarm_1, resourcePerformance

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::Entity
_entityIdentification, _entityRole, managedEntity, characteristicValue

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::RootEntity
_rootEntityType, _revenueAssuranceParmValue, _characteristicValue, name, description, ID, metric, _monitoredMetricInstancesCriteria, directedEdge, vertex, entityCatalogItem, rootEntityGroupMember, rootEntityGroup, rootEntityRelationship, rootEntityRelationship2, associationRole, entitySpecificationAttachment, interactionUseCase, interactionResult

Properties:

Alias
Classifier Behavior
Is Abstract	true
Is Active	false
Is Leaf	false
Keywords
Name	EquipmentHolder
Name Expression
Namespace	Equipment Holder ABE
Owned Template Signature
Owner	Equipment Holder ABE
Owning Template Parameter
Package	Equipment Holder ABE
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

_equipment

Public Equipment _equipment

Constraints:

Properties:

Aggregation	Shared
Alias
Association	EquipmentInHolder
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	_equipment
Name Expression
Namespace	EquipmentHolder
Opposite	_equipmentHolder
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::_equipment
Stereotype
Template Parameter
Type	Equipment
Upper	*
Upper Value	(*)
Visibility	Public

_hardware2

Public Hardware _hardware2

Constraints:

Properties:

Aggregation	Shared
Alias
Association	HoldsHardware
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	_hardware2
Name Expression
Namespace	EquipmentHolder
Opposite	_equipmentHolder
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::_hardware2
Stereotype
Template Parameter
Type	Hardware
Upper	*
Upper Value	(*)
Visibility	Public

_holderComposite

Public HolderComposite _holderComposite

Constraints:

Properties:

Aggregation	None
Alias
Association	HasHolders
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	_holderComposite
Name Expression
Namespace	EquipmentHolder
Opposite	_equipmentHolder2
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::_holderComposite
Stereotype
Template Parameter
Type	HolderComposite
Upper	1
Upper Value	(1)
Visibility	Public

acceptableEquipmentList

Public String acceptableEquipmentList

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	acceptableEquipmentList
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::acceptableEquipmentList
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

acceptableEquipmentTypeList

Public String acceptableEquipmentTypeList

This attribute identifies the types of equipment that can be supported by the Equipment Holder.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	true
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	acceptableEquipmentTypeList
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::acceptableEquipmentTypeList
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

asapRef

Public ObjectName asapRef

This attribute indicates the assignment of an Alarm Severity Assignment Profile (ASAP) to the EquipmentHolder.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value	()
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	asapRef
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::asapRef
Stereotype	required
Template Parameter
Type	ObjectName
Upper	1
Upper Value
Visibility	Public

expectedOrInstalledEquipmentRef

Public ObjectName expectedOrInstalledEquipmentRef

This attribute identifies the equipment object expected or installed in the equipment holder, if any. Null if the equipment holder is empty or if it only contains other equipment holders.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	true
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	expectedOrInstalledEquipmentRef
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::expectedOrInstalledEquipmentRef
Stereotype	required
Template Parameter
Type	ObjectName
Upper	1
Upper Value
Visibility	Public

holderStatus

Public Integer holderStatus

This attribute, based on M.3100, indicates the status of the EquipmentHolder. Values include:

0: Unknown
1: Installed And Acceptable
2: Installed And Not Acceptable
3: Not Installed
4: Mismatch Of Installed and Acceptable
5: Unavailable

This is an optional attribute.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	holderStatus
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::holderStatus
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

isReportingAlarms

Public Boolean isReportingAlarms

This attribute provides an indication of whether alarm reporting for this Equipment Holder is enabled (true) or disabled (false).

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default	true
Default Value	(true)
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	isReportingAlarms
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::isReportingAlarms
Stereotype	required
Template Parameter
Type	Boolean
Upper	1
Upper Value
Visibility	Public

isSolitaryHolder

Public Boolean isSolitaryHolder

This is a Boolean attribute that, if TRUE, defines this EquipmentHolder as containing only one ManagedComponent. If this is FALSE, then this EquipmentHolder contains nested ManagedComponents. This is a REQUIRED attrinbute.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	isSolitaryHolder
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::isSolitaryHolder
Stereotype
Template Parameter
Type	Boolean
Upper	1
Upper Value
Visibility	Public

ituArcStateAndStatusList

Public «preliminary, likelyToChange» ItuArcStateAndStatusList ituArcStateAndStatusList

See R_TMF518_NRB_I_0001 and R_TMF518_NRB_I_0004.
See supporting document SD1-8_encodingX731M3100...\..\Framework\SD\SD1-8_encodingX731M3100.pdf

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	ituArcStateAndStatusList
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::ituArcStateAndStatusList
Stereotype	required
Template Parameter
Type	«preliminary, likelyToChange» ItuArcStateAndStatusList
Upper	1
Upper Value	(1)
Visibility	Public

manufacturer

Public String manufacturer

This attribute identifies the Equipment Holder manufacturer name. It is defined as a non-empty free format string with no semantics.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	true
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	manufacturer
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::manufacturer
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

state

Public String state

This attribute identifies the state of the Equipment Holder.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	true
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	state
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::state
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

type

Public String type

This attribute identifies the type of the Holder (e.g., Rack (or Bay), Shelf, Sub-shelf, Slot, Subslot, Remote-unit or Remote-subslot).

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	true
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	type
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::type
Stereotype	required
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

typeOfHolder

Public Integer typeOfHolder

This is an enumerated integer that identifies the type of the Holder that this object instance is. It is based on M.3100 but includes additional values:
0: Unknown
1: Rack
2: Bay
3: Chassis
4: Shelf
5: Slot
6: Sub-Slot
7: Sub-Rack

This is a REQUIRED attribute.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	EquipmentHolder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	typeOfHolder
Name Expression
Namespace	EquipmentHolder
Opposite
Owner	EquipmentHolder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Physical Resource ABE::Equipment Holder ABE::EquipmentHolder::typeOfHolder
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

Overview

Top

Package

Element

Equipment Holder ABE UML Documentation

Summary:AttributesProperties

Detail:Attributes