Interface XLayerHandler

Devguide

Index

Methods' Summary

Methods' Details

Attributes' Summary

Attributes' Details

:: drafts :: com :: sun :: star :: configuration :: backend ::

interface XLayerHandler

Base Hierarchy

::com::sun::star::uno::XInterface
 |
 +-XLayerHandler

Description: receives a description of a configuration layer as a sequence of events.

Methods' Summary
startLayer	receives notification that a layer description is started for a component.
endLayer	receives notification that a layer description is complete.
overrideNode	receives notification that a description of a node override is started.
addOrReplaceNode	receives notification that a new item is started.
addOrReplaceNodeFromTemplate	receives notification that a new item based on a particular template is started.
endNode	receives notification that a node description is complete.
dropNode	receives notification that a node is dropped from a set.
overrideProperty	receives notification that an existing property is modified.
setPropertyValue	receives notification that the value of the current property is overridden. .
setPropertyValueForLocale	receives notification that the value of the current localized property is overridden for a specific locale .
endProperty	receives notification that a property description is complete.
addProperty	receives notification that a property having a void value is added to the current node.
addPropertyWithValue	receives notification that a property having a non- void value is added to the current node.

Methods' Details

startLayer

void
startLayer()

raises(

MalformedDataException );

Description: receives notification that a layer description is started for a component.; Subsequent calls describe the contents of the layer until a matching call to XLayerHandler::endLayer() is encountered.
Throws: drafts::com::sun::star::configuration::backend::MalformedDataException if there is a unfinished layer in progress

endLayer

void
endLayer()

raises(

MalformedDataException,
::com::sun::star::lang::IllegalAccessException );

Description: receives notification that a layer description is complete.; Must match a previous call to XLayerHandler::startLayer() .
Throws: drafts::com::sun::star::configuration::backend::MalformedDataException if invalid data is detected in the layer, if there is a unfinished subnode in progress or if no layer is started at all.
Throws: com::sun::star::lang::IllegalAccessException if the layer tries to override read-only or final data

overrideNode

void
overrideNode(

[in] string
[in] short

raises(

aName,
aAttributes )
MalformedDataException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::IllegalAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description

receives notification that a description of a node override is started.

Subsequent calls describe overrides to properties and members or items of the node until a matching call to XLayerHandler::endNode() is encountered.

Parameter aName

specifies the name of the node.

Parameter aAttributes

specifies attribute values to be applied to the node.

The value is a combination of NodeAttribute flags.

The attributes are combined cumulatively with those set on lower layers.

Throws

drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a layer in progress or if there already was a change to that node.

Throws

com::sun::star::container::NoSuchElementException if there is no node with that name.

Throws

com::sun::star::lang::IllegalAccessException if the node is marked read-only in a lower layer

Throws

com::sun::star::lang::IllegalArgumentException if the name is not a valid node name or if the attributes are not valid for the node.

addOrReplaceNode

void
addOrReplaceNode(

[in] string
[in] short

raises(

aName,
aAttributes )
MalformedDataException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::IllegalAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description

receives notification that a new item is started.

The current node must be a set and a preexisting item (if any) must be removeable.

The new item will be created from the default template of the set.

Subsequent calls describe the difference from the template of properties and members or items of the node until a matching call to XLayerHandler::endNode() is encountered.

Parameter aName

specifies the name of the item.

Parameter aAttributes

specifies attribute values to be applied to the new node.

The value is a combination of NodeAttribute flags.

Throws

drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a set node in progress currently or if there already was a change to a node of that name.

Throws

com::sun::star::container::NoSuchElementException if the template for the new node is not found.

Throws

com::sun::star::lang::IllegalAccessException if an item of that name on a lower layer is not removeable

Throws

com::sun::star::lang::IllegalArgumentException if the name is not a valid item name or if the attributes are not valid for the node.

addOrReplaceNodeFromTemplate

void
addOrReplaceNodeFromTemplate(

[in] string
[in] TemplateIdentifier
[in] short

raises(

aName,
aTemplate,
aAttributes )
MalformedDataException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description

receives notification that a new item based on a particular template is started.

The current node must be a set and a preexisting item (if any) must be removeable.

Subsequent calls describe the difference from the template of properties and members or items of the node until a matching call to XLayerHandler::endNode() is encountered.

Parameter aName

specifies the name of the item.

Parameter aTemplate

specifies the template to use for the new node

Parameter aAttributes

specifies attribute values to be applied to the new node.

The value is a combination of NodeAttribute flags.

Throws

drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a set node in progress currently or if there already was a change to a node of that name.

Throws

com::sun::star::container::NoSuchElementException if the template for the new node is not found.

Throws

com::sun::star::beans::IllegalTypeException if the template is not a valid item type for the containing set.

Throws

com::sun::star::lang::IllegalAccessException if an item of that name on a lower layer is not removeable

Throws

com::sun::star::lang::IllegalArgumentException if the name is not a valid item name or if the attributes are not valid for the node.

endNode

void
endNode()

raises(

MalformedDataException );

Description: receives notification that a node description is complete.; Must match the last open call to XLayerHandler::overrideNode() , XLayerHandler::addOrReplaceNode() or XLayerHandler::addOrReplaceNodeFromTemplate() .
Throws: drafts::com::sun::star::configuration::backend::MalformedDataException if invalid data is detected in the node or if no node is started at all.

dropNode

void
dropNode(

[in] string

raises(

aName )
MalformedDataException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::IllegalAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description: receives notification that a node is dropped from a set.; The current node must be a set and the item must be removeable.
Parameter aName: specifies the name of the node.
Throws: drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a set node in progress currently or if there already was a change to a node of that name.
Throws: com::sun::star::container::NoSuchElementException if there is no item with that name.
Throws: com::sun::star::lang::IllegalAccessException if the item is not removeable
Throws: com::sun::star::lang::IllegalArgumentException if the name is not a valid node name.

overrideProperty

void
overrideProperty(

[in] string
[in] short
[in] type

raises(

aName,
aAttributes,
aType )
MalformedDataException,
::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description

receives notification that an existing property is modified.

Subsequent calls describe new value(s) for the property until a matching call to XLayerHandler::endProperty() is encountered.

Parameter aName

specifies the name of the property.

Parameter aAttributes

specifies the new attributes of the property.

The value is a combination of NodeAttribute flags.

The attributes are combined cumulatively with those set on lower layers.

Parameter aType

specifies the type of the property.

This must be the same type as is already defined in the schema or lower layers, unless the previous type was unspecified (as indicated by TypeClass::ANY .)

A void type indicates that the type is unspecified in this layer. In this case any subsequent value may be of a generic type (e.g. string or - for list values - string [] .) Such values may be converted to the type defined in the schema by the implementation.

Throws

drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a group or extensible node in progress currently or if there already was a change to a property of that name.

Throws

com::sun::star::beans::UnknownPropertyException if there is no property with that name.

Throws

com::sun::star::lang::IllegalAccessException if the property is read-only

Throws

com::sun::star::beans::IllegalTypeException if the type does not match the type of the property or if a type is missing and cannot be determined otherwise.

Throws

com::sun::star::lang::IllegalArgumentException if the name is not a valid property name or if the attributes are not valid for the property.

setPropertyValue

void
setPropertyValue(

[in] any

raises(

aValue )
MalformedDataException,
::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException );

Description

receives notification that the value of the current property is overridden. .

Parameter aValue

specifies the new value of the property.

The value must match the type of the current property. If the property does not have the SchemaAttribute::REQUIRED flag set, the value can be void .

If the current property is localized, this value applies to the default locale.

Throws

drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a property in progress currently or if there already was a change to the value of that property.

Throws

com::sun::star::beans::IllegalTypeException if the value does not have the proper type.

Throws

com::sun::star::lang::IllegalArgumentException if the value is not valid for the property.

setPropertyValueForLocale

void
setPropertyValueForLocale(

[in] any
[in] string

raises(

aValue,
aLocale )
MalformedDataException,
::com::sun::star::beans::IllegalTypeException,
::com::sun::star::lang::IllegalArgumentException );

Description: receives notification that the value of the current localized property is overridden for a specific locale .
Parameter aValue: specifies the new value of the property.
The value must match the type of the current property. If the property does not have the SchemaAttribute::REQUIRED flag set, the value can be void .
Parameter aLocale: specifies the locale this value should apply to.
Throws: drafts::com::sun::star::configuration::backend::MalformedDataException if there isn't a property in progress currently or if the current property isn't localized or if there already was a change to the property for that locale.
Throws: com::sun::star::beans::IllegalTypeException if the value does not have the proper type.
Throws: com::sun::star::lang::IllegalArgumentException if the value is not valid for the property or if the locale is not a valid locale
See also: com::sun::star::configuration::backend::NodeAttribute

endProperty

void
endProperty()

raises(

MalformedDataException );

Description: receives notification that a property description is complete.; Must match an open call to XLayerHandler::overrideProperty() ,
Throws: drafts::com::sun::star::configuration::backend::MalformedDataException if invalid data is detected in the property or if no property is started at all.