<html>
<head>
<title>Interface XPackage</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="XPackage-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">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 XPackage</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XPackage</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>implemented to notify that the package has been removed
</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>notifies changes of the registration state of the package
</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>Objects of this interface reflect a bound package and are issued by a
<a href="PackageRegistryBackend.html">PackageRegistryBackend</a>.
</dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</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="#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="#checkPrerequisites">checkPrerequisites</a></td>
<td class="imsum_right">checks if the package can be installed.
Only if the return value is true the package is allowed to be installed.
In case of false or in case of an exception, the package must be removed
in completely.
After return of this function no code from the extension may be used
anymore, so that the extension can be safely removed from the harddisk.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#checkDependencies">checkDependencies</a></td>
<td class="imsum_right">checks if the dependencies for this package are still satisfied
After updateing the OpenOffice.org, some dependencies for packages might
no longer be satisfied.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isRegistered">isRegistered</a></td>
<td class="imsum_right">determines whether the package is currently is registered, i.e.
whether it is active.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#registerPackage">registerPackage</a></td>
<td class="imsum_right">registers this <a href="XPackage.html">XPackage</a>, thus activating the package.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#revokePackage">revokePackage</a></td>
<td class="imsum_right">revokes this <a href="XPackage.html">XPackage</a>.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isBundle">isBundle</a></td>
<td class="imsum_right">reflects whether this package is a bundle of one or more packages,
e.g. a zip (legacy) package file or a document hosting script packages.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getBundle">getBundle</a></td>
<td class="imsum_right">Gets packages of the bundle.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getName">getName</a></td>
<td class="imsum_right">returns the file name of the package.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getIdentifier">getIdentifier</a></td>
<td class="imsum_right">returns the unique extension identifier.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getVersion">getVersion</a></td>
<td class="imsum_right">returns the textual version representation of the package.
A textual version representation is a finite string following the
BNF<br/>
version ::= [element ("." element)*]<br/>
element ::= ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")+
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getURL">getURL</a></td>
<td class="imsum_right">returns the location of the package.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDisplayName">getDisplayName</a></td>
<td class="imsum_right">returns the display name of the package, e.g. for graphical user
interfaces (GUI).
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDescription">getDescription</a></td>
<td class="imsum_right">returns a description string to describe the package.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getUpdateInformationURLs">getUpdateInformationURLs</a></td>
<td class="imsum_right">returns a sequence of update information URLs.
The sequence may be empty in case no update information is available.
If the sequence contains more than one URL, the extra URLs must mirror
the information available at the first URL.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPublisherInfo">getPublisherInfo</a></td>
<td class="imsum_right">returns the publisher info for a package, the strings
might be empty, if there are no publisher
::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First
represents the publisher name and
::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second
represents the URL to the publisher.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPackageType">getPackageType</a></td>
<td class="imsum_right">returns the <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>, e.g. media-type etc.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#exportTo">exportTo</a></td>
<td class="imsum_right">exports package to given destination URL.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getIcon">getIcon</a></td>
<td class="imsum_right">returns an icon for a package.
</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="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="checkPrerequisites" class="membertitle">checkPrerequisites</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>checkPrerequisites</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/><td valign="top">[in] boolean</td>
<td valign="bottom"> installed,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom"> aContextName )</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> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>checks if the package can be installed.
Only if the return value is true the package is allowed to be installed.
In case of false or in case of an exception, the package must be removed
in completely.
After return of this function no code from the extension may be used
anymore, so that the extension can be safely removed from the harddisk.
</dd>
<dt><b>Parameter xCmdEnv</b></dt>
<dd>command environment for error handling and other interaction.
@installed
signalls if an extension with the same identifyer is already installed.
@aContextName
the name of the context of XPackageManager implementation that is to be used
to install the extension. Currently we use the names "user"
and "shared".
</dd>
<dt><b>Returns</b></dt>
<dd>true - the package can be installed
false - the package must not be installed.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="checkDependencies" class="membertitle">checkDependencies</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>checkDependencies</b>(</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> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>checks if the dependencies for this package are still satisfied
After updateing the OpenOffice.org, some dependencies for packages might
no longer be satisfied.
</dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.2.0</dd>
<dt><b>Parameter xCmdEnv</b></dt>
<dd>command environment for error handling and other interaction.
</dd>
<dt><b>Returns</b></dt>
<dd>true - all dependencies are satisfied
false - at least one dependency failed.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isRegistered" class="membertitle">isRegistered</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="../beans/module-ix.html">beans</a>::<a href="../beans/Optional.html">Optional</a>< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/Ambiguous.html">Ambiguous</a>< boolean > ></td>
</tr>
<tr>
<td valign="top"><b>isRegistered</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> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines whether the package is currently is registered, i.e.
whether it is active.
</dd>
<dt><b>Parameter xAbortChannel</b></dt>
<dd>abort channel to asynchronously abort the registration 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>status whether the package is registered (<b>true</b>, <b>false</b>) or
the status is ambiguous. Additionally, a registration status
may not apply, e.g. in case of an empty package bundle.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="registerPackage" class="membertitle">registerPackage</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>registerPackage</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>registers this <a href="XPackage.html">XPackage</a>, thus activating the package.
</dd>
<dt><b>Parameter xAbortChannel</b></dt>
<dd>abort channel to asynchronously abort the registration 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="revokePackage" class="membertitle">revokePackage</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>revokePackage</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>revokes this <a href="XPackage.html">XPackage</a>.
</dd>
<dt><b>Parameter xAbortChannel</b></dt>
<dd>abort channel to asynchronously abort the registration 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="isBundle" class="membertitle">isBundle</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>isBundle</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>reflects whether this package is a bundle of one or more packages,
e.g. a zip (legacy) package file or a document hosting script packages.
</dd>
<dt><b>Returns</b></dt>
<dd>in case this package relfects a package bundle
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getBundle" class="membertitle">getBundle</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>getBundle</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 packages of the bundle.
</dd>
<dt><b>Parameter xAbortChannel</b></dt>
<dd>abort channel to asynchronously abort the registration 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>set of packages enclosed in this package
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getName" class="membertitle">getName</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>getName</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the file name of the package.
</dd>
<dt><b>Returns</b></dt>
<dd>file name of the package
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getIdentifier" class="membertitle">getIdentifier</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="../beans/module-ix.html">beans</a>::<a href="../beans/Optional.html">Optional</a>< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/Ambiguous.html">Ambiguous</a>< boolean > ></td>
</tr>
<tr>
<td valign="top"><b>getIdentifier</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the unique extension identifier.
</dd>
<dt><b>Returns</b></dt>
<dd>the extension identifier (a
<code>"org.openoffice.legacy."</code> one if the extension does not
explicitly specify one), or an empty <code>Optional</code> if this
package does not represent an extension
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getVersion" class="membertitle">getVersion</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>getVersion</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the textual version representation of the package.
A textual version representation is a finite string following the
BNF<br/>
version ::= [element ("." element)*]<br/>
element ::= ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")+
</dd>
<dt><b>Returns</b></dt>
<dd>the textual version representation
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getURL" class="membertitle">getURL</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>getURL</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the location of the package.
</dd>
<dt><b>Returns</b></dt>
<dd>location of package
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDisplayName" class="membertitle">getDisplayName</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>getDisplayName</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the display name of the package, e.g. for graphical user
interfaces (GUI).
</dd>
<dt><b>Returns</b></dt>
<dd>display name of the package
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDescription" class="membertitle">getDescription</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>getDescription</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a description string to describe the package.
</dd>
<dt><b>Returns</b></dt>
<dd>description
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getUpdateInformationURLs" class="membertitle">getUpdateInformationURLs</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< string ></td>
</tr>
<tr>
<td valign="top"><b>getUpdateInformationURLs</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a sequence of update information URLs.
The sequence may be empty in case no update information is available.
If the sequence contains more than one URL, the extra URLs must mirror
the information available at the first URL.
</dd>
<dt><b>Returns</b></dt>
<dd>update information URLs
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPublisherInfo" class="membertitle">getPublisherInfo</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="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a></td>
</tr>
<tr>
<td valign="top"><b>getPublisherInfo</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the publisher info for a package, the strings
might be empty, if there are no publisher
::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::First
represents the publisher name and
::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/StringPair.html">StringPair</a>::Second
represents the URL to the publisher.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPackageType" class="membertitle">getPackageType</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="XPackageTypeInfo.html">XPackageTypeInfo</a></td>
</tr>
<tr>
<td valign="top"><b>getPackageType</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>, e.g. media-type etc.
</dd>
<dt><b>Returns</b></dt>
<dd>media type of package
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="exportTo" class="membertitle">exportTo</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>exportTo</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom"> destFolderURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom"> newTitle,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom"> nameClashAction,</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">::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> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>exports package to given destination URL.
</dd>
<dt><b>Parameter destFolderURL</b></dt>
<dd>package destination folder URL, must be UCB conform
</dd>
<dt><b>Parameter newTitle</b></dt>
<dd>new package name
</dd>
<dt><b>Parameter nameClashAction</b></dt>
<dd>one of ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/NameClash.html">NameClash</a>
</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="getIcon" class="membertitle">getIcon</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="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a></td>
</tr>
<tr>
<td valign="top"><b>getIcon</b>(</td>
<td valign="top">[in] boolean</td>
<td valign="bottom"> highContrast );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns an icon for a package.
</dd>
<dt><b>Parameter highContrast</b></dt>
<dd>return high contrast icon
</dd>
<dt><b>Returns</b></dt>
<dd>the icon which should be used to represent the table in the
database application window, or <b>NULL</b> if the default icon
should be used.
</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
>
2315
