<html> <head> <title>Interface XAggregation</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="XAggregation-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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">uno</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">deprecated </td> <td width="50%" class="title">interface XAggregation</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Deprecation Info</b></dt> <dd>Aggregation will no longer be supported as a high-level concept of UNO. You may still have the option to implement an UNO object consisting of several single objects in your specific programming language, though this depends on your programming language. </dd> <dt><b>Description</b></dt> <dd>Objects which implement this interface can become aggregates of a delegator. </dd> <dd><p>That means if an object "A" aggregates "B", "A" can provide all or some of the interfaces of "B". Whenever the method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a> is called on either of the objects, the call will be forwarded to object "A". Object "A" now can determine whether to use the interfaces of "A" or "B" or neither. Actually, any number of aggregates can be used, even nested ones (aggregated objects which are delegators by themselves). <p>The following rules are to be observed: <ol> <li>All calls to <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#acquire">acquire()</a> which are made before the delegator was set (using the method <a href="XAggregation.html#setDelegator()">setDelegator()</a>) must not be taken back (using the method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#release">release()</a>) before the delegation is removed by calling <code>xAggregation->setDelegator(NULL)</code>. <li>The constructor of a delegator has to increment its own reference count by calling its method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#acquire">acquire()</a> before it sets itself to any aggregate using the method <a href="XAggregation.html#setDelegator()">setDelegator()</a>. After that call it has to reset its own reference count without the destructor getting called. <li>The destructor of a delegator has to reset the delegator in its aggregated objects by calling their method <a href="XAggregation.html#setDelegator()">setDelegator()</a> with <b>NULL</b> before it releases its reference to its aggregated objects. </ol> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/WritingUNO/Core_Interfaces_to_Implement">WritingUNO - Core Interfaces to Implement</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/WritingUNO/XAggregation">WritingUNO - XAggregation</a></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="#setDelegator">setDelegator</a></td> <td class="imsum_right">sets the object to which all calls to the method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a> have to be forwarded. @ </td> </tr> <tr> <td class="imsum_left"><a href="#queryAggregation">queryAggregation</a></td> <td class="imsum_right">is similar to <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a>, but it is to be processed directly without being forwarded to the delegator. @ </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="setDelegator" class="membertitle">setDelegator</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>setDelegator</b>(</td> <td valign="top">[in] <a href="XInterface.html">XInterface</a></td> <td valign="bottom"> pDelegator );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the object to which all calls to the method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a> have to be forwarded. @ </dd> <dt><b>Parameter xDelegator</b></dt> <dd>specifies the object which handles the calls to <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a>. If <var>xDelegator</var> is <b>NULL</b>, the delegator is removed and thus the object becomes its own delegator and has to handle calls to the method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a> itself. </dd> <dt><b>See also</b></dt> <dd><a href="XAggregation.html">XAggregation</a>::<a href="XAggregation.html#queryAggregation">queryAggregation</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryAggregation" class="membertitle">queryAggregation</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">any</td> </tr> <tr> <td valign="top"><b>queryAggregation</b>(</td> <td valign="top">[in] type</td> <td valign="bottom"> aType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is similar to <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a>, but it is to be processed directly without being forwarded to the delegator. @ </dd> <dd><p>This method is only called from within an implementation of <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a> or <a href="XAggregation.html">XAggregation</a>::<a href="XAggregation.html#queryAggregation">queryAggregation()</a>. This method is to be called by the delegator if it does not implement the interface itself. An object which got aggregated cannot depend on getting its own interface when it calls the method <a href="XInterface.html">XInterface</a>::<a href="XInterface.html#queryInterface">queryInterface()</a>. </dd> <dt><b>See also</b></dt> <dd><a href="XAggregation.html">XAggregation</a>::<a href="XAggregation.html#setDelegator">setDelegator</a></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>