Class CIM_PrintFinisher
extends CIM_PrinterElement

This class represents the PrintFinisher component of a Printer (print device). It contains properties that describe the PrintFinisher type, capabilities, and status. Note: A PrintFinisher shall be associated with exactly one Printer via an instance of the ConcreteComponent class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_PrinterElement
   |
   +--CIM_PrintFinisher

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis class represents the PrintFinisher component of a Printer (print device). It contains properties that describe the PrintFinisher type, capabilities, and status. Note: A PrintFinisher shall be associated with exactly one Printer via an instance of the ConcreteComponent class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).
Experimentalbooleantrue
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceEntry
UMLPackagePathstringCIM::Device::Printing
Versionstring2.19.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AvailabilityStatusuint32
DescriptionstringThis property contains detailed availability information for this PrintFinisher, as follows: 1 (Other) means other detailed availability information is present in the OtherAvailabilityStatus property. 2 (Unknown) means detailed availability information for this PrintFinisher is unknown. 3 (AvailableIdle) means this PrintFinisher is available and idle, i.e., not currently in use. 4 (AvailableStandy) means this PrintFinisher is available but on standby, e.g., in a power saving mode. 5 (AvailableActive) means this PrintFinisher is available and active, i.e., currently in use. 6 (AvailableBusy) means this PrintFinisher is available but busy, i.e., not immediately available for its primary function. 7 (UnavailableOnRequest) means this PrintFinisher is not available and is on request, i.e., needs human intervention. 8 (UnavailableBroken) means this PrintFinisher is not available and is broken, e.g., needs repair/replacement.
MappingStringsstringMIB.IETF|Printer-MIB.PrtSubUnitStatusTC
ModelCorrespondencestringCIM_ManagedSystemElement.OperatingStatus, CIM_PrintFinisher.OtherAvailabilityStatus
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, ..
ValuesstringOther, Unknown, AvailableIdle, AvailableStandby, AvailableActive, AvailableBusy, UnavailableOnRequest, UnavailableBroken, DMTF Reserved
CapacityUnituint32
DescriptionstringThe unit of measure for specifying the capacity of this PrintFinisher.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceCapacityUnit, MIB.IETF|Printer-MIB.PrtCapacityUnitTC
ModelCorrespondencestringCIM_PrintFinisher.OtherCapacityUnit
ValueMapstring1, 2, 3, 4, 8, 16, 17, 18, 19, ..
ValuesstringOther, Unknown, TenThousandthsOfInches, Micrometers, Sheets, Feet, Meters, Items, Percent, DMTF Reserved
CriticalAlertsPresentboolean
DescriptionstringIf true, there are currently critical alerts on this PrintFinisher.
MappingStringsstringMIB.IETF|Printer-MIB.PrtSubUnitStatusTC
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus
CurrentCapacityuint32
DescriptionstringThe current capacity of the PrintFinisher in units specified by CIM_PrintFinisher.CapacityUnit. If this PrintFinisher can reliably sense this value, the value is sensed by the PrintFinisher and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceCurrentCapacity, MIB.IETF|Finisher-MIB.finDeviceCapacityUnit, MIB.IETF|Printer-MIB.PrtCapacityUnitTC
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintFinisher.CurrentCapacityBasis
CurrentCapacityBasisuint16
DescriptionstringThe basis for the gauge property CurrentCapacity, that specifies whether a meaningful value is available. 1 (Other) means the PrintFinisher places no restrictions on capacity and CurrentCapacity shall be null. 2 (Unknown) means the PrintFinisher cannot sense a meaningful value and CurrentCapacity shall be null. 3 (Actual) means the PrintFinisher can sense a meaningful value and CurrentCapacity shall be present. 4 (AtLeastOne) means that the PrintFinisher can only sense that at least one capacity unit remains (i.e., not full) and CurrentCapacity shall be present and shall contain the value zero or one.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceCurrentCapacity
ModelCorrespondencestringCIM_PrintFinisher.CurrentCapacity
ValueMapstring1, 2, 3, 4, ..
ValuesstringOther, Unknown, Actual, AtLeastOne, DMTF Reserved
LocalizedDescriptionstring
DescriptionstringA free-form text description of this PrintFinisher in the localization specified by CIM_Printer.CurrentNaturalLanguage.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceDescription, MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_Printer.CurrentNaturalLanguage
MaxCapacityuint32
DescriptionstringThe maximum capacity of the PrintFinisher in units specified by CIM_PrintFinisher.CapacityUnit. If this PrintFinisher can reliably sense this value, the value is sensed by the PrintFinisher and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceMaxCapacity, MIB.IETF|Finisher-MIB.finDeviceCapacityUnit, MIB.IETF|Printer-MIB.PrtCapacityUnitTC
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintFinisher.MaxCapacityBasis
MaxCapacityBasisuint16
DescriptionstringThe basis for the limit property MaxCapacity, that specifies whether a meaningful value is available. 1 (Other) means the PrintFinisher places no restrictions on capacity and MaxCapacity shall be null. 2 (Unknown) means the PrintFinisher cannot sense a meaningful value and MaxCapacity shall be null. 3 (Actual) means the PrintFinisher can sense a meaningful value and MaxCapacity shall be present.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceMaxCapacity
ModelCorrespondencestringCIM_PrintFinisher.MaxCapacity
ValueMapstring1, 2, 3, ..
ValuesstringOther, Unknown, Actual, DMTF Reserved
NonCriticalAlertsPresentboolean
DescriptionstringIf true, there are currently non-critical alerts on this PrintFinisher.
MappingStringsstringMIB.IETF|Printer-MIB.PrtSubUnitStatusTC
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus
OtherAvailabilityStatusstring
DescriptionstringA free-form string that describes the detailed availability of this PrintFinisher when the value of the AvailabilityStatus property is equal to 1 (Other).
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintFinisher.AvailabilityStatus
OtherCapacityUnitstring
DescriptionstringA free-form string that describes the capacity unit when the value of the CapacityUnit property is equal to 1 (Other).
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintFinisher.CapacityUnit
OtherTypeDescriptionstring
DescriptionstringA free-form string that describes the type of PrintFinisher when the value of the Type property is equal to 1 (Other).
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintFinisher.Type
PresentOnOffuint32
DescriptionstringDenotes whether this PrintFinisher is present (configured) and whether the PrintFinisher is enabled.
MappingStringsstringMIB.IETF|Finisher-MIB.finDevicePresentOnOff, MIB.IETF|Printer-MIB.PresentOnOff
ValueMapstring1, 2, 3, 4, 5, ..
ValuesstringOther, Unknown, On, Off, NotPresent, DMTF Reserved
Typeuint32
DescriptionstringDefines the type of finishing process associated with this PrintFinisher.
MappingStringsstringMIB.IETF|Finisher-MIB.finDeviceType, MIB.IETF|IANA-PRINTER-MIB.PrtMarkerMarkTechTC
ModelCorrespondencestringCIM_PrintFinisher.OtherTypeDescription
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, ..
ValuesstringOther, Unknown, Stitcher, Folder, Binder, Trimmer, DieCutter, Puncher, Perforater, Slitter, SeparationCutter, Imprinter, Wrapper, Bander, MakeEnvelope, Stacker, SheetRotator, Inserter, DMTF Reserved

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_PrinterElement
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
PrimaryStatusuint16CIM_ManagedSystemElement
SNMPRowIduint32CIM_PrinterElement
StatusstringCIM_ManagedSystemElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods