<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_FormattedIndicationSubscription"></a>
<H1>Class CIM_FormattedIndicationSubscription<BR>extends <a href="CIM_IndicationSubscription.html">CIM_IndicationSubscription</a>
</H1>A subclass of IndicationSubscription that defines the text formatting of Indication information. The TextFormatOwningEntity, TextFormatID, TextFormat, and TextFormatParameters properties are used to describe a human-readable representation of the Indication as defined by the referenced CIM_IndicationFilter. This representation MAY be used by the CIM_ListenerDestination when the intended consumer of the Indication is human. For example, this format could be used when writing the Indication to a system log or sending an e-mail notification to a system administrator.<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_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a>
<br data="@NAME"> |<br> +--<a href="CIM_IndicationSubscription.html">CIM_IndicationSubscription</a>
<br data="@NAME"> |<br> +--<b>CIM_FormattedIndicationSubscription</b>
<br data="CIM_FormattedIndicationSubscription -- CIM_IndicationSubscription">
<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">Association</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A subclass of IndicationSubscription that defines the text formatting of Indication information. The TextFormatOwningEntity, TextFormatID, TextFormat, and TextFormatParameters properties are used to describe a human-readable representation of the Indication as defined by the referenced CIM_IndicationFilter. This representation MAY be used by the CIM_ListenerDestination when the intended consumer of the Indication is human. For example, this format could be used when writing the Indication to a system log or sending an e-mail notification to a system administrator.</TD>
</TR>
<TR>
<TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Event</TD>
</TR>
<TR>
<TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.10.0</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="2" VALIGN="TOP">TextFormat</TH><TD ROWSPAN="2" VALIGN="TOP">string</TD><TD ROWSPAN="2" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">A string describing the human-readable format for representing the Indications described by this Subscription. The actual text is constructed by applying the dynamic content, defined in the Indication, to the string specified in this property. /n /n The dynamic content is specified by embedding the following syntax in the appropriate places in the format string:
"{" <index>["["[<index>]"]"],<type>"}"
- the first occurrence of <index> defines the element of TextFormatParameters that contains the name of the Indication property to be used to populate the text message.
- if the Indication property defined by the first <index> is an array property, then the first index MUST be followed by either empty brackets (i.e., []) or an index value enclosed in brackets (e.g., [1]). If empty brackets are specified (e.g., {4[], string}), then the dynamic content of the text message is populated with a list of the array elements. If an index is specified (e.g., {4[1], string}, then only the specified array element is used to populate the message. If the value of the dynamic content is not defined in the Indication, then the string "UNKNOWN" is used to populate the text message.
- <type> defines the type of the dynamic content. Valid values for <type> are: 'boolean', 'string', 'char16', 'uint8', 'sint8', 'uint16', 'sint16', 'uint32', 'sint32', 'uint64', 'sint64', 'datetime', 'real32', 'real64' or 'ref'.
The string encoding for the dynamic content MUST conform to the MOF Syntax Grammar described in the CIM Infrastructure Specification. The string encoding for a list of array elements MUST conform to the definition of the arrayInitializer element.
As an example, a format string for a UPS AlertIndication could be defined as follows: "A {4,string} UPS Alert of type {5,uint16} was detected on the device {6,string} on the system {2,string} at {1,datetime}. The following actions have been recommended to resolve the alert: {3[],string}".</TD>
</TR>
<TR>
<TH ROWSPAN="3" VALIGN="TOP">TextFormatID</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">An opaque string that uniquely identifies, within the scope of the TextFormatOwningEntity, a human-readable format for representing the Indications described by this Subscription.</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_FormattedIndicationSubscription.TextFormatOwningEntity, CIM_FormattedIndicationSubscription.TextFormat, CIM_FormattedIndicationSubscription.TextFormatParameters</TD>
</TR>
<TR>
<TH ROWSPAN="3" VALIGN="TOP">TextFormatOwningEntity</TH><TD ROWSPAN="3" VALIGN="TOP">string</TD><TD ROWSPAN="3" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">The TextFormatOwningEntity is a string that uniquely identifies the entity that owns the definition of the human-readable format described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format.</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_FormattedIndicationSubscription.TextFormatID, CIM_FormattedIndicationSubscription.TextFormat, CIM_FormattedIndicationSubscription.TextFormatParameters</TD>
</TR>
<TR>
<TH ROWSPAN="4" VALIGN="TOP">TextFormatParameters</TH><TD ROWSPAN="4" VALIGN="TOP">string[]</TD><TD ROWSPAN="4" VALIGN="TOP"></TD>
</TR>
<TR>
<TD VALIGN="TOP">ArrayType</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">Indexed</TD>
</TR>
<TR>
<TD VALIGN="TOP">Description</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">An indexed array containing the names of properties defined in the select clause of the associated CIM_IndicationFilter Query. The values of these Indication properties are used to populate the dynamic content of the text message.</TD>
</TR>
<TR>
<TD VALIGN="TOP">ModelCorrespondence</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM_FormattedIndicationSubscription.TextFormatOwningEntity, CIM_FormattedIndicationSubscription.TextFormatID, CIM_FormattedIndicationSubscription.TextFormat</TD>
</TR>
</TABLE>
<H3>Association References</H3>
<TABLE BORDER="1" CELLPADDING="1" WIDTH="60%">
<TR>
<TH>Name</TH><TH>Class Origin</TH><TH>Reference Class</TH>
</TR>
</TABLE>
<H3>Propagated Association References</H3>
<TABLE BORDER="1" CELLPADDING="1" WIDTH="60%">
<TR>
<TH>Name</TH><TH>Class Origin</TH><TH>Reference Class</TH>
</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">AlertOnStateChange</TH><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">FailureTriggerTimeInterval</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">LastIndicationIdentifier</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">LastIndicationProductionDateTime</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">OnFatalErrorPolicy</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">OtherOnFatalErrorPolicy</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">OtherRepeatNotificationPolicy</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">OtherSubscriptionState</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">RepeatNotificationCount</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">RepeatNotificationGap</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">RepeatNotificationInterval</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">RepeatNotificationPolicy</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">SubscriptionDuration</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">SubscriptionInfo</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">SubscriptionStartTime</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">SubscriptionState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">SubscriptionTimeRemaining</TH><TD VALIGN="TOP">uint64</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
<TR>
<TH VALIGN="TOP">TimeOfLastStateChange</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_AbstractIndicationSubscription.html">CIM_AbstractIndicationSubscription</a></TD>
</TR>
</TABLE>
<h2>
<a name="c_methods">Class Methods</a>
</h2>
</body>
</html>
