com.adobe.idp.dsc.registry.infomodel
Interface InputParameter

All Superinterfaces:

java.io.Serializable

public interface InputParameter
extends java.io.Serializable

An InputParameter object contains the data expected as input for a service.

Method Summary

java.util.Map	getAttributes() Retrieves the attributes or metadata specific to this service's component.
java.lang.String	getDefaultValue() Retrieves a string form of the value to be passed at runtime to the service, for cases in which the input parameter is null.
java.lang.String[]	getFilterCategories() Returns an array containing filter categories associated with this parameter.
java.lang.String	getHint() Retrieves short text that describes the purpose of the parameter and is displayed within related user interfaces.
java.lang.String	getName() Retrieves the name of the parameter, which must be unique with respect to all input parameters.
PropertyEditor	getPropertyEditor() Retrieves a PropertyEditor object that optionally references a PropertyEditorComponent to use for editing or viewing this parameter.
java.lang.String[]	getSupportedExpressionTypes() Retrieves an array of supported expression types.
java.lang.String	getTitle() Retrieves the title of the parameter.
java.lang.String	getType() Retrieves the Java class for this parameter.
boolean	isHidden() Determines whether this input parameter should be visible.
boolean	isInOutParameter() Determines whether this input parameter is an in/out parameter.
boolean	isRequired() Determines whether this parameter is required in the invocation request.
void	setDefaultValue(java.lang.String aValue) Deprecated.
void	setRequired(boolean aValue) Deprecated.

Method Detail

getName

java.lang.String getName()

Retrieves the name of the parameter, which must be unique with respect to all input parameters.

Returns:

The name of the parameter.

getType

java.lang.String getType()

Retrieves the Java class for this parameter.

Returns:

The Java class for this parameter.

getDefaultValue

java.lang.String getDefaultValue()

Retrieves a string form of the value to be passed at runtime to the service, for cases in which the input parameter is null.

Returns:

A string value of the value to be passed at runtime to the service.

isRequired

boolean isRequired()

Determines whether this parameter is required in the invocation request.

Returns:

true if this parameter is required in the invocation request, false otherwise.

getAttributes

java.util.Map getAttributes()

Retrieves the attributes or metadata specific to this service's component.

Returns:

A java.util.Map containing the attributes or metadata specific to this service's component.

getPropertyEditor

PropertyEditor getPropertyEditor()

Retrieves a PropertyEditor object that optionally references a PropertyEditorComponent to use for editing or viewing this parameter.

Returns:

A property editor.

getHint

java.lang.String getHint()

Retrieves short text that describes the purpose of the parameter and is displayed within related user interfaces.

Returns:

Short text that describes the purpose of the parameter.

getSupportedExpressionTypes

java.lang.String[] getSupportedExpressionTypes()

Retrieves an array of supported expression types. The array is used to filter those expression types that appear in the IDE when binding to a parameter. If the returned value is null, it is assumed that all expression types are supported.

Returns:

An array of supported expression types.

isHidden

boolean isHidden()

Determines whether this input parameter should be visible.

Returns:

true if this input parameter should be hidden, false otherwise.

isInOutParameter

boolean isInOutParameter()

Determines whether this input parameter is an in/out parameter.

Returns:

true if this input parameter is an in/out parameter, false otherwise.

getTitle

java.lang.String getTitle()

Retrieves the title of the parameter. This value is used when displaying the parameter.

Returns:

The title of the parameter.

setRequired

void setRequired(boolean aValue)

Deprecated.

Sets whether this input parameter is required.

Parameters:

aValue - true if this input parameter is required, false otherwise.

setDefaultValue

void setDefaultValue(java.lang.String aValue)

Deprecated.

Sets the string value to be passed at runtime to the service, for cases in which the input parameter is null.

Parameters:

aValue - The string value to be passed at runtime to the service.

getFilterCategories

java.lang.String[] getFilterCategories()

Returns an array containing filter categories associated with this parameter. It is used to show the parameter when the appropriate filter toggle is used in the IDE. If the returned value is NULL, it is assumed that all filter categories are supported.

Returns:

An array of associated filter categories.