Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: container ::
interface XIdentifierContainer
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XElementAccess
          |
          +-XIdentifierAccess
             |
             +-XIdentifierReplace
                |
                +-XIdentifierContainer
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 raises( | aElement ) ::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 raises( | Identifier ) 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

Copyright © 2003 Sun Microsystems, Inc.