<html> <head> <title>Interface XRelationshipAccess</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XRelationshipAccess-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">embed</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XRelationshipAccess</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>This interface allows to ge access to relationship data. </dd> <dd><p> The relationship data is organized as a set of entries. Each of entry is represented by a set of tags, where each tag has unique for this entry name and a string value. An entry must contain at least one tag named "ID", the value of this tag must be uniqued for the whole set of entries, this tag is used as a uniqued identified of an entry. </p> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#hasByID">hasByID</a></td> <td class="imsum_right">allows to detect whether there is an entry with specified value of "ID" tag. </td> </tr> <tr> <td class="imsum_left"><a href="#getTargetByID">getTargetByID</a></td> <td class="imsum_right">retrieves the value of "Target" tag from the entry with specified "ID" tag. </td> </tr> <tr> <td class="imsum_left"><a href="#getTypeByID">getTypeByID</a></td> <td class="imsum_right">retrieves the value of "Type" tag from the entry with specified "ID" tag. </td> </tr> <tr> <td class="imsum_left"><a href="#getRelationshipByID">getRelationshipByID</a></td> <td class="imsum_right">retrieves the sequence containing all the tags from the entry with specified value of "ID" tag. </td> </tr> <tr> <td class="imsum_left"><a href="#getRelationshipsByType">getRelationshipsByType</a></td> <td class="imsum_right">retrieves the sequence containing all the entries which "Type" tag takes the specified value. </td> </tr> <tr> <td class="imsum_left"><a href="#getAllRelationships">getAllRelationships</a></td> <td class="imsum_right">retrieves the sequence containing all the entries controlled by the object. </td> </tr> <tr> <td class="imsum_left"><a href="#insertRelationshipByID">insertRelationshipByID</a></td> <td class="imsum_right">allows to insert an entry. </td> </tr> <tr> <td class="imsum_left"><a href="#removeRelationshipByID">removeRelationshipByID</a></td> <td class="imsum_right">allows to remove an entry. </td> </tr> <tr> <td class="imsum_left"><a href="#insertRelationships">insertRelationships</a></td> <td class="imsum_right">allows to insert a set of entries </td> </tr> <tr> <td class="imsum_left"><a href="#clearRelationships">clearRelationships</a></td> <td class="imsum_right">allows to clear the set of entries. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="hasByID" class="membertitle">hasByID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasByID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sID )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to detect whether there is an entry with specified value of "ID" tag. </dd> <dt><b>Parameter sID</b></dt> <dd>the value of "ID" tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTargetByID" class="membertitle">getTargetByID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getTargetByID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sID )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the value of "Target" tag from the entry with specified "ID" tag. </dd> <dd><p> If the entry has no "Target" tag an empty string is returned. </p> </dd> <dt><b>Parameter sID</b></dt> <dd>the value of "ID" tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException in case there is no entry with specified tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTypeByID" class="membertitle">getTypeByID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getTypeByID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sID )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the value of "Type" tag from the entry with specified "ID" tag. </dd> <dd><p> If the entry has no "Type" tag an empty string is returned. </p> </dd> <dt><b>Parameter sID</b></dt> <dd>the value of "ID" tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException in case there is no entry with specified tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRelationshipByID" class="membertitle">getRelationshipByID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a> ></td> </tr> <tr> <td valign="top"><b>getRelationshipByID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sID )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the sequence containing all the tags from the entry with specified value of "ID" tag. </dd> <dt><b>Parameter sID</b></dt> <dd>the value of "ID" tag </dd> <dt><b>Returns</b></dt> <dd>sequence, each element of the sequence represents tag, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First represents the tag name and ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second represents the tag value </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException in case there is no entry with specified tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRelationshipsByType" class="membertitle">getRelationshipsByType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a> > ></td> </tr> <tr> <td valign="top"><b>getRelationshipsByType</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the sequence containing all the entries which "Type" tag takes the specified value. </dd> <dt><b>Parameter sType</b></dt> <dd>specified value of "Type" tag, the parameter can contain an empty string, in this case all the entries that have empty "Type" tag or no such tag at all are returned </dd> <dt><b>Returns</b></dt> <dd>sequence of entries, each entry is represented by sequence, each element of the sequence represents tag, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First represents the tag name and ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second represents the tag value. The sequence should contain the "ID" tag. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllRelationships" class="membertitle">getAllRelationships</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a> > ></td> </tr> <tr> <td valign="top"><b>getAllRelationships</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the sequence containing all the entries controlled by the object. </dd> <dt><b>Returns</b></dt> <dd>sequence of entries, each entry is represented by sequence, each element of the sequence represents tag, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First represents the tag name and ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second represents the tag value </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertRelationshipByID" class="membertitle">insertRelationshipByID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>insertRelationshipByID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sID,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a> ></td> <td valign="bottom"> aEntry,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bReplace )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to insert an entry. </dd> <dt><b>Parameter sID</b></dt> <dd>the value of "ID" tag </dd> <dt><b>Parameter aEntry</b></dt> <dd>a sequence, each element of the sequence represents tag, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First represents the tag name and ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second represents the tag value. May not contain "ID" tag, that is already specified in previous parameter. </dd> <dt><b>Parameter bReplace</b></dt> <dd>specifies whether the replacement of existing entry is allowed </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading/writing the relations info </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::ElementExistException in case an element with the specified "ID" tag exists already, and no replacement is allowed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeRelationshipByID" class="membertitle">removeRelationshipByID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeRelationshipByID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> sID )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to remove an entry. </dd> <dt><b>Parameter sID</b></dt> <dd>the value of "ID" tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::NoSuchElementException in case there is no entry with specified tag </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading/writing the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertRelationships" class="membertitle">insertRelationships</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>insertRelationships</b>(</td> <td valign="top">[in] sequence< sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a> > ></td> <td valign="bottom"> aEntries,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bReplace )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to insert a set of entries </dd> <dt><b>Parameter aEntries</b></dt> <dd>sequence of entries, each entry is represented by sequence, each element of the sequence represents tag, ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First represents the tag name and ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second represents the tag value. Each entry must contain "ID" tag. </dd> <dt><b>Parameter bReplace</b></dt> <dd>specifies whether the replacement of existing entry is allowed </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::container::ElementExistException in case an element with the provided "ID" tag exists already, and no replacement is allowed </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading/writing the relations info </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearRelationships" class="membertitle">clearRelationships</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>clearRelationships</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to clear the set of entries. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::io::IOException in case there is a problem reading/writing the relations info </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
3031
