Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/action/ParameterDefinition.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

84 lines
2.2 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* 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/>.
* #L%
*/
package org.alfresco.service.cmr.action;
import org.alfresco.api.AlfrescoPublicApi;
import org.alfresco.service.namespace.QName;
/**
* Parameter definition interface.
*
* @author Roy Wetherall
*/
@AlfrescoPublicApi
public interface ParameterDefinition
{
/**
* Get the name of the parameter.
* <p>
* This is unique and is used to identify the parameter.
*
* @return the parameter name
*/
public String getName();
/**
* Get the type of parameter
*
* @return the parameter type qname
*/
public QName getType();
/**
* Is multi-valued?
*/
public boolean isMultiValued();
/**
* Indicates whether the parameter is mandatory or not.
* <p>
* If a parameter is mandatory it means that the value can not be null.
*
* @return true if the parameter is mandatory, false otherwise
*/
public boolean isMandatory();
/**
* Get the display label of the parameter.
*
* @return the parameter display label
*/
public String getDisplayLabel();
/**
* Gets the parameter constraint name, null if none set.
*
* @return the parameter constraint name
*/
public String getParameterConstraintName();
}