| class MSmlDmDDFObject |
This class structure includes DDF description. When used as an argument in DM Adapters Interface each adapter fills its own branch of DDF Tree to the data structure.
| Public Member Functions | |
|---|---|
| MSmlDmDDFObject & | AddChildObjectGroupL() |
| MSmlDmDDFObject & | AddChildObjectL(const TDesC8 &) |
| void | AddDFTypeMimeTypeL(const TDesC8 &) |
| void | SetAccessTypesL(TSmlDmAccessTypes) |
| void | SetAsObjectGroup() |
| void | SetDFFormatL(TDFFormat) |
| void | SetDFTitleL(const TDesC8 &) |
| void | SetDefaultValueL(const TDesC8 &) |
| void | SetDescriptionL(const TDesC8 &) |
| void | SetOccurenceL(TOccurence) |
| void | SetScopeL(TScope) |
| Public Member Enumerations | |
|---|---|
| enum | TDFFormat { EB64, EBool, EChr, EInt, ENode, ENull, EXml, EBin, EDate, ETime, EFloat } |
| enum | TOccurence { EOne, EZeroOrOne, EZeroOrMore, EOneOrMore, EZeroOrN, EOneOrN } |
| enum | TScope { EPermanent, EDynamic } |
| MSmlDmDDFObject & | AddChildObjectGroupL | ( | ) | [pure virtual] |
The function adds a child object, to be used as an object group. As an object group, there is no node name (these nodes are 'unnamed' in the DDF). Object group is a term used with for nodes in the management tree that are used as a container for other object groups, container for management objects or a container for both object groups and management objects. The term 'object group' is not used when referring to nodes which are part of the management object itself.
| MSmlDmDDFObject & | AddChildObjectL | ( | const TDesC8 & | aNodeName | ) | [pure virtual] |
The function adds a child object and sets name of the URI segment, which is used by the DM server. The highest object must be directly under root. An adapter is not able to set properties of the root object. The aNodeName argument should be an empty string, when the name is not fixed in DDF, i.e. in case of dynamic nodes.
| const TDesC8 & aNodeName | The name of the node |
| void | AddDFTypeMimeTypeL | ( | const TDesC8 & | aMimeType | ) | [pure virtual] |
The function sets a MIME type property to the object. MIME Type is a mandatory element for leaf objects. If this function is not called (for node elements), it means that the MIME type property value is not set at all.
| const TDesC8 & aMimeType | MIME type property. |
| void | SetAccessTypesL | ( | TSmlDmAccessTypes | aAccessTypes | ) | [pure virtual] |
The function sets permitted access types property to the object. Access types property is a mandatory element. If this function is not called all accesses are denied.
| TSmlDmAccessTypes aAccessTypes | Access types property. |
| void | SetAsObjectGroup | ( | ) | [pure virtual] |
The function sets an object as an object group. If this function is not called, it means that the object is not an object group. Object group is a term used with for the node in the management tree that is used as a container for other object groups, container for management objects or a container for both object groups and management objects. The term 'object group' is not used when talked about the nodes which are part of the management object itself. - This is not supported. MSmlDmDDFObject::AddChildObjectGroupL must be used instead of AddChildObjectL,SetAsObjectGroup.
| void | SetDFFormatL | ( | TDFFormat | aFormat | ) | [pure virtual] |
The function sets a format property to the object. Format is a mandatory element. If this function is not called for node element, Format is set as 'node'. For leaf elements this function must be called.
| TDFFormat aFormat | Format property. |
| void | SetDFTitleL | ( | const TDesC8 & | aTitle | ) | [pure virtual] |
The function sets a title property to the object. Title is not a mandatory element. If this function is not called, it means that a Title property value is not set at all.
| const TDesC8 & aTitle | DFTitle property. |
| void | SetDefaultValueL | ( | const TDesC8 & | aDefaultValue | ) | [pure virtual] |
The function sets a default value property to the object. Default value is not a mandatory element. If this function is not called, it means that the default value property is not set at all.
| const TDesC8 & aDefaultValue | Default value property. |
| void | SetDescriptionL | ( | const TDesC8 & | aDescription | ) | [pure virtual] |
The function sets a description property to the object. Description is not a mandatory element. If this function is not called, it means that the description property value is not set at all.
| const TDesC8 & aDescription | Description property. |
| void | SetOccurenceL | ( | TOccurence | aOccurence | ) | [pure virtual] |
The function sets an occurence property to the object. If this function is not called, an occurence is set as TOccurence::EOne.
| TOccurence aOccurence | Occurence property. |
| void | SetScopeL | ( | TScope | aScope | ) | [pure virtual] |
The function sets a scope property to the object. If this function is not called, the scope is set as TScope::EDynamic.
| TScope aScope | Scope property. |
The possible formats of a node.
| EB64 |
Base64 encoded |
| EBool |
Boolean |
| EChr |
Character data |
| EInt |
Integer |
| ENode |
A DM Tree interior node |
| ENull |
No data |
| EXml |
XML character data |
| EBin |
Binary data |
| EDate |
Date data |
| ETime |
Time data |
| EFloat |
Float |
The possible occurrences of a node.
| EOne |
The node appears exactly once |
| EZeroOrOne |
The node is optional and may appear zero or once |
| EZeroOrMore |
The node is optional and may appear zero or more times |
| EOneOrMore |
The node is mandatory and may appear once or more times |
| EZeroOrN |
The node is optional and may appear between once and 'N' times |
| EOneOrN |
The node is mandatory and may appear between once and 'N' times |
The possible scopes of a node.
| EPermanent |
The node is permanent in the DM Tree |
| EDynamic |
The node is created at run-time in the DM Tree |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.