de.hybris.platform.print.util.table

Class ParameterDescriptor

java.lang.Object

de.hybris.platform.print.util.table.ParameterDescriptor

public class ParameterDescriptor
extends Object

Description of a single parameter for data provider/resolver.

See Also:

AxisDataProvider, CellDataResolver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterDescriptor.Scope Parameter scope.

Constructor Summary

Constructors

Constructor and Description
ParameterDescriptor(String qualifier, String nameLocKey, String typeCode) Creates new parameter descriptor.
ParameterDescriptor(String qualifier, String nameLocKey, String typeCode, ParameterDescriptor.Scope scope) Creates new parameter descriptor.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns localized name of this parameter.
String	getQualifier() Returns the qualifier of this parameter.
ParameterDescriptor.Scope	getScope() Returns the scope of this parameter.
String	getTypeCode() Returns the value type code

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterDescriptor

public ParameterDescriptor(String qualifier,
                           String nameLocKey,
                           String typeCode)

Creates new parameter descriptor.

Parameters:

qualifier - qualifier of the parameter. Must be unique within the data provider/resolver.

nameLocKey - the localization key for the name of the parameter

typeCode - the type code of the parameter value

ParameterDescriptor

public ParameterDescriptor(String qualifier,
                           String nameLocKey,
                           String typeCode,
                           ParameterDescriptor.Scope scope)

Creates new parameter descriptor.

Parameters:

qualifier - qualifier of the parameter. Must be unique within the data provider/resolver.

nameLocKey - the localization key for the name of the parameter

typeCode - the type code of the parameter value

scope - the scope of this parameter

See Also:

ParameterDescriptor.Scope

Method Detail

getQualifier

public String getQualifier()

Returns the qualifier of this parameter.

Returns:

qualifier of this parameter

getName

public String getName()

Returns localized name of this parameter. The nameLocKey is used as localization key.

Returns:

localized name of this parameter

getTypeCode

public String getTypeCode()

Returns the value type code

Returns:

value type code

getScope

public ParameterDescriptor.Scope getScope()

Returns the scope of this parameter.

Returns:

scope of this parameter

See Also:

ParameterDescriptor.Scope