001/*
002 *  Copyright 2015 Anyware Services
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 */
016package org.ametys.cms.search.model;
017
018import org.ametys.cms.contenttype.MetadataType;
019import org.ametys.runtime.parameter.Enumerator;
020
021/**
022 * This interface represents a Field in the search paradigm.
023 */
024public interface Field
025{
026    
027    // TODO getFieldId() ?
028    
029    /**
030     * Get the field type.
031     * @return the field type.
032     */
033    MetadataType getType();
034    
035    /**
036     * Get the multiple status of the field.
037     * @return <code>true</code> if the field can have multiple values, <code>false</code> otherwise.
038     */
039    boolean isMultiple();
040    
041    /**
042     * Get the field Enumerator.
043     * @return the field Enumerator, or null.
044     */
045    Enumerator getEnumerator();
046    
047    /**
048     * In case of a Content reference field, the content type ID.
049     * @return the content type ID.
050     */
051    String getContentTypeId();
052
053}