alfresco-community-repo/source/java/org/alfresco/repo/action/ParameterDefinitionImpl.java
Roy Wetherall 8c2c15c5c9 Support for action parameter constraints added to action service
An action parameter constraint provides a way to list the valid values that an action or action constraint parameter can take.  This
means more information about the action or action condition is available to the user of the action.
  
Currently there is only an implementation for enum parameter values, but this will be extended as the existing action implementations
are reviewed and value constraints are added as required.

The REST API can now be extended to provide this additional information.



git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18489 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-02-08 04:37:45 +00:00

184 lines
5.0 KiB
Java

/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.repo.action;
import java.io.Serializable;
import org.alfresco.service.cmr.action.ParameterConstraint;
import org.alfresco.service.cmr.action.ParameterDefinition;
import org.alfresco.service.namespace.QName;
/**
* Parameter definition implementation class.
*
* @author Roy Wetherall
*/
public class ParameterDefinitionImpl implements ParameterDefinition, Serializable
{
/**
* Serial version UID
*/
private static final long serialVersionUID = 3976741384558751799L;
/**
* The name of the parameter
*/
private String name;
/**
* The type of the parameter
*/
private QName type;
/**
* Is this a multi-valued parameter?
*/
private boolean isMultiValued;
/**
* The display label
*/
private String displayLabel;
/** Parameter constraint name */
private String parameterConstraintName;
/**
* Indicates whether it is mandatory for the parameter to be set
*/
private boolean isMandatory = false;
/**
* Constructor
*
* @param name the name of the parameter
* @param type the type of the parameter
* @param displayLabel the display label
*/
public ParameterDefinitionImpl(
String name,
QName type,
boolean isMandatory,
String displayLabel)
{
this.name = name;
this.type = type;
this.displayLabel = displayLabel;
this.isMandatory = isMandatory;
this.isMultiValued = false;
}
/**
* Constructor
*
* @param name the name of the parameter
* @param type the type of the parameter
* @param displayLabel the display label
*/
public ParameterDefinitionImpl(
String name,
QName type,
boolean isMandatory,
String displayLabel,
boolean isMultiValued)
{
this.name = name;
this.type = type;
this.displayLabel = displayLabel;
this.isMandatory = isMandatory;
this.isMultiValued = isMultiValued;
}
/**
* Constructor
*
* @param name
* @param type
* @param isMandatory
* @param displayLabel
* @param isMultiValued
* @param parameterConstraintName
*/
public ParameterDefinitionImpl(
String name,
QName type,
boolean isMandatory,
String displayLabel,
boolean isMultiValued,
String parameterConstraintName)
{
this(name, type, isMandatory, displayLabel, isMultiValued);
this.parameterConstraintName = parameterConstraintName;
}
/**
* @see org.alfresco.service.cmr.action.ParameterDefinition#getName()
*/
public String getName()
{
return this.name;
}
/**
* @see org.alfresco.service.cmr.action.ParameterDefinition#getType()
*/
public QName getType()
{
return this.type;
}
/**
* @see org.alfresco.service.cmr.action.ParameterDefinition#isMandatory()
*/
public boolean isMandatory()
{
return this.isMandatory;
}
/**
* @see org.alfresco.service.cmr.action.ParameterDefinition#isMultiValued()
*/
public boolean isMultiValued()
{
return this.isMultiValued;
}
/**
* @see org.alfresco.service.cmr.action.ParameterDefinition#getDisplayLabel()
*/
public String getDisplayLabel()
{
return this.displayLabel;
}
/**
* @see org.alfresco.service.cmr.action.ParameterDefinition#getParameterConstraintName()
*/
public String getParameterConstraintName()
{
return this.parameterConstraintName;
}
}