interface XIdentifierContainer in module com::sun::star::container::

(Global Index)

Syntax

interface XIdentifierContainer : com::sun::star::container::XIdentifierReplace ;

Description

This is the generic interface for supporting the creation and removal of elements with unique identifiers.

See also

XContainer

Method Summary

insert inserts an element and creates a new unique identifier for it.

removeByIdentifier removes the element with the specified identifier.

Method Details



insert

Syntax

long insert (
any aElement )
raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::lang::WrappedTargetException );

Description

inserts an element and creates a new unique identifier for it.

Returns

the newly created identifier under which the element is inserted.

Parameter aElement

The new element that will be inserted.

Throws

com::sun::star::lang::IllegalArgumentException if the argument is not vailid for this container.

Throws

com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a WrappedTargetException exception.

removeByIdentifier

Syntax

void removeByIdentifier (
long Identifier )
raises ( com::sun::star::container::NoSuchElementException , com::sun::star::lang::WrappedTargetException );

Description

removes the element with the specified identifier.

Parameter Identifier

The identifier that should be removed.

Throws

com::sun::star::lang::NoSuchElementException If the identifier does not exist.

Throws

com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a WrappedTargetException exception.
Top of Page