Package com.aquima.interactions.project.impl

Class ExpanderDefinition

java.lang.Object

com.aquima.interactions.project.impl.ExpanderDefinition

All Implemented Interfaces:

IExpanderDefinition, Serializable

public class ExpanderDefinition
extends Object
implements IExpanderDefinition

This class contains the definition of a single (container) expander.

Since:

7.1

Author:

O. Kerpershoek

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExpanderDefinition(IExpanderDS datasource)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	This method returns a description of the container expander.
String	getName()	This method returns the unique name of the expander.
IParameterDefinition	getParameter(String name)	This method returns the parameter definition for the specified name.
String[]	getParameterNames()	This method returns an array containing all the parameter names.
IParameterDefinition[]	getParameters()	this method returns an array containing the definitions of the parameters that are supported by this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpanderDefinition

protected ExpanderDefinition(IExpanderDS datasource)

Method Detail

getName

public String getName()

Description copied from interface: IExpanderDefinition

This method returns the unique name of the expander. In the composer, this name will be referred to as the container type name.

Specified by:

getName in interface IExpanderDefinition

Returns:

The unique name of the expander.

getDescription

public String getDescription()

Description copied from interface: IExpanderDefinition

This method returns a description of the container expander.

Specified by:

getDescription in interface IExpanderDefinition

Returns:

A description of the container expander (may be null).

getParameter

public IParameterDefinition getParameter(String name)

Description copied from interface: IExpanderDefinition

This method returns the parameter definition for the specified name.

Specified by:

getParameter in interface IExpanderDefinition

Parameters:

name - The name of the requested parameter.

Returns:

The definition of the parameter for the specified name.

getParameterNames

public String[] getParameterNames()

Description copied from interface: IExpanderDefinition

This method returns an array containing all the parameter names.

Specified by:

getParameterNames in interface IExpanderDefinition

Returns:

Array containing all the parameter names.

getParameters

public IParameterDefinition[] getParameters()

Description copied from interface: IExpanderDefinition

this method returns an array containing the definitions of the parameters that are supported by this component.

Specified by:

getParameters in interface IExpanderDefinition

Returns:

Array containing the definitions of the parameters that are supported by this component.