Package com.aquima.interactions.portal.model.session

Class MaskCall

java.lang.Object

com.aquima.interactions.portal.model.session.MaskCall

All Implemented Interfaces:

IMaskCall

public class MaskCall
extends Object
implements IMaskCall

The internal mask call implementation. A mask call is a configured mask.

Since:

7.1

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
MaskCall(IProject project, IMaskFactory maskFactory, IMaskCallDefinition maskCallDef)	Constructs the mask call with the required arguments.

Method Summary

Modifier and Type	Method	Description
IMultilingualText	apply(IPrimitiveValue primitiveValue)	Apply the mask call to the provided value.
String	getCallName()	This method returns the mask call name.
IParameters	getParameters()	This method returns the mask parameters.
String	getTypeName()	This method returns the mask type name.

Methods inherited from class java.lang.Object

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

Constructor Details

MaskCall

public MaskCall(IProject project,
 IMaskFactory maskFactory,
 IMaskCallDefinition maskCallDef)

Constructs the mask call with the required arguments.

Parameters:

project - The current project.

maskFactory - Factory able to provide mask implementations.

maskCallDef - The definition the mask call should be created for.

Method Details

apply

public IMultilingualText apply(IPrimitiveValue primitiveValue)
                        throws Exception

Description copied from interface: IMaskCall

Apply the mask call to the provided value.

Specified by:

apply in interface IMaskCall

Parameters:

primitiveValue - The value, may not be null, may be unknown.

Returns:

The multilingual text containing the applied mask.

Throws:

Exception - Is thrown when the mask could not be applied to the provided value.

getCallName

public String getCallName()

Description copied from interface: IMaskCall

This method returns the mask call name.

Specified by:

getCallName in interface IMaskCall

Returns:

The service call name, never null.

getParameters

public IParameters getParameters()

Description copied from interface: IMaskCall

This method returns the mask parameters.

Specified by:

getParameters in interface IMaskCall

Returns:

The service parameters, never null.

getTypeName

public String getTypeName()

Description copied from interface: IMaskCall

This method returns the mask type name.

Specified by:

getTypeName in interface IMaskCall

Returns:

The service type name, never null.