Package com.aquima.interactions.communication.impl

Class RestHeaderDefinition

java.lang.Object

com.aquima.interactions.communication.impl.RestHeaderDefinition

All Implemented Interfaces:

IRestHeaderDefinition

public final class RestHeaderDefinition
extends Object
implements IRestHeaderDefinition

This class holds the static definition of a rest header.

Since:

9.0

Author:

Arjan Pragt

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestHeaderDefinition(IRestHeaderDS datasource, IEntityDefinition entityDefinition, IRuleEngine ruleEngine)

Method Summary

Modifier and Type	Method	Description
String	getApiDocumentation()	This method returns the api documentation of the header.
String	getAttributeName()	This method returns the attribute representing the content of the header.
String	getName()	This method returns the name of the header.
IFieldValidationDefinition[]	getValidations()	This method returns the validations of the attribute.
boolean	isAttributeMultivalued()	This method returns whether the attribute representing the content of the header is multivalued.

Methods inherited from class java.lang.Object

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

Constructor Details

RestHeaderDefinition

protected RestHeaderDefinition(IRestHeaderDS datasource,
 IEntityDefinition entityDefinition,
 IRuleEngine ruleEngine)

Method Details

getName

public String getName()

Description copied from interface: IRestHeaderDefinition

This method returns the name of the header.

Specified by:

getName in interface IRestHeaderDefinition

Returns:

The name of the header, may not be null.

getAttributeName

public String getAttributeName()

Description copied from interface: IRestHeaderDefinition

This method returns the attribute representing the content of the header.

Specified by:

getAttributeName in interface IRestHeaderDefinition

Returns:

The content attribute, may not be null.

getApiDocumentation

public String getApiDocumentation()

Description copied from interface: IRestHeaderDefinition

This method returns the api documentation of the header.

Specified by:

getApiDocumentation in interface IRestHeaderDefinition

Returns:

The api documentation of the header, may be null.

isAttributeMultivalued

public boolean isAttributeMultivalued()

Description copied from interface: IRestHeaderDefinition

This method returns whether the attribute representing the content of the header is multivalued.

Specified by:

isAttributeMultivalued in interface IRestHeaderDefinition

Returns:

Boolean indicating whether the attribute is multivalued

getValidations

public IFieldValidationDefinition[] getValidations()

Description copied from interface: IRestHeaderDefinition

This method returns the validations of the attribute.

Specified by:

getValidations in interface IRestHeaderDefinition

Returns:

The validations of the attribute, may not be null.