<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_SqlUserDefinedType"></a> <H1>Class CIM_SqlUserDefinedType<BR>extends <a href="CIM_SqlObject.html">CIM_SqlObject</a> </H1>A user-defined type is a schema object, identified by a <user -defined type name>. The definition of a userdefined type specifies a number of components, including in particular a list of attribute definitions. Although the attribute definitions are said to define the representation of the user-defined type, in fact they implicitly define certain functions (observers and mutators) that are part of the interface of the user-defined type; physical representations of user-defined type values are implementation-dependent. The representation of a user-defined type is expressed either as a single data type (some predefined data type, called the source type), in which case the user-defined type is said to be a distinct type, or as a list of attribute definitions, in which case it is said to be a structured type. A user-defined type is described by a user-defined type descriptor. A user-defined type descriptor contains: - The name of the user-defined type (<user-defined type name>). This is the type designator of that type, used in type precedence lists. - An indication of whether the user-defined type is a structured type or a distinct type. - The ordering form for the user-defined type (EQUALS, FULL, or NONE). - The ordering category for the user-defined type (RELATIVE, MAP, or STATE). - A <specific routine designator> identifying the ordering function, depending on the ordering category. - If the user-defined type is a direct subtype of another user -defined type, then the name of that user-defined type. - If the representation is a predefined data type, then the descriptor of that type; otherwise the attribute descriptor of every originally-defined attribute and every inherited attribute of the user-defined type. - An indication of whether the user-defined type is instantiable or not instantiable. - An indication of whether the user-defined type is final or not final. - The transform descriptor of the user-defined type. - If the user-defined type is a structured type, then: - Whether the referencing type of the structured type has a user -defined representation, a derived representation, or a system -defined representation. - If user-defined representation is specified, then the type descriptor of the representation type of the referencing type of the structured type; otherwise, if derived representation is specified, then the list of attributes. - If the <method specification list> is specified, then for each <method specification> contained in <method specification list>, a method specification descriptor that includes: - The <method name>. - The <specific method name>. - The <SQL parameter declaration list> augmented to include the implicit first parameter with parameter name SELF. - The <language name>. - If the <language name> is not SQL, then the <parameter style>. - The <returns data type>. - The <result cast from type>, if any. - An indication as to whether the <method specification> is an <original method specification> or an <overriding method specification>. - If the <method specification> is an <original method specification>, then an indication of whether STATIC or CONSTRUCTOR is specified. - An indication whether the method is deterministic. - An indication whether the method possibly writes SQL data, possibly reads SQL data, possibly contains SQL, or does not possibly contain SQL. - An indication whether the method should not be invoked if any argument is the null value, in which case the value of the method is the null value.<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_ManagedSystemElement.html">CIM_ManagedSystemElement</a> <br data="@NAME"> |<br> +--<a href="CIM_LogicalElement.html">CIM_LogicalElement</a> <br data="@NAME"> |<br> +--<a href="CIM_SqlObject.html">CIM_SqlObject</a> <br data="@NAME"> |<br> +--<b>CIM_SqlUserDefinedType</b> <br data="CIM_SqlUserDefinedType -- CIM_SqlObject"> <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">A user-defined type is a schema object, identified by a <user -defined type name>. The definition of a userdefined type specifies a number of components, including in particular a list of attribute definitions. Although the attribute definitions are said to define the representation of the user-defined type, in fact they implicitly define certain functions (observers and mutators) that are part of the interface of the user-defined type; physical representations of user-defined type values are implementation-dependent. The representation of a user-defined type is expressed either as a single data type (some predefined data type, called the source type), in which case the user-defined type is said to be a distinct type, or as a list of attribute definitions, in which case it is said to be a structured type. A user-defined type is described by a user-defined type descriptor. A user-defined type descriptor contains: - The name of the user-defined type (<user-defined type name>). This is the type designator of that type, used in type precedence lists. - An indication of whether the user-defined type is a structured type or a distinct type. - The ordering form for the user-defined type (EQUALS, FULL, or NONE). - The ordering category for the user-defined type (RELATIVE, MAP, or STATE). - A <specific routine designator> identifying the ordering function, depending on the ordering category. - If the user-defined type is a direct subtype of another user -defined type, then the name of that user-defined type. - If the representation is a predefined data type, then the descriptor of that type; otherwise the attribute descriptor of every originally-defined attribute and every inherited attribute of the user-defined type. - An indication of whether the user-defined type is instantiable or not instantiable. - An indication of whether the user-defined type is final or not final. - The transform descriptor of the user-defined type. - If the user-defined type is a structured type, then: - Whether the referencing type of the structured type has a user -defined representation, a derived representation, or a system -defined representation. - If user-defined representation is specified, then the type descriptor of the representation type of the referencing type of the structured type; otherwise, if derived representation is specified, then the list of attributes. - If the <method specification list> is specified, then for each <method specification> contained in <method specification list>, a method specification descriptor that includes: - The <method name>. - The <specific method name>. - The <SQL parameter declaration list> augmented to include the implicit first parameter with parameter name SELF. - The <language name>. - If the <language name> is not SQL, then the <parameter style>. - The <returns data type>. - The <result cast from type>, if any. - An indication as to whether the <method specification> is an <original method specification> or an <overriding method specification>. - If the <method specification> is an <original method specification>, then an indication of whether STATIC or CONSTRUCTOR is specified. - An indication whether the method is deterministic. - An indication whether the method possibly writes SQL data, possibly reads SQL data, possibly contains SQL, or does not possibly contain SQL. - An indication whether the method should not be invoked if any argument is the null value, in which case the value of the method is the null value.</TD> </TR> <TR> <TD VALIGN="TOP">Experimental</TD><TD VALIGN="TOP">boolean</TD><TD VALIGN="TOP">true</TD> </TR> <TR> <TD VALIGN="TOP">UMLPackagePath</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">CIM::Database::Sql</TD> </TR> <TR> <TD VALIGN="TOP">Version</TD><TD VALIGN="TOP">string</TD><TD VALIGN="TOP">2.12.0</TD> </TR> </TABLE> <H2> <a name="c_properties">Class Properties</a> </H2> <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">CommunicationStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">CreationTime</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_SqlObject.html">CIM_SqlObject</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">DetailedStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</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">HealthState</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstallDate</TH><TD VALIGN="TOP">datetime</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">InstanceID</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_SqlObject.html">CIM_SqlObject</a></TD> </TR> <TR> <TH VALIGN="TOP">Name</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OperatingStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">PrimaryStatus</TH><TD VALIGN="TOP">uint16</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">Status</TH><TD VALIGN="TOP">string</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">OperationalStatus</TH><TD VALIGN="TOP">uint16[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> <TR> <TH VALIGN="TOP">StatusDescriptions</TH><TD VALIGN="TOP">string[]</TD><TD VALIGN="TOP"><a href="CIM_ManagedSystemElement.html">CIM_ManagedSystemElement</a></TD> </TR> </TABLE> <h2> <a name="c_methods">Class Methods</a> </h2> </body> </html>
