:: com :: sun :: star :: util ::

interface XAtomServer

Methods' Summary
getClass returns a whole atom class  
getClasses returns multiple atom classes  
getAtomDescriptions returns the strings for an arbitrary amount of atoms of multiple classes  
getRecentAtoms returns the atoms that have been registered to a class after an already known atom  
getAtom registers or searches for a string  
Methods' Details
getClass
sequence< AtomDescription >
getClass( [in] long  atomClass );

Description
returns a whole atom class
Parameter atomClass
which class to return
Returns
the descriptions for all atoms of class atomClass
getClasses
sequence< sequence< AtomDescription > >
getClasses( [in] sequence< long >  atomClasses );

Description
returns multiple atom classes
Parameter atomClasses
which classes to return
Returns
the descriptions for all atoms of the requested classes
getAtomDescriptions
sequence< string >
getAtomDescriptions( [in] sequence< AtomClassRequest >  atoms );

Description
returns the strings for an arbitrary amount of atoms of multiple classes
Parameter atoms
describes which strings to return
Returns
the strings for the requested atoms
getRecentAtoms
sequence< AtomDescription >
getRecentAtoms( [in] long  atomClass,
[in] long  atom );

Description
returns the atoms that have been registered to a class after an already known atom

Hint to implementor: using ascending atoms is the easiest way to decide, which atoms are recent.

Parameter atomClass
the class in question
Parameter atom
the last known atom
Returns
all atom description that have been added to class atomClass after atom
getAtom
long
getAtom( [in] long  atomClass,
[in] string  description,
[in] boolean  create );

Description
registers or searches for a string
Parameter atomClass
the class of atoms in question
Parameter description
the string in question
Parameter create
if true a new atom will be created for an unknown string else the invalid atom (0) will be returned for an unknown string
Returns
the atom for the string description
Top of Page