<html> <head> <title>Service InstanceLocker</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="navimainnone">Use</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="#ConstructorsSummary" class="navisub">Constructors' Summary</a></td> <td class="navisub"><a href="#ConstructorsDetails" class="navisub">Constructors' Details</a></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">service InstanceLocker</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Supported Interface</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The main task of this service is to prevent closing, terminating and/or etc. of controlled object. </dd> <dd><p> After creation the service adds a listener of requested type ( close, terminate and/or etc. ) to the controlled object and let the listener throw related veto exception until the service is disposed. </p> </dd> </dl> </td> </tr> </table> <hr> <hr> <a name="ConstructorsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constructors' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#InstanceLockerCtor1">InstanceLockerCtor1</a></td> <td class="imsum_right">is used to initialize the object on it's creation. </td> </tr> <tr> <td class="imsum_left"><a href="#InstanceLockerCtor2">InstanceLockerCtor2</a></td> <td class="imsum_right">is used to initialize the object on it's creation. </td> </tr> </table> <a name="ConstructorsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constructors' Details</td> </tr> <tr> <td class="imdetail"><a name="InstanceLockerCtor1" class="membertitle">InstanceLockerCtor1</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"/></tr> <tr> <td valign="top"><b>InstanceLockerCtor1</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xInstance,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nActions )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/DoubleInitializationException.html">DoubleInitializationException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is used to initialize the object on it's creation. </dd> <dt><b>Parameter xInstance</b></dt> <dd>the controlled object. Must implement the related to the requested actions broadcaster interface. </dd> <dt><b>Parameter nActions</b></dt> <dd>specifies the actions that should be done ( prevent closing, prevent termination and/or etc. ). It must not be empty and can currently contain following values or their combination: <a href="Actions.html">Actions</a>::PREVENT_CLOSE and <a href="Actions.html">Actions</a>::PREVENT_TERMINATION. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InstanceLockerCtor2" class="membertitle">InstanceLockerCtor2</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"/></tr> <tr> <td valign="top"><b>InstanceLockerCtor2</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xInstance,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> aActions,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XActionsApproval.html">XActionsApproval</a></td> <td valign="bottom"> xApprove )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/DoubleInitializationException.html">DoubleInitializationException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is used to initialize the object on it's creation. </dd> <dt><b>Parameter xInstance</b></dt> <dd>the controlled object. Must implement the related to the requested actions broadcaster interface. </dd> <dt><b>Parameter nActions</b></dt> <dd>specifies the actions that should be done ( prevent closing, prevent termination and/or etc. ). It must not be empty and can currently contain following values or their combination: <a href="Actions.html">Actions</a>::PREVENT_CLOSE and <a href="Actions.html">Actions</a>::PREVENT_TERMINATION. </dd> <dt><b>Parameter xApprove</b></dt> <dd>The object implementing <a href="XActionsApproval.html">XActionsApproval</a> interface. If this parameter is an empty reference the object will proceed with the specified in the first parameter action until it is disposed ( just like in the case of the first constructor ). If the instance is provided, it will be asked for approval each time before proceeding with the action ( the action is specified using ::string and can take following values in this case: "PreventClose", "PreventTermination" ). </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>