001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.model;
016    
017    import com.liferay.portal.kernel.util.Tuple;
018    import com.liferay.portal.kernel.xml.Element;
019    
020    import java.io.InputStream;
021    
022    import java.util.List;
023    import java.util.Map;
024    
025    /**
026     * @author Brian Wing Shun Chan
027     */
028    public interface ModelHints {
029    
030            public String buildCustomValidatorName(String validatorName);
031    
032            public Map<String, String> getDefaultHints(String model);
033    
034            public Element getFieldsEl(String model, String field);
035    
036            public Map<String, String> getHints(String model, String field);
037    
038            public int getMaxLength(String model, String field);
039    
040            public List<String> getModels();
041    
042            public Tuple getSanitizeTuple(String model, String field);
043    
044            public List<Tuple> getSanitizeTuples(String model);
045    
046            public String getType(String model, String field);
047    
048            public List<Tuple> getValidators(String model, String field);
049    
050            public String getValue(
051                    String model, String field, String name, String defaultValue);
052    
053            public boolean hasField(String model, String field);
054    
055            public boolean isCustomValidator(String validatorName);
056    
057            public boolean isLocalized(String model, String field);
058    
059            public void read(ClassLoader classLoader, InputStream inputStream)
060                    throws Exception;
061    
062            public void read(ClassLoader classLoader, String source) throws Exception;
063    
064            public String trimString(String model, String field, String value);
065    
066    }