org.gcube.informationsystem.queries.templates.reference.properties

Interface TemplateVariable

All Superinterfaces:

Element, PropertyElement, Serializable

All Known Implementing Classes:

TemplateVariableImpl

@TypeMetadata(name="TemplateVariable",
              description="This is the class used to define the a TemplateVariable",
              version="1.0.0")
 @Change(version="1.0.0",
        description="First Version")
public interface TemplateVariable
extends PropertyElement

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
static String	VARIABLE_DEFAULT_VALUE_PROPERTY
static String	VARIABLE_DESCRIPTION_PROPERTY
static String	VARIABLE_NAME_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

CLASS_PROPERTY, DATETIME_PATTERN, SUPERCLASSES_PROPERTY

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue()
String	getDescription()
String	getName()
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setName(String name)

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

VARIABLE_NAME_PROPERTY

static final String VARIABLE_NAME_PROPERTY

See Also:

Constant Field Values

VARIABLE_DESCRIPTION_PROPERTY

static final String VARIABLE_DESCRIPTION_PROPERTY

See Also:

Constant Field Values

VARIABLE_DEFAULT_VALUE_PROPERTY

static final String VARIABLE_DEFAULT_VALUE_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

@ISProperty(name="name",
            description="The name of the Query Template Variable.",
            readonly=true,
            mandatory=true,
            nullable=false)
String getName()

setName

void setName(String name)

getDescription

@ISProperty(name="description",
            description="The description of the Query Template Variable.",
            readonly=false,
            mandatory=true,
            nullable=false)
String getDescription()

setDescription

void setDescription(String description)

getDefaultValue

@ISProperty(name="defaultValue",
            description="The default value of the Query Template Variable. The default value is used as is to the query. If the value needs quotation or escaping please include them to the default value",
            readonly=false,
            mandatory=true,
            nullable=false)
String getDefaultValue()

setDefaultValue

void setDefaultValue(String defaultValue)