Package com.aquima.interactions.test.templates.communication

Class DomainPropertyTemplate

java.lang.Object

com.aquima.interactions.test.templates.AbstractReportingTemplate

com.aquima.interactions.test.templates.communication.DomainPropertyTemplate

public class DomainPropertyTemplate
extends AbstractReportingTemplate

Template for building a data property.

Since:

9.3

Author:

A.Pragt

Constructor Summary

Constructors

Constructor	Description
DomainPropertyTemplate(com.aquima.interactions.foundation.report.IInitializationReport report, String name, com.aquima.interactions.foundation.DataType dataType, String attribute, String schemaName, ElementReferenceTemplate customSchemaElementRef)

Method Summary

Modifier and Type	Method	Description
FieldValidationTemplate	addValidation(String type)	This method may be used to add a validation to the field.
protected String	getAttribute()
com.aquima.interactions.communication.ds.IElementReferenceDS	getCustomSchemaElementRef()
DomainObjectTemplate	getDataObject()	Returns the data object template.
protected com.aquima.interactions.foundation.DataType	getDataType()
protected String	getDocumentation()
protected String	getItemName()
protected String	getName()
protected String	getSchemaName()
protected Iterator<FieldValidationTemplate>	getValidations()
protected boolean	isMultivalued()
protected boolean	isRequired()
void	setDocumentation(String documentation)	Sets the property's documentation
void	setItemName(String itemName)	Sets the optional item name.
void	setMultivalued(boolean multivalued)	Sets the multiValued indicator.
void	setRequired(boolean required)	Sets the required indicator.
protected com.aquima.interactions.communication.ds.IDomainPropertyDS	toDataSource()

Methods inherited from class com.aquima.interactions.test.templates.AbstractReportingTemplate

getInitializationReport

Methods inherited from class java.lang.Object

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

Constructor Details

DomainPropertyTemplate

public DomainPropertyTemplate(com.aquima.interactions.foundation.report.IInitializationReport report,
 String name,
 com.aquima.interactions.foundation.DataType dataType,
 String attribute,
 String schemaName,
 ElementReferenceTemplate customSchemaElementRef)

Method Details

getName

protected String getName()

getDocumentation

protected String getDocumentation()

setDocumentation

public void setDocumentation(String documentation)

Sets the property's documentation

Parameters:

documentation - The new documentation of the property

getDataType

protected com.aquima.interactions.foundation.DataType getDataType()

isMultivalued

protected boolean isMultivalued()

setMultivalued

public void setMultivalued(boolean multivalued)

Sets the multiValued indicator.

Parameters:

multivalued - The new multiValued indicator.

isRequired

protected boolean isRequired()

setRequired

public void setRequired(boolean required)

Sets the required indicator.

Parameters:

required - The new required indicator.

setItemName

public void setItemName(String itemName)

Sets the optional item name.

Parameters:

itemName -

getItemName

protected String getItemName()

getAttribute

protected String getAttribute()

toDataSource

protected com.aquima.interactions.communication.ds.IDomainPropertyDS toDataSource()

getSchemaName

protected String getSchemaName()

getDataObject

public DomainObjectTemplate getDataObject()

Returns the data object template.

Returns:

The template, or null if not entity DataType.

addValidation

public FieldValidationTemplate addValidation(String type)

This method may be used to add a validation to the field.

Parameters:

type - The type of the validation that should be added.

Returns:

Template representing the newly added validation.

getValidations

protected Iterator<FieldValidationTemplate> getValidations()

getCustomSchemaElementRef

public com.aquima.interactions.communication.ds.IElementReferenceDS getCustomSchemaElementRef()