1 karl 1.1.2.2 // Copyright (c) 2008 DMTF. All rights reserved.
2 [Version ( "2.22.0" ),
3 UMLPackagePath ( "CIM::Event" ),
4 Description (
5 "CIM_IndicationFilter defines the criteria for generating an "
6 "instance of CIM_Indication and what data should be returned in "
7 "that instance. It is derived from CIM_ManagedElement to allow "
8 "modeling the dependency of the filter on a specific service.\n"
9 "If used with the \"DMTF:CQLT\" language, the processing and "
10 "CQLT tokens that must be supported are described in the "
11 "description of the QueryLanguage property" )]
12 class CIM_IndicationFilter : CIM_ManagedElement {
13
14 [Key, Description (
15 "A System\'s CreationClassName. The Filter is defined in "
16 "the context of a CIM_System, where it is hosted or to "
17 "which it applies. In a future release, a weak "
18 "relationship will be explicitly added to the model. This "
19 "is not done now to allow further refinement of the "
20 "Filter definition and its inheritance tree. Keys are "
21 "defined now to allow the class to be instantiated." ),
22 karl 1.1.2.2 MaxLen ( 256 )]
23 string SystemCreationClassName;
24
25 [Key, Description (
26 "A System\'s Name. The Filter is defined in the context "
27 "of a CIM_System, where it is hosted or to which it "
28 "applies. In a future release, a weak relationship will "
29 "be explicitly added to the model. This is not done now "
30 "to allow further refinement of the Filter definition and "
31 "its inheritance tree. Keys are defined now to allow the "
32 "class to be instantiated." ),
33 MaxLen ( 256 )]
34 string SystemName;
35
36 [Key, Description (
37 "Indicates the name of the class or the subclass used in "
38 "the creation of an instance. When used with the other "
39 "key properties of this class, it allows all instances of "
40 "this class and its subclasses to be uniquely identified." ),
41 MaxLen ( 256 )]
42 string CreationClassName;
43 karl 1.1.2.2
44 [Key, Description ( "The name of the filter." )]
45 string Name;
46
47 [Deprecated { "CIM_IndicationFilter.SourceNamespaces" },
48 Description (
49 "The path to a local namespace where the Indications "
50 "originate. If NULL, the namespace of the Filter "
51 "registration is assumed." )]
52 string SourceNamespace;
53
54 [Description (
55 "The names of the local namespaces where the Indications "
56 "originate. If NULL, the namespace of the Filter "
57 "registration is assumed. SourceNamespaces replaces the "
58 "SourceNamespace property on IndicationFilter to provide "
59 "a means of defining the multiple namespaces where "
60 "indications may originate." ),
61 ArrayType ( "Indexed" ),
62 ModelCorrespondence { "CIM_Namespace.Name" }]
63 string SourceNamespaces[];
64 karl 1.1.2.2
65 [Description (
66 "If IndividualSubscriptionSupported is true, the "
67 "implementation shall support direct subscription to this "
68 "IndicationFilter. If IndividualSubscriptionSupported is "
69 "false, the implementation shall not support direct "
70 "subscription to this IndicationFilter." )]
71 boolean IndividualSubscriptionSupported = true;
72
73 [Required, Description (
74 "A query expression that defines the condition(s) under "
75 "which instances of CIM_Indication will be generated. For "
76 "CIM_InstIndication subclasses of CIM_Indication classes, "
77 "the query expression may also define the instance "
78 "properties to be copied to the CIM_InstIndication\'s "
79 "SourceInstance and PreviousInstance properties. Query "
80 "language semantics include projection (e.g., Select), "
81 "range (e.g., From) and predicate (e.g., Where). \n"
82 "When used with QueryLanguage set to \"DMTF:CQL\" or "
83 "\"DMTF:CQLT\", the FROM clause shall contain at least "
84 "one subclass of CIM_Indication and may contain any "
85 karl 1.1.2.2 "number of other classes or subqueries. If only one "
86 "subclass of CIM_Indication is named, it defines the "
87 "CIM_Indication that this Instance of "
88 "CIM_IndicationFilter will produce. If more than one "
89 "subclass of CIM_Indication is named, then one of them "
90 "must be named explicitly in the select-list. \n"
91 "The select-list must refer explicitly or implicitly to "
92 "exactly one CIM_Indication subclass. In addition, it "
93 "shall conform to one of several options: \n"
94 "1) only a \"*\": This may only be used if the Indication "
95 "subclass is the only entry on the FROM list. \n"
96 "2) only a \"<Indicationclass or alias>.*\": This form "
97 "may be used if the FROM clause contains more than one "
98 "Indication subclass. \n"
99 "3) a list of the form \"<propertyname>*[\",\"[<literal> "
100 "AS ]<propertyname>]\": This form may only be used if the "
101 "CIM_Indication subclass is the only entry on the FROM "
102 "list. In this form, the literal is assigned to the named "
103 "property of the selected CIM_Indication subclass \n"
104 "4) a list of the form \"<Indicationname>.<propertyname> "
105 "*[\",\" [<Indicationname>.<propertyname> |\"\": "
106 karl 1.1.2.2 "<literal> AS <propertyname> | <fromname>.<propertyname> "
107 "AS <propertyname> ] ]\" : The first term selects the "
108 "appropriate CIM_Indication subclass to produce. "
109 "Subsequent terms allow other properties of that "
110 "indication, or allow a literal or property of another "
111 "class to be assigned to the output as one of the "
112 "properties of the selected CIM_Indication subclass. \n"
113 "Note that in all cases, only the property names of the "
114 "selected CIM_Indication subclass may be referred to in "
115 "the select-list.\n"
116 "When used with \"DMTF:CQLT\", the additional string "
117 "array property TemplateVariable should be used to "
118 "provide additional filtering information to the query." ),
119 ModelCorrespondence { "CIM_IndicationFilter.QueryLanguage",
120 "CIM_IndicationFilter.TemplateVariable" }]
121 string Query;
122
123 [Required, Description (
124 "The language in which the query is expressed. . \n"
125 "\"DMTF:CQL\" indicates a CIM Query Language string. \n"
126 "\"DMTF:CQLT\" indicates a CIM Query Language Template "
127 karl 1.1.2.2 "string. When used, the identifiers recognized in the "
128 "$identifier$ tokens are \"SELF\" and the property names "
129 "of this class, or one of its subclasses. As seen by a "
130 "CIM client, the value of the Query property is not "
131 "changed as a result of template processing. Template "
132 "processing conceptually produces a new query string, "
133 "which defines the actual conditions that will trigger "
134 "production of a CIM_Indication instance. When used in "
135 "the Query string, $SELF$ will be replaced by a string "
136 "corresponding to a WBEM URI referencing the instance of "
137 "this class that contains the Query template string. "
138 "Tokens of the form $<propertyname>$ will be replaced by "
139 "a string representing the corresponding property value "
140 "of the instance of this class that contains the Query "
141 "string. The Query string must be evaluated when the "
142 "CIM_IndicationFilter is created and at any time when one "
143 "any modification of any property referenced by tokens in "
144 "the Query string are modified." ),
145 ModelCorrespondence { "CIM_IndicationFilter.Query",
146 "CIM_IndicationFilter.TemplateVariable" }]
147 string QueryLanguage;
148 karl 1.1.2.2
149
150 };
|