<html> <head> <title>Interface XPackageManager</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="XPackageManager-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">deployment</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 XPackageManager</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XPackageManager</strong> ┣ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>interface to notify disposing </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>interface to notify changes of the set of deployed packages of this manager </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The <a href="XPackageManager.html">XPackageManager</a> interface is used to add or remove packages to a specific deployment context. Packages are deployable files, e.g. scripts or UNO components. </dd> <dd><p> Adding an UNO package means that a copy of the package is stored with respect to the context of the manager and the package is registered, thus activated. </p> <p> Removing an UNO package means that the previously added package is revoked, thus deactivated, first and then removed from the context. </p> <p> Objects of this interface are created using the <a href="XPackageManagerFactory.html">XPackageManagerFactory</a> service resp. the singleton <code> /singletons/com.sun.star.deployment.thePackageManagerFactory </code>. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</dd> <dt><b>See also</b></dt> <dd><a href="thePackageManagerFactory.html">thePackageManagerFactory</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="#getContext">getContext</a></td> <td class="imsum_right">returns the underlying deployment context. </td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedPackageTypes">getSupportedPackageTypes</a></td> <td class="imsum_right">gets the supported <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>s. </td> </tr> <tr> <td class="imsum_left"><a href="#createAbortChannel">createAbortChannel</a></td> <td class="imsum_right">creates a command channel to be used to asynchronously abort a command. </td> </tr> <tr> <td class="imsum_left"><a href="#addPackage">addPackage</a></td> <td class="imsum_right">adds an UNO package. </td> </tr> <tr> <td class="imsum_left"><a href="#removePackage">removePackage</a></td> <td class="imsum_right">removes an UNO package. </td> </tr> <tr> <td class="imsum_left"><a href="#getDeployedPackage">getDeployedPackage</a></td> <td class="imsum_right">gets a deployed package. </td> </tr> <tr> <td class="imsum_left"><a href="#getDeployedPackages">getDeployedPackages</a></td> <td class="imsum_right">gets all currently deployed packages. </td> </tr> <tr> <td class="imsum_left"><a href="#reinstallDeployedPackages">reinstallDeployedPackages</a></td> <td class="imsum_right">Expert feature: erases the underlying registry cache and reinstalls all previously added packages. Please keep in mind that all registration status get lost. </td> </tr> <tr> <td class="imsum_left"><a href="#isReadOnly">isReadOnly</a></td> <td class="imsum_right">indicates that this implementation cannot be used for tasks which require write access to the location where the extensions are installed. </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="getContext" class="membertitle">getContext</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>getContext</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the underlying deployment context. </dd> <dt><b>Returns</b></dt> <dd>underlying deployment context </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSupportedPackageTypes" class="membertitle">getSupportedPackageTypes</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< <a href="XPackageTypeInfo.html">XPackageTypeInfo</a> ></td> </tr> <tr> <td valign="top"><b>getSupportedPackageTypes</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the supported <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>s. </dd> <dt><b>Returns</b></dt> <dd>supported <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>s. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createAbortChannel" class="membertitle">createAbortChannel</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">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> </tr> <tr> <td valign="top"><b>createAbortChannel</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a command channel to be used to asynchronously abort a command. </dd> <dt><b>Returns</b></dt> <dd>abort channel </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addPackage" class="membertitle">addPackage</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"><a href="XPackage.html">XPackage</a></td> </tr> <tr> <td valign="top"><b>addPackage</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> url,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> mediaType,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds an UNO package. </dd> <dt><b>Parameter url</b></dt> <dd>package URL, must be UCB conform </dd> <dt><b>Parameter mediaType</b></dt> <dd>media-type of package, empty string if to be detected </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the adding process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> <dt><b>Returns</b></dt> <dd><a href="XPackage.html">XPackage</a> handle </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removePackage" class="membertitle">removePackage</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>removePackage</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> identifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> fileName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes an UNO package. </dd> <dt><b>Parameter identifier</b></dt> <dd>package identifier </dd> <dt><b>Parameter fileName</b></dt> <dd>package file name </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the removing process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDeployedPackage" class="membertitle">getDeployedPackage</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"><a href="XPackage.html">XPackage</a></td> </tr> <tr> <td valign="top"><b>getDeployedPackage</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> identifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> fileName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets a deployed package. </dd> <dt><b>Parameter identifier</b></dt> <dd>package identifier </dd> <dt><b>Parameter fileName</b></dt> <dd>package file name </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> <dt><b>Returns</b></dt> <dd><a href="XPackage.html">XPackage</a> handle </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDeployedPackages" class="membertitle">getDeployedPackages</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< <a href="XPackage.html">XPackage</a> ></td> </tr> <tr> <td valign="top"><b>getDeployedPackages</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets all currently deployed packages. </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the removing process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> <dt><b>Returns</b></dt> <dd>all currently deployed packages </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="reinstallDeployedPackages" class="membertitle">reinstallDeployedPackages</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>reinstallDeployedPackages</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Expert feature: erases the underlying registry cache and reinstalls all previously added packages. Please keep in mind that all registration status get lost. </dd> <dd><p> Please use this in case of suspected cache inconsistencies only. </p> </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the adding process </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isReadOnly" class="membertitle">isReadOnly</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>isReadOnly</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>indicates that this implementation cannot be used for tasks which require write access to the location where the extensions are installed. </dd> <dd><p> Normally one would call a method and handle the exception if writing failed. However, a GUI interface may need to know beforehand if writing is allowed. For example, the Extension Manager dialog needs to enable / disable the Add button depending if the user has write permission. Only the XPackageManager implementation knows the location of the installed extensions. Therefore it is not possible to check "externally" for write permission. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2323
