Package com.aquima.interactions.framework.container.link

Class LinkParameters

java.lang.Object

com.aquima.interactions.framework.container.link.LinkParameters

All Implemented Interfaces:

ILinkParameters, Serializable

Direct Known Subclasses:

DocumentLinkParameters

public class LinkParameters
extends Object
implements ILinkParameters

This class is responsible for parsing the parameters of the link container.

Since:

6.0

Author:

J. van Leuven

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASSETFORMAT
static final String	ASSETNAME
static final String	TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
	LinkParameters(IParameters parameters)	Constructs the parameters object with the parameters of the dynamic container.
protected	LinkParameters(String type, IParameters parameters)

Method Summary

Modifier and Type	Method	Description
String	getAssetFormat()	This method returns the format of the asset that should be used for the display text.
String	getAssetName()	This method returns the name of the asset that should be used for the display text.
IParameters	getCustomParameters()	This method returns an object containing additional parameters that should be included in the link.
String	getTypeName()	This method returns the type of the link (for instance "document").

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

ASSETNAME

public static final String ASSETNAME

See Also:

• Constant Field Values

ASSETFORMAT

public static final String ASSETFORMAT

See Also:

• Constant Field Values

Constructor Details

LinkParameters

public LinkParameters(IParameters parameters)

Constructs the parameters object with the parameters of the dynamic container.

Parameters:

parameters - The parameter of the dynamic container.

LinkParameters

protected LinkParameters(String type,
 IParameters parameters)

Method Details

getTypeName

public String getTypeName()

Description copied from interface: ILinkParameters

This method returns the type of the link (for instance "document").

Specified by:

getTypeName in interface ILinkParameters

Returns:

the type of the link (for instance "document").

getAssetName

public String getAssetName()

Description copied from interface: ILinkParameters

This method returns the name of the asset that should be used for the display text.

Specified by:

getAssetName in interface ILinkParameters

Returns:

the name of the asset that should be used for the display text.

getAssetFormat

public String getAssetFormat()

Description copied from interface: ILinkParameters

This method returns the format of the asset that should be used for the display text.

Specified by:

getAssetFormat in interface ILinkParameters

Returns:

the format of the asset that should be used for the display text.

getCustomParameters

public IParameters getCustomParameters()

Description copied from interface: ILinkParameters

This method returns an object containing additional parameters that should be included in the link.

Specified by:

getCustomParameters in interface ILinkParameters

Returns:

an object containing additional parameters that should be included in the link.