1 /*

     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Interface for resource installer

    15  *

    16 */

    17 

    18 

    19 package com.nokia.tools.themeinstaller.installationmanager;

    20 

    21 import java.io.IOException;

    22 import java.util.Vector;

    23 

    24 import com.nokia.tools.themeinstaller.odtconverter.ODTHeader;

    25 import com.nokia.tools.themeinstaller.odtconverter.ODTResource;

    26 

    27 /**

    28  * Interface for resource installer.

    29  */

    30 public interface IResourceInstaller

    31     {

    32 

    33     /**

    34      * Install a list of resource files. Copies resource files and creates

    35      * a list of ODT Resources.

    36      * @param aResources List of resource files to install

    37      * @param aHeader ODT Header for determining the install location. The

    38      * header is not altered

    39      * @return List of created ODT Resources

    40      * @throws IOException if resource file copying fails

    41      */

    42     public Vector installResources(

    43             Vector aResources,

    44             ODTHeader aHeader ) throws IOException;

    45 

    46 

    47     /**

    48      * Install a resource file. Copies the resource file and creates

    49      * an ODT Resource.

    50      * @param aResource The resource file to install

    51      * @param aHeader ODT Header for determining the install location. The

    52      * header is not altered

    53      * @return Created ODT Resource

    54      * @throws IOException if resource file can not be copied

    55      */

    56     public ODTResource installResource( ThemeResource aResource,

    57                                         ODTHeader aHeader ) throws IOException;

    58 

    59     /**

    60      * Puts ODT file itself as a resource

    61      * @param aHeader ODT Header of the ODT to add as resource. The header

    62      * itself is not altered

    63      * @param aNameSpace Theme name space

    64      * @return new ODTResource object

    65      */

    66     public ODTResource createODTResource( ODTHeader aHeader,

    67                                           String aNameSpace );

    68 

    69     }