/*
 * Copyright (C) 2005-2012 BetaCONCEPT Limited
 *
 * This file is part of Astroboa.
 *
 * Astroboa is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Astroboa is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Astroboa.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.betaconceptframework.astroboa.api.model.definition;

import java.util.List;
import java.util.Locale;

import org.betaconceptframework.astroboa.api.model.Topic;


/**
 * Definition for a simple property whose type is {@link Topic}.
 *
* <p>
 * Astroboa implementation uses an XML Schema <code>element</code> whose
 * <code>type</code> is Astroboa complex xml type <code>topic</code>
 * to describe simple property of type {@link Topic}.
 * 
 * The following example defines a simple property named <code>subject</code> which is
 * optional, single valued, of type {@link Topic} and whose 
 * label for {@link Locale#ENGLISH English} locale is <code>Article subject</code>.
 * 
 * <pre>
 * <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
 *	xmlns:bccmsmodel="http://www.betaconceptframework.org/schema/astroboa/model">
 *	
 *	<xs:import
 *		namespace="http://www.betaconceptframework.org/schema/astroboa/model"
 *		schemaLocation="http://www.betaconceptframework.org/schema/astroboa/astroboa-model-{version}.xsd" />
 *  ...
 *   <xs:element {@link CmsDefinition#getName() name}="subject" {@link CmsPropertyDefinition#isMandatory() minOccurs}="0" {@link CmsPropertyDefinition#isMultiple() maxOccurs}="1"  
 *        {@link CmsDefinition#getValueType() type}="bccmsmodel:topic" 
 *    <{@link LocalizableCmsDefinition xs:annotation}>
 *     <xs:documentation xml:lang="en">Article subject</xs:documentation>
 *    </xs:annotation>
 *   </xs:element>
 *  ...
 * </xs:schema>
 * </pre>
 * 
 * </p>
 * 
 * 
 * @author Gregory Chomatas (gchomatas@betaconcept.com)
 * @author Savvas Triantafyllou (striantafyllou@betaconcept.com)
 * 
 * @see <a href="http://www.betaconceptframework.org/schema/astroboa/astroboa-model-{version}.xsd">Astroboa model XML schema
 * for more on <code>topic</code> complex type. </a>
 * 
 */
public interface TopicReferencePropertyDefinition extends
		SimpleCmsPropertyDefinition<Topic> {

	/**
	 * Returns a list of accepted taxonomy names which can provide property's {@link Topic} value(s).
	 * 
	 * <p>
	 * Astroboa implementation uses attribute
	 * 	<a href="http://www.betaconceptframework.org/schema/astroboa/astroboa-model-{version}.xsd">acceptedTaxonomies</a> 
	 * to provide value for this attribute.
	 * </p>

	 * 
	 * @return Taxonomy name restriction.
	 */
	List<String> getAcceptedTaxonomies();

}