001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.targetplatforms.api;
020
021import java.util.List;
022import java.util.Map;
023
024/**
025 * Represents a target platform info, useful for listing of available target platforms.
026 *
027 * @since 5.7.1
028 */
029public interface TargetPlatformInfo extends TargetInfo, Comparable<TargetPlatformInfo> {
030
031    /**
032     * Return the list of ids of packages available on this target platform.
033     */
034    List<String> getAvailablePackagesIds();
035
036    /**
037     * Return the map of packages available on this target platform.
038     */
039    Map<String, TargetPackageInfo> getAvailablePackagesInfo();
040
041    /**
042     * Add a package to the list of available packages.
043     */
044    void addAvailablePackageInfo(TargetPackageInfo pack);
045
046    /**
047     * Sets available packages on this target platform.
048     */
049    void setAvailablePackagesInfo(Map<String, TargetPackageInfo> packages);
050
051}