/*
 * Copyright 2007 the original author or authors.
 * 
 * Licensed 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.wamblee.system.core;

import java.util.Collection;

/**
 * Represents an interface provided by a component.
 * Different component objects should never share ProvidedInterface instances!
 *  
 * @author Erik Brakkee
 */
public interface ProvidedInterface {
    
	/**
	 * Symbolic name for the service as used by the subsystem.  
	 * @return Service name. 
	 */
	String getName();
	
	/**
	 * Returns the service type. 
	 * @return Service type. 
	 */
	Class[] getInterfaceTypes();
	
	/**
	 * Sets a unique id of the provided interface to identify it within a given scope.
	 * Will be called by the container as part of calling {@link #publish(Object, Scope)}. 
	 * @param aId Unique id. 
	 */
	void setUniqueId(String aId);

	/**
	 * Gets the unique if of the provided interface. This is set by the container
	 * using {@link #setUniqueId(String)}.  
	 */
	String getUniqueId();

	/**
	 * Publishes an implementation of the interface. The implementation must 
	 * call {@link Scope#publishInterface(ProvidedInterface, Object)} to publish the
	 * interface implementation in a given scope.  
	 * @param aImplementation Implementation to publish. 
	 * @param aScope Scope in which to publish the implementation. 
	 */
	void publish(Object aImplementation, Scope aScope);
}