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

All Superinterfaces:

java.io.Serializable

public interface OutputParameter
extends java.io.Serializable

An OutputParameter object contains metadata describing the output parameters expected for an operation that belongs to a service.

Method Summary

java.util.Map	getAttributes() Retrieves the attributes or metadata specific to this service's component.
java.lang.String[]	getFilterCategories() Returns an array containing filter categories associated with this parameter.
java.lang.String	getHint() Retrieves text that describes the purpose of this output parameter.
java.lang.String	getName() Retrieves the name of an output parameter, which must be unique within the Operation.
java.lang.String	getTitle() Retrieves the title of this output parameter.
java.lang.String	getType() Retrieves the data type for this parameter.
boolean	isHidden() Determines whether this output parameter is visible.
boolean	isInOutParameter() Determines whether this parameter is an input or output parameter.

Method Detail

getName

java.lang.String getName()

Retrieves the name of an output parameter, which must be unique within the Operation. If this operation does not have an output parameter, an empty string is returned.

Returns:

A string value that represents the output parameter name.

getType

java.lang.String getType()

Retrieves the data type for this parameter.

Returns:

A string value that represents the data type for this parameter.

getAttributes

java.util.Map getAttributes()

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

Returns:

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

getTitle

java.lang.String getTitle()

Retrieves the title of this output parameter.

Returns:

A string value that specifies the title of this output parameter.

getHint

java.lang.String getHint()

Retrieves text that describes the purpose of this output parameter.

Returns:

A string value that describes the purpose of this output parameter.

isHidden

boolean isHidden()

Determines whether this output parameter is visible.

Returns:

The value true if this output parameter is hidden; otherwise, false is returned.

isInOutParameter

boolean isInOutParameter()

Determines whether this parameter is an input or output parameter.

Returns:

The value true if this output parameter is an input or output parameter.

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.