1 karl  1.1.2.2 // Copyright (c) 2005 DMTF.  All rights reserved.
 2                  [Association, Version ( "2.10.0" ), 
 3                   UMLPackagePath ( "CIM::Event" ), 
 4                   Description ( 
 5                      "A subclass of IndicationSubscription that defines the text "
 6                      "formatting of Indication information. The "
 7                      "TextFormatOwningEntity, TextFormatID, TextFormat, and "
 8                      "TextFormatParameters properties are used to describe a "
 9                      "human-readable representation of the Indication as defined by "
10                      "the referenced CIM_IndicationFilter. This representation MAY "
11                      "be used by the CIM_ListenerDestination when the intended "
12                      "consumer of the Indication is human. For example, this format "
13                      "could be used when writing the Indication to a system log or "
14                      "sending an e-mail notification to a system administrator." )]
15               class CIM_FormattedIndicationSubscription : CIM_IndicationSubscription {
16               
17                     [Description ( 
18                         "The TextFormatOwningEntity is a string that uniquely "
19                         "identifies the entity that owns the definition of the "
20                         "human-readable format described in this instance. "
21                         "OwningEntity MUST include a copyrighted, trademarked or "
22 karl  1.1.2.2           "otherwise unique name that is owned by the business "
23                         "entity or standards body defining the format." ), 
24                      ModelCorrespondence { 
25                         "CIM_FormattedIndicationSubscription.TextFormatID", 
26                         "CIM_FormattedIndicationSubscription.TextFormat", 
27                         "CIM_FormattedIndicationSubscription.TextFormatParameters" }]
28                  string TextFormatOwningEntity;
29               
30                     [Description ( 
31                         "An opaque string that uniquely identifies, within the "
32                         "scope of the TextFormatOwningEntity, a human-readable "
33                         "format for representing the Indications described by "
34                         "this Subscription." ), 
35                      ModelCorrespondence { 
36                         "CIM_FormattedIndicationSubscription.TextFormatOwningEntity", 
37                         "CIM_FormattedIndicationSubscription.TextFormat", 
38                         "CIM_FormattedIndicationSubscription.TextFormatParameters" }]
39                  string TextFormatID;
40               
41                     [Description ( 
42                         "A string describing the human-readable format for "
43 karl  1.1.2.2           "representing the Indications described by this "
44                         "Subscription. The actual text is constructed by applying "
45                         "the dynamic content, defined in the Indication, to the "
46                         "string specified in this property. /n /n The dynamic "
47                         "content is specified by embedding the following syntax "
48                         "in the appropriate places in the format string: \n"
49                         "\"{\" <index>[\"[\"[<index>]\"]\"],<type>\"}\" \n"
50                         "- the first occurrence of <index> defines the element of "
51                         "TextFormatParameters that contains the name of the "
52                         "Indication property to be used to populate the text message.\n"
53                         "- if the Indication property defined by the first "
54                         "<index> is an array property, then the first index MUST "
55                         "be followed by either empty brackets (i.e., []) or an "
56                         "index value enclosed in brackets (e.g., [1]). If empty "
57                         "brackets are specified (e.g., {4[], string}), then the "
58                         "dynamic content of the text message is populated with a "
59                         "list of the array elements. If an index is specified "
60                         "(e.g., {4[1], string}, then only the specified array "
61                         "element is used to populate the message. If the value of "
62                         "the dynamic content is not defined in the Indication, "
63                         "then the string \"UNKNOWN\" is used to populate the text message.\n"
64 karl  1.1.2.2           "- <type> defines the type of the dynamic content. Valid "
65                         "values for <type> are: \'boolean\', \'string\', "
66                         "\'char16\', \'uint8\', \'sint8\', \'uint16\', \'sint16\', "
67                         "\'uint32\', \'sint32\', \'uint64\', \'sint64\', "
68                         "\'datetime\', \'real32\', \'real64\' or \'ref\'. \n"
69                         "\n"
70                         "The string encoding for the dynamic content MUST conform "
71                         "to the MOF Syntax Grammar described in the CIM "
72                         "Infrastructure Specification. The string encoding for a "
73                         "list of array elements MUST conform to the definition of "
74                         "the arrayInitializer element.\n"
75                         "As an example, a format string for a UPS AlertIndication "
76                         "could be defined as follows: \"A {4,string} UPS Alert of "
77                         "type {5,uint16} was detected on the device {6,string} on "
78                         "the system {2,string} at {1,datetime}. The following "
79                         "actions have been recommended to resolve the alert: "
80                         "{3[],string}\"." )]
81                  string TextFormat;
82               
83                     [Description ( 
84                         "An indexed array containing the names of properties "
85 karl  1.1.2.2           "defined in the select clause of the associated "
86                         "CIM_IndicationFilter Query. The values of these "
87                         "Indication properties are used to populate the dynamic "
88                         "content of the text message." ), 
89                      ArrayType ( "Indexed" ), 
90                      ModelCorrespondence { 
91                         "CIM_FormattedIndicationSubscription.TextFormatOwningEntity", 
92                         "CIM_FormattedIndicationSubscription.TextFormatID", 
93                         "CIM_FormattedIndicationSubscription.TextFormat" }]
94                  string TextFormatParameters[];
95               
96               
97               };