org.alfresco.service.cmr.action

Interface ParameterConstraint

All Known Implementing Classes:

AspectParameterConstraint, BaseParameterConstraint, EnumParameterConstraint, FolderContentsParameterConstraint, MimetypeParameterConstraint, PropertyParameterConstraint, PublishingChannelParameterConstraint, StatusUpdateChannelParameterConstraint, TypeParameterConstraint

@AlfrescoPublicApi
public interface ParameterConstraint

Parameter constraint. Helps to constraint the list of allowable values for a action parameter.

Author:

Roy Wetherall

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAllowableValues() The implementers are expected to return allowed values in the insertion order.
String	getName() Gets the unique name of the constraint
String	getValueDisplayLabel(String value)
boolean	isValidValue(String value) Indicates whether the provided value satisfies the constraint.

Method Detail

getName

String getName()

Gets the unique name of the constraint

Returns:

String constraint name

isValidValue

boolean isValidValue(String value)

Indicates whether the provided value satisfies the constraint. True if it does, false otherwise.

Returns:

boolean true if valid, false otherwise

getValueDisplayLabel

String getValueDisplayLabel(String value)

Parameters:

value - String

Returns:

String

getAllowableValues

Map<String,String> getAllowableValues()

The implementers are expected to return allowed values in the insertion order.