org.alfresco.repo.action

Class ParameterDefinitionImpl

java.lang.Object

org.alfresco.repo.action.ParameterDefinitionImpl

All Implemented Interfaces:

Serializable, ParameterDefinition

public class ParameterDefinitionImpl
extends Object
implements ParameterDefinition, Serializable

Parameter definition implementation class.

Author:

Roy Wetherall

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterDefinitionImpl(String name, org.alfresco.service.namespace.QName type, boolean isMandatory, String displayLabel) Constructor
ParameterDefinitionImpl(String name, org.alfresco.service.namespace.QName type, boolean isMandatory, String displayLabel, boolean isMultiValued) Constructor
ParameterDefinitionImpl(String name, org.alfresco.service.namespace.QName type, boolean isMandatory, String displayLabel, boolean isMultiValued, String parameterConstraintName) Constructor

Method Summary

Modifier and Type	Method and Description
String	getDisplayLabel() Get the display label of the parameter.
String	getName() Get the name of the parameter.
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(String name,
                               org.alfresco.service.namespace.QName type,
                               boolean isMandatory,
                               String displayLabel)

Constructor

Parameters:

name - the name of the parameter

type - the type of the parameter

displayLabel - the display label

ParameterDefinitionImpl

public ParameterDefinitionImpl(String name,
                               org.alfresco.service.namespace.QName type,
                               boolean isMandatory,
                               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(String name,
                               org.alfresco.service.namespace.QName type,
                               boolean isMandatory,
                               String displayLabel,
                               boolean isMultiValued,
                               String parameterConstraintName)

Constructor

Parameters:

name - String

type - QName

isMandatory - boolean

displayLabel - String

isMultiValued - boolean

parameterConstraintName - String

Method Detail

getName

public 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 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 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()