atom.content.pm.PackageManager Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2013 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.content.pm;

import atom.content.Intent;

import java.util.List;

/**
 * Interface for retrieving various kinds of information related to the
 * application packages that are currently installed inside the system.
 *
 * @author Alex Voloshyn
 * @author Serge Voloshyn
 * @version 1.4 10/30/13
 * @see DefaultPackageManager
 */
public interface PackageManager {
    /**
     * Error message template for cases when argument is empty.
     */
    String MSG_TMPL_EMPTY = "%s can't be empty.";
    /**
     * Error message for cases when several activities were found for the same
     * layer.
     */
    String MSG_LAYER_CONCURRENCY = "Several activities use the same layer.";

    /**
     * Retrieves package info by its package name.
     *
     * @param packageName the package name of the searched package
     * @return the package info for corresponding package name or null if it
     *         wasn't found
     */
    PackageInfo find(String packageName);

    /**
     * Registers new application package or throws IllegalArgumentException in
     * case when package info contains empty package name.
     *
     * @param packageInfo the application package that should be registered
     */
    void register(PackageInfo packageInfo);

    /**
     * Un-registers application package or throws IllegalArgumentException in
     * case when package info contains empty package name.
     *
     * @param packageInfo the application package that should be un-registered
     */
    void unregister(PackageInfo packageInfo);

    /**
     * Determine the best action to perform for a given Intent.
     *
     * @param intent an intent containing all of the desired specification
     *               (action, data, type, category, and/or component)
     * @return a list of ActivityInfo containing the final activity intent that
     *         was determined to be the best action
     */
    List resolveActivity(Intent intent);

    /**
     * Determine the best notifiers to use for a given Intent.
     *
     * @param intent an intent containing all of the desired specification
     *               (action, data, type, category, and/or component)
     * @return a list of NotifierInfo containing the final activity intent that
     *         was determined to be the best action
     */
    List resolveNotifier(Intent intent);
}