Class MSmlDmDDFObject

class MSmlDmDDFObject;

Description

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.

Members

Defined in MSmlDmDDFObject:

• AddChildObjectGroupL()The function adds a child object, to be used as an object group. As an object gr...
• AddChildObjectL(const TDesC8 &)The function adds a child object and sets name of the URI segment, which is used...
• AddDFTypeMimeTypeL(const TDesC8 &)The function sets the MIME type property or the DDF Name property for the DDF no...
• EB64Base64 encoded
• EBinBinary data
• EBoolBoolean
• EChrCharacter data
• EDateDate in ISO 8601 format
• EDynamicThe node is created at run-time in the DM Tree
• EFloatReal number
• EIntInteger
• ENodeA DM Tree interior node
• ENullNo data
• EOneThe node appears exactly once
• EOneOrMoreThe node is mandatory and may appear once or more times
• EOneOrNThe node is mandatory and may appear between once and 'N' times
• EPermanentThe node is permanent in the DM Tree
• ETime Time in ISO 8601 format
• EXmlXML character data
• EZeroOrMoreThe node is optional and may appear zero or more times
• EZeroOrNThe node is optional and may appear between once and 'N' times
• EZeroOrOneThe node is optional and may appear zero or once
• SetAccessTypesL(TSmlDmAccessTypes)The function sets permitted access types property to the object. Access types pr...
• SetAsObjectGroup()The function sets an object as an object group. If this function is not called, ...
• SetDFFormatL(TDFFormat)The function sets a format property to the object. Format is a mandatory element...
• SetDFTitleL(const TDesC8 &)The function sets a title property to the object. Title is not a mandatory eleme...
• SetDefaultValueL(const TDesC8 &)The function sets a default value property to the object. Default value is not a...
• SetDescriptionL(const TDesC8 &)The function sets a description property to the object. Description is not a man...
• SetOccurenceL(TOccurence)The function sets an occurence property to the object. If this function is not c...
• SetScopeL(TScope)The function sets a scope property to the object. If this function is not called...
• TDFFormatThe possible formats of a node.
• TOccurenceThe possible occurrences of a node.
• TScopeThe possible scopes of a node.

virtual void SetAccessTypesL(TSmlDmAccessTypes aAccessTypes)=0;

Description

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.

Parameters

virtual void SetDefaultValueL(const TDesC8 &aDefaultValue)=0;

Description

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.

Parameters

virtual void SetDescriptionL(const TDesC8 &aDescription)=0;

Description

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.

Parameters

virtual void SetDFFormatL(TDFFormat aFormat)=0;

Description

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.

Parameters

virtual void SetOccurenceL(TOccurence aOccurence)=0;

Description

The function sets an occurence property to the object. If this function is not called, an occurence is set as TOccurence::EOne.

Parameters

virtual void SetScopeL(TScope aScope)=0;

Description

The function sets a scope property to the object. If this function is not called, the scope is set as TScope::EDynamic.

Parameters

virtual void SetDFTitleL(const TDesC8 &aTitle)=0;

Description

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.

Parameters

virtual void AddDFTypeMimeTypeL(const TDesC8 &aMimeType)=0;

Description

The function sets the MIME type property or the DDF Name property for the DDF node. MIME Type is a mandatory element for leaf nodes. DDF Name is an optional element for interior nodes. If this function is not called for leaf nodes, a default MIME type of 'text/plain' is used. If this function is not called for interior nodes, it means that the DDFName property value is not set at all.

Parameters

virtual void SetAsObjectGroup()=0;

Description

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.

virtual MSmlDmDDFObject& AddChildObjectL(const TDesC8 &aNodeName)=0;

Description

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.

Parameters

Return value

virtual MSmlDmDDFObject& AddChildObjectGroupL()=0;

Description

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.

Return value

TDFFormat

Description

The possible formats of a node.

TOccurence

Description

The possible occurrences of a node.

TScope

Description

The possible scopes of a node.