/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.ace.client.repository.object;

import java.util.List;

import org.apache.ace.client.repository.RepositoryObject;

/**
 * Interface to a FeatureObject. The basic functionality is defined by RepositoryObject, but extended for
 * feature-specific information.
 */
public interface FeatureObject extends RepositoryObject {
    public static final String KEY_DESCRIPTION = "description";
    public static final String KEY_NAME = "name";

    public static final String TOPIC_ENTITY_ROOT = FeatureObject.class.getSimpleName() + "/";

    public static final String TOPIC_ADDED = PUBLIC_TOPIC_ROOT + TOPIC_ENTITY_ROOT + TOPIC_ADDED_SUFFIX;
    public static final String TOPIC_REMOVED = PUBLIC_TOPIC_ROOT + TOPIC_ENTITY_ROOT + TOPIC_REMOVED_SUFFIX;
    public static final String TOPIC_CHANGED = PUBLIC_TOPIC_ROOT + TOPIC_ENTITY_ROOT + TOPIC_CHANGED_SUFFIX;
    public static final String TOPIC_ALL = PUBLIC_TOPIC_ROOT + TOPIC_ENTITY_ROOT + TOPIC_ALL_SUFFIX;

    /**
     * Returns all <code>ArtifactObject</code>s this object is associated with. If there
     * are none, an empty list will be returned.
     */
    public List<ArtifactObject> getArtifacts();
    
    /**
     * Returns all <code>DistributionObject</code>s this object is associated with. If there
     * are none, an empty list will be returned.
     */
    public List<DistributionObject> getDistributions();

    /**
     * Returns all associations this feature has with a given artifact.
     */
    public List<Artifact2FeatureAssociation> getAssociationsWith(ArtifactObject artifact);
    
    /**
     * Returns all associations this feature has with a given distribution.
     */
    public List<Feature2DistributionAssociation> getAssociationsWith(DistributionObject distribution);

    /**
     * Returns the name of this feature.
     */
    public String getName();

    /**
     * Sets the name of this feature.
     */
    public void setName(String name);
    
    /**
     * Returns the description of this feature.
     */
    public String getDescription();
    
    /**
     * Sets the description of this feature.
     */
    public void setDescription(String description);
}