org.alfresco.repo.action
Class ParameterDefinitionImpl

java.lang.Object
  extended by org.alfresco.repo.action.ParameterDefinitionImpl
All Implemented Interfaces:
java.io.Serializable, ParameterDefinition

public class ParameterDefinitionImpl
extends java.lang.Object
implements ParameterDefinition, java.io.Serializable

Parameter definition implementation class.

See Also:
Serialized Form

Constructor Summary
ParameterDefinitionImpl(java.lang.String name, org.alfresco.service.namespace.QName type, boolean isMandatory, java.lang.String displayLabel)
          Constructor
ParameterDefinitionImpl(java.lang.String name, org.alfresco.service.namespace.QName type, boolean isMandatory, java.lang.String displayLabel, boolean isMultiValued)
          Constructor
ParameterDefinitionImpl(java.lang.String name, org.alfresco.service.namespace.QName type, boolean isMandatory, java.lang.String displayLabel, boolean isMultiValued, java.lang.String parameterConstraintName)
          Constructor
 
Method Summary
 java.lang.String getDisplayLabel()
          Get the display label of the parameter.
 java.lang.String getName()
          Get the name of the parameter.
 java.lang.String getParameterConstraintName()
          Gets the parameter constraint name, null if none set.
 org.alfresco.service.namespace.QName getType()
          Get the type of parameter
 boolean isMandatory()
          Indicates whether the parameter is mandatory or not.
 boolean isMultiValued()
          Is multi-valued?
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParameterDefinitionImpl

public ParameterDefinitionImpl(java.lang.String name,
                               org.alfresco.service.namespace.QName type,
                               boolean isMandatory,
                               java.lang.String displayLabel)
Constructor

Parameters:
name - the name of the parameter
type - the type of the parameter
displayLabel - the display label

ParameterDefinitionImpl

public ParameterDefinitionImpl(java.lang.String name,
                               org.alfresco.service.namespace.QName type,
                               boolean isMandatory,
                               java.lang.String displayLabel,
                               boolean isMultiValued)
Constructor

Parameters:
name - the name of the parameter
type - the type of the parameter
displayLabel - the display label

ParameterDefinitionImpl

public ParameterDefinitionImpl(java.lang.String name,
                               org.alfresco.service.namespace.QName type,
                               boolean isMandatory,
                               java.lang.String displayLabel,
                               boolean isMultiValued,
                               java.lang.String parameterConstraintName)
Constructor

Parameters:
name -
type -
isMandatory -
displayLabel -
isMultiValued -
parameterConstraintName -
Method Detail

getName

public java.lang.String getName()
Description copied from interface: ParameterDefinition
Get the name of the parameter.

This is unique and is used to identify the parameter.

Specified by:
getName in interface ParameterDefinition
Returns:
the parameter name
See Also:
ParameterDefinition.getName()

getType

public org.alfresco.service.namespace.QName getType()
Description copied from interface: ParameterDefinition
Get the type of parameter

Specified by:
getType in interface ParameterDefinition
Returns:
the parameter type qname
See Also:
ParameterDefinition.getType()

isMandatory

public boolean isMandatory()
Description copied from interface: ParameterDefinition
Indicates whether the parameter is mandatory or not.

If a parameter is mandatory it means that the value can not be null.

Specified by:
isMandatory in interface ParameterDefinition
Returns:
true if the parameter is mandatory, false otherwise
See Also:
ParameterDefinition.isMandatory()

isMultiValued

public boolean isMultiValued()
Description copied from interface: ParameterDefinition
Is multi-valued?

Specified by:
isMultiValued in interface ParameterDefinition
See Also:
ParameterDefinition.isMultiValued()

getDisplayLabel

public java.lang.String getDisplayLabel()
Description copied from interface: ParameterDefinition
Get the display label of the parameter.

Specified by:
getDisplayLabel in interface ParameterDefinition
Returns:
the parameter display label
See Also:
ParameterDefinition.getDisplayLabel()

getParameterConstraintName

public java.lang.String getParameterConstraintName()
Description copied from interface: ParameterDefinition
Gets the parameter constraint name, null if none set.

Specified by:
getParameterConstraintName in interface ParameterDefinition
Returns:
the parameter constraint name
See Also:
ParameterDefinition.getParameterConstraintName()


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.