Package com.aquima.interactions.communication.impl

Class RestUrnArgumentDefinition

java.lang.Object

com.aquima.interactions.communication.impl.RestUrnArgumentDefinition

All Implemented Interfaces:

IRestUrnArgumentDefinition

public final class RestUrnArgumentDefinition
extends Object
implements IRestUrnArgumentDefinition

This class holds the static definition of a rest url argument.

Since:

9.0

Author:

Arjan Pragt

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestUrnArgumentDefinition(IRestUrnArgumentDS datasource, IEntityDefinition entityDefinition, IRuleEngine ruleEngine)

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()	This method returns the attribute definition of the dynamic value.
String	getConstant()	This method returns the default value of the urn fragment.
String	getName()	This method returns the name of the urn argument.
IFieldValidationDefinition[]	getValidations()	This method returns the validations of the attribute.
boolean	isRequired()	This method returns whether the urn fragment is required or not.

Methods inherited from class java.lang.Object

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

Constructor Details

RestUrnArgumentDefinition

protected RestUrnArgumentDefinition(IRestUrnArgumentDS datasource,
 IEntityDefinition entityDefinition,
 IRuleEngine ruleEngine)

Method Details

getName

public String getName()

Description copied from interface: IRestUrnArgumentDefinition

This method returns the name of the urn argument.

Specified by:

getName in interface IRestUrnArgumentDefinition

Returns:

The name of the argument, may not be null.

getConstant

public String getConstant()

Description copied from interface: IRestUrnArgumentDefinition

This method returns the default value of the urn fragment. A fragment is either a constant or dynamic. If dynamic this method must return null.

Specified by:

getConstant in interface IRestUrnArgumentDefinition

Returns:

The constant value or null.

getAttributeName

public String getAttributeName()

Description copied from interface: IRestUrnArgumentDefinition

This method returns the attribute definition of the dynamic value. A fragment is either a constant or dynamic. If constant this method must return null.

Specified by:

getAttributeName in interface IRestUrnArgumentDefinition

Returns:

The attribute definition or null.

getValidations

public IFieldValidationDefinition[] getValidations()

Description copied from interface: IRestUrnArgumentDefinition

This method returns the validations of the attribute.

Specified by:

getValidations in interface IRestUrnArgumentDefinition

Returns:

The validation definitions of the attribute, may not be null.

isRequired

public boolean isRequired()

Description copied from interface: IRestUrnArgumentDefinition

This method returns whether the urn fragment is required or not. The default value is true.

Specified by:

isRequired in interface IRestUrnArgumentDefinition

Returns:

If the argument is required, defaults to true.