(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

:: com :: sun :: star :: container ::

interface XIdentifierContainer
Base Interfaces
XIdentifierContainerXIdentifierReplaceXIdentifierAccessXElementAccess

XIdentifierReplace
(referenced interface's summary:)
This is the generic interface for supporting the replacement of elements with unique identifiers.
Description
This is the generic interface for supporting the creation and removal of elements with unique identifiers.
See also
XContainer

Methods' Summary
insert inserts an element and creates a new unique identifier for it.  
removeByIdentifier removes the element with the specified identifier.  
Methods' Details
insert
long
insert( [in] 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 ::com::sun::star::lang::WrappedTargetException exception.
removeByIdentifier
void
removeByIdentifier( [in] long  Identifier )
raises( 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 ::com::sun::star::lang::WrappedTargetException exception.
Top of Page

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.