Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XSchemaHandler
Description
receives a description of a configuration schema as a sequence of events.
Since
OOo 1.1.2

Methods' Summary
startSchema receives notification that a schema description is started.  
endSchema receives notification that the current schema description is complete.  
importComponent receives notification that the schema depends on templates from a different component.  
startComponent receives notification that a component description is started.  
endComponent receives notification that a component description is complete.  
startGroupTemplate receives notification that a template description is started for a group.  
startSetTemplate receives notification that a template description is started for a set.  
endTemplate receives notification that a template description is complete.  
startGroup receives notification that a group description is started.  
startSet receives notification that a set description is started.  
endNode receives notification that a node description is complete.  
addProperty receives notification that a property is added to the current node.  
addPropertyWithDefault receives notification that a property having a default value is added to the current node.  
addInstance receives notification that the current group has a child node that is an instance of a specified template.  
addItemType receives notification that the current set can contain items that are instances of a specified template.  
Methods' Details
startSchema
void
startSchema()
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a schema description is started.

The schema descrption may comprise components templates or both.

Throws
com::sun::star::configuration::backend::MalformedDataException if a schema is already started (and has not been ended).
Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
endSchema
void
endSchema()
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that the current schema description is complete.

Must match a previous call to startSchema.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if invalid data is detected in the schema
  • if there is a unfinished component or template in progress
  • if no schema is started at all

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
importComponent
void
importComponent( [in] string  aName )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that the schema depends on templates from a different component.
Parameter aName
specifies the name of the component.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there is a unfinished component or template in progress
  • if no schema is started at all
  • if the name is not a valid component name
  • if the requested component is not found

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
startComponent
void
startComponent( [in] string  aName )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a component description is started.

Subsequent calls describe the schema of the component until a matching call to endComponent is encountered.

Parameter aName
specifies the name of the component.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there is a unfinished component or template in progress
  • if no schema is started at all
  • if there already is a component data tree of this name
  • if the name is not a valid component name
  • if the instance supports no component schemas (only templates)

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
endComponent
void
endComponent()
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a component description is complete.

Must match a previous call to startComponent.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if invalid data is detected in the component
  • if there is a unfinished subnode in progress
  • if no component has been started at all
  • if the instance supports no component schemas (only templates)

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
startGroupTemplate
void
startGroupTemplate( [in] TemplateIdentifier  aTemplate,
[in] short  aAttributes )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a template description is started for a group.

Subsequent calls describe the members and properties of the template until a matching call to endTemplate is encountered.

Parameter aTemplate
specifies the identity of the template.
Parameter aAttributes
specifies the attributes of the template.

The value is a combination of SchemaAttribute flags.

SchemaAttribute::EXTENSIBLE can be used to describe a template for a node with an extensible set of properties.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there is a unfinished component or template in progress
  • if no schema is started at all
  • if there already is a template with that identifier
  • if the name is not a valid template identifier
  • if the attributes are not valid for a group
  • if the instance supports no templates (only component schemas)

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
See also
SchemaAttribute
startSetTemplate
void
startSetTemplate( [in] TemplateIdentifier  aTemplate,
[in] short  aAttributes,
[in] TemplateIdentifier  aItemType )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a template description is started for a set.

Subsequent calls describe the members and properties of the template until a matching call to endTemplate is encountered.

Parameter aTemplate
specifies the identity of the template.
Parameter aAttributes
specifies the attributes of the template.

The value is a combination of SchemaAttribute flags.

SchemaAttribute::EXTENSIBLE can be used to describe a template for a node with an extensible set of properties.

Parameter aItemType
specifies the (default) template for set items.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there is a unfinished component or template in progress
  • if no schema is started at all
  • if there already is a template with that identifier
  • if the item-type template is not found
  • if the name or item-type are not valid template identifiers
  • if the attributes are not valid for a set
  • if the instance supports no templates (only component schemas).

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
See also
SchemaAttribute
endTemplate
void
endTemplate()
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a template description is complete.

Must match a previous call to startGroupTemplate or startSetTemplate.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if invalid data is detected in the template
  • if there is a unfinished subnode in progress
  • if no template has been started at all
  • if the instance supports no templates (only component schemas)

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
startGroup
void
startGroup( [in] string  aName,
[in] short  aAttributes )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a group description is started.

Subsequent calls describe the members and properties of the group until a matching call to endNode is encountered.

Parameter aName
specifies the name of the group.
Parameter aAttributes
specifies the attributes of the node.

The value is a combination of SchemaAttribute flags.

SchemaAttribute::EXTENSIBLE can be used to describe a group with an extensible set of properties.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group node in progress currently
  • if there already is a node with that name
  • if the name is not a valid node name
  • if the attributes are not valid for a group

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
See also
SchemaAttribute
startSet
void
startSet( [in] string  aName,
[in] short  aAttributes,
[in] TemplateIdentifier  aItemType )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a set description is started.

Subsequent calls describe the item-types and properties of the set until a matching call to endNode is encountered.

Parameter aName
specifies the name of the set.
Parameter aAttributes
specifies the attributes of the node.

The value is a combination of SchemaAttribute flags.

SchemaAttribute::EXTENSIBLE can be used to describe a set with an extensible set of properties.

Parameter aItemType
specifies the (default) template for set items.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group node in progress currently
  • if there already is a node with that name
  • if the item-type template is not found
  • if the name is not a valid node name
  • if the item-type is not a valid template identifier
  • if the attributes are not valid for a set

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
See also
SchemaAttribute
endNode
void
endNode()
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a node description is complete.

Must match the last open call to startGroup or startSet.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if the name is not a the name of the node in progress
  • if invalid data is detected in the node
  • if no node has been started at all

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
addProperty
void
addProperty( [in] string  aName,
[in] short  aAttributes,
[in] type  aType )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a property is added to the current node.

The property will have a default value of NULL (unless it is SchemaAttribute::REQUIRED).

Parameter aName
specifies the name of the new property.
Parameter aAttributes
specifies the attributes of the new property.

The value is a combination of SchemaAttribute flags.

Parameter aType
specifies the type of the new property.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if a property with the same name already exists
  • if the specified type is not allowed
  • if the name is not a valid property name
  • if the attributes are not valid for a property

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
See also
SchemaAttribute
addPropertyWithDefault
void
addPropertyWithDefault( [in] string  aName,
[in] short  aAttributes,
[in] any  aDefaultValue )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that a property having a default value is added to the current node.
Parameter aName
specifies the name of the new property.
Parameter aAttributes
specifies the attributes of the new property.

The value is a combination of SchemaAttribute flags.

Parameter aDefaultValue
specifies the value of the new property.

The value also determines the type. Therefore the value must not be void.

Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group or extensible node in progress currently
  • if a property with the same name already exists
  • if the type of the default value is not an allowed type, or if the default value is void
  • if the name is not a valid property name
  • if the attributes are not valid for a property

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
See also
SchemaAttribute
addInstance
void
addInstance( [in] string  aName,
[in] TemplateIdentifier  aTemplate )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that the current group has a child node that is an instance of a specified template.
Parameter aName
specifies the name of the new node.
Parameter aTemplate
specifies a template that describes the new node.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a group node in progress currently
  • if there already is a node with that name
  • if the template is not found
  • if the name or template name are not valid

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
addItemType
void
addItemType( [in] TemplateIdentifier  aItemType )
raises( MalformedDataException,
::com::sun::star::lang::WrappedTargetException );

Description
receives notification that the current set can contain items that are instances of a specified template.
Parameter aItemType
specifies a template that is accepted as valid item type for the current set node.
Throws
com::sun::star::configuration::backend::MalformedDataException
  • if there isn't a set node in progress currently
  • if the template is not found
  • if the name is not a valid template name

Not every implementation can detect each condition

Throws
com::sun::star::lang::WrappedTargetException if an error occurs processing the event.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.