<head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="mof.css" xmlns:lxslt="http://xml.apache.org/xslt"> <title>DMTF Schema Documentation Schema Documentation</title> </head><html> <body bgcolor="White"> <hr> </hr> <a name="CIM_PrintAlertRecord"></a> <H1>Class CIM_PrintAlertRecord<BR>extends <a href="CIM_LogEntry.html">CIM_LogEntry</a> </H1>This class represents an alert (warning or critical event) on a Printer (print device). A critical alert is one that stops the Printer from printing immediately and printing cannot continue until the critical alert condition is eliminated. Non-critical alerts are those alerts that do not stop printing immediately, but may do so at some future time. A PrintAlertRecord is a snapshot of the state of the device at the time an alert condition occurs. It is preserved in a format that is suitable for offline processing, when the device may have changed or may not be available for interrogation. A PrintAlertRecord shall be associated with exactly one Printer via an instance of the PrintAlertLog class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).<h3> Table of Contents<br> <a href="#c_hierarchy">Hierarchy</a> <br> <a href="#c_subclasses">Direct Known Subclasses</a> <br> <a href="#c_qualifiers">Class Qualifiers</a> <br> <a href="#c_properties">Class Properties</a> <br> <a href="#c_methods">Class Methods</a> <br> </h3> <hr> </hr> <H2> <a name="c_hierarchy">Class Hierarchy</a> </H2> <a href="CIM_ManagedElement.html">CIM_ManagedElement</a> <br data="@NAME"> |<br> +--<a href="CIM_RecordForLog.html">CIM_RecordForLog</a> <br data="@NAME"> |<br> +--<a href="CIM_LogEntry.html">CIM_LogEntry</a> <br data="@NAME"> |<br> +--<b>CIM_PrintAlertRecord</b> <br data="CIM_PrintAlertRecord -- CIM_LogEntry"> <H2> <a name="c_subclasses">Direct Known Subclasses</a> </H2> <H2> <a name="c_qualifiers">Class Qualifiers</a> </H2> <TABLE BORDER="1" CELLPADDING="1" WIDTH="100%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">This class represents an alert (warning or critical event) on a Printer (print device). A critical alert is one that stops the Printer from printing immediately and printing cannot continue until the critical alert condition is eliminated. Non-critical alerts are those alerts that do not stop printing immediately, but may do so at some future time. A PrintAlertRecord is a snapshot of the state of the device at the time an alert condition occurs. It is preserved in a format that is suitable for offline processing, when the device may have changed or may not be available for interrogation. A PrintAlertRecord shall be associated with exactly one Printer via an instance of the PrintAlertLog class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).</TD> </TR> <TR> <TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertEntry</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Device::Printing</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.21</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <H3>Local Class Properties</H3> <TABLE WIDTH="100%" CELLPADDING="1" BORDER="1"> <TR> <TH ROWSPAN="2"><B>Name</B></TH><TH ROWSPAN="2"><B>Data Type</B></TH><TH ROWSPAN="2"><B>Default Value</B></TH><TH COLSPAN="5"><B>Qualifiers</B></TH> </TR> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Value</TH> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">CodeName</TH><TD ROWSPAN="6" VALIGN="TOP">string</TD><TD ROWSPAN="6" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The code name that describes the type of alert. The code name shall be the IANA-registered label for this alert, taken from the PrtAlertCodeTC textual convention in the IANA Printer MIB (originally published in RFC 3805), e.g., 'coverOpen' or 'inputMediaSupplyLow'. A binary change alert describes the state of the component, while a unary change alert describes a single event. The same code name can be used for a binary change alert or a unary change alert, depending on implementation. Also, the same code name can be used to indicate a critical or non-critical (warning) alert, depending on implementation. The value of the SeverityLevel property specifies binary versus unary and critical versus non-critical for each alert for this particular Printer implementation.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertCode, MIB.IETF|IANA-PRINTER-MIB.PrtAlertCodeTC</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">255</TD> </TR> <TR> <TD VALIGN="TOP">MinLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">0</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_PrintAlertRecord.OtherCodeName, CIM_PrintAlertRecord.SeverityLevel</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">ComponentClassName</TH><TD ROWSPAN="6" VALIGN="TOP">string</TD><TD ROWSPAN="6" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The lowest inheritance class name with a schema name of 'CIM' (e.g., 'CIM_PrintMarker') of the particular component of a Printer with which this alert is associated. When used with the value of ComponentElementName, this property allows all instances of this component to be uniquely identified. If the component class name is unknown or not applicable, then this property shall be null. Note: This property is necessary (rather than the use of an association class), because this log entry is static and records a past event for offline processing. See: Section 2 of the Printer MIB v2 (RFC 3805) and section 3 of Finisher MIB (RFC 3806). Note: This property is necessary to correlate status and event (alert) information between CIM and SNMP interfaces.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertGroup, MIB.IETF|IANA-PRINTER-MIB.PrtAlertGroupTC</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">255</TD> </TR> <TR> <TD VALIGN="TOP">MinLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">0</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_PrintAlertRecord.ComponentElementName</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">ComponentElementName</TH><TD ROWSPAN="6" VALIGN="TOP">string</TD><TD ROWSPAN="6" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The value of the ManagedSystemElement.Name property of the particular component of a Printer with which this alert is associated. When used with the value of ComponentClassName, this property allows all instances of this component to be uniquely identified. If the component element name is unknown or not applicable, then this property shall be null. Note: This property is necessary (rather than the use of an association class), because this log entry is static and records a past event for offline processing. See: Section 2 of the Printer MIB v2 (RFC 3805) and section 3 of Finisher MIB (RFC 3806). Note: This property is necessary to correlate status and event (alert) information between CIM and SNMP interfaces.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertGroupIndex</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">255</TD> </TR> <TR> <TD VALIGN="TOP">MinLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">0</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_ManagedSystemElement.Name, CIM_PrintAlertRecord.ComponentClassName</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">CreationTimeStamp</TH><TD ROWSPAN="5" VALIGN="TOP">datetime</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The time that this PrintAlertRecord was generated.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertTime, MIB.IETF|SNMPv2-MIB.sysUpTime, MIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime, MIB.IETF|HOST-RESOURCES-MIB.hrSystemDate</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_OperatingSystem.LocalDateTime</TD> </TR> <TR> <TD VALIGN="TOP">Override</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CreationTimeStamp</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">LocalizedDescription</TH><TD ROWSPAN="5" VALIGN="TOP">string</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A free-form text description of this alert in the localization specified by CIM_Printer.CurrentNaturalLanguage.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertDescription, MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">255</TD> </TR> <TR> <TD VALIGN="TOP">MinLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">0</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">OtherCodeName</TH><TD ROWSPAN="5" VALIGN="TOP">string</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A free-form string that describes the type of alert when the value of the CodeName property is equal to 'other'.</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">255</TD> </TR> <TR> <TD VALIGN="TOP">MinLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">0</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_PrintAlertRecord.CodeName</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">OtherSeverityLevel</TH><TD ROWSPAN="5" VALIGN="TOP">string</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A free-form string that describes the severity level when the value of the SeverityLevel property is equal to 1 (Other).</TD> </TR> <TR> <TD VALIGN="TOP">MaxLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">255</TD> </TR> <TR> <TD VALIGN="TOP">MinLen</TD><TD VALIGN="TOP">uint32</TD><TD VALIGN="TOP">0</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_PrintAlertRecord.SeverityLevel</TD> </TR> <TR> <TH ROWSPAN="5" VALIGN="TOP">RecordData</TH><TD ROWSPAN="5" VALIGN="TOP">string</TD><TD ROWSPAN="5" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Note: For SNMP Proxy implementations, this property shall contain every integer object in the corresponding prtAlertEntry row in the Printer MIB v2 (RFC 3805). The string object prtAlertDescription in the corresponding prtAlertEntry row shall not be encoded in this RecordData property, but shall instead be transcoded (if necessary) into Unicode and stored in the LocalizedDescription property below.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertEntry</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_RecordForLog.RecordFormat</TD> </TR> <TR> <TD VALIGN="TOP">Override</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">RecordData</TD> </TR> <TR> <TH ROWSPAN="6" VALIGN="TOP">SeverityLevel</TH><TD ROWSPAN="6" VALIGN="TOP">uint32</TD><TD ROWSPAN="6" VALIGN="TOP"></TD> </TR> <TR> <TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The level of severity of this alert in this Printer implementation as follows: 1 (Other) means a non-standard severity level is present in OtherSeverityLevel property. 2 (Unknown) means severity level is unknown for this alert. 3 (Critical) means that this alert on this component has stopped printing on this Printer. 4 (Warning) means that this alert has not stopped printing on this Printer. 5 (WarningBinaryChangeEvent) means that a previous critical alert condition has been cleared.</TD> </TR> <TR> <TD VALIGN="TOP">MappingStrings</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">MIB.IETF|Printer-MIB.prtAlertSeverityLevel, MIB.IETF|Printer-MIB.PrtAlertSeverityLevelTC</TD> </TR> <TR> <TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_PrintAlertRecord.CodeName</TD> </TR> <TR> <TD VALIGN="TOP">ValueMap</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">1, 2, 3, 4, 5, ..</TD> </TR> <TR> <TD VALIGN="TOP">Values</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Other, Unknown, Critical, Warning, WarningBinaryChangeEvent, DMTF Reserved</TD> </TR> </TABLE> <H3>Inherited Properties</H3> <TABLE BORDER="1" CELLPADDING="1" WIDTH="60%"> <TR> <TH>Name</TH><TH>Data Type</TH><TH>Class Origin</TH> </TR> <TR> <TH VALIGN="TOP">Caption</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Description</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">ElementName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Generation</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_ManagedElement.html">CIM_ManagedElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">Locale</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_RecordForLog.html">CIM_RecordForLog</a></TD> </TR> <TR> <TH VALIGN="TOP">LogInstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">LogName</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">Message</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">MessageID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">OwningEntity</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">PerceivedSeverity</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_RecordForLog.html">CIM_RecordForLog</a></TD> </TR> <TR> <TH VALIGN="TOP">RecordFormat</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_RecordForLog.html">CIM_RecordForLog</a></TD> </TR> <TR> <TH VALIGN="TOP">RecordID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> <TR> <TH VALIGN="TOP">MessageArguments</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_LogEntry.html">CIM_LogEntry</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> </body> </html>
