Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/action/ParameterConstraint.java
Alan Davis 681ff6b9c4 Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)
104506: Merged 5.0.N (5.0.2) to HEAD-BUG-FIX (5.1/Cloud)
      104357: Merged V4.2-BUG-FIX (4.2.5) to 5.0.N (5.0.2)
         104292: Merged DEV to V4.2-BUG-FIX (4.2.5)
            104235: MNT-13951 : Please use LinkedHashMap in EnumParameterConstraint.java to take control on selectone.ftl's dropdown list options order
               - Changed collection type from HashMap to LinkedHashMap.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@104637 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2015-05-20 12:00:11 +00:00

60 lines
1.7 KiB
Java

/*
* Copyright (C) 2009-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco 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.
*
* Alfresco 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 Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.service.cmr.action;
import java.util.Map;
import org.alfresco.api.AlfrescoPublicApi;
/**
* Parameter constraint. Helps to constraint the list of allowable values for a action parameter.
*
* @author Roy Wetherall
*/
@AlfrescoPublicApi
public interface ParameterConstraint
{
/**
* Gets the unique name of the constraint
*
* @return String constraint name
*/
String getName();
/**
* Indicates whether the provided value satisfies the constraint. True if it does, false otherwise.
*
* @return boolean true if valid, false otherwise
*/
boolean isValidValue(String value);
/**
*
* @param value
* @return
*/
String getValueDisplayLabel(String value);
/**
* The implementers are expected to return allowed values in the insertion order.
*/
Map<String, String> getAllowableValues();
}