Package com.aquima.interactions.communication.impl

Class CustomSchemaPropertyDefinition

java.lang.Object

com.aquima.interactions.communication.impl.CustomSchemaPropertyDefinition

All Implemented Interfaces:

IDomainPropertyDefinition

public class CustomSchemaPropertyDefinition
extends Object
implements IDomainPropertyDefinition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomSchemaPropertyDefinition(IDomainPropertyDS datasource)

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()	Returns the name of the attribute.
String	getAttributeRelationEntityName()	This method returns the name of entity where the domain property has a relation to.
IElementReference	getCustomSchemaElement()	Returns the custom schema element.
DataType	getDataType()	Returns the data type of the property.
String	getDocumentation()	Returns the documentation of the property.
String	getItemName()	Returns the optional name of the items within this property.
String	getName()	Returns the name of the property.
IDomainObjectDefinition	getObjectDefinition()	Returns the object definition.
String	getSchemaName()	Returns the schemaName
IFieldValidationDefinition[]	getValidations()	This method returns the validations of the attribute.
boolean	isMultivalued()	Returns an indicator whether the property is multivalued.
boolean	isRequired()	Returns an indicator whether the property is mandatory.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomSchemaPropertyDefinition

protected CustomSchemaPropertyDefinition(IDomainPropertyDS datasource)

Method Details

getName

public String getName()

Description copied from interface: IDomainPropertyDefinition

Returns the name of the property.

Specified by:

getName in interface IDomainPropertyDefinition

Returns:

The name, never null.

getDocumentation

public String getDocumentation()

Description copied from interface: IDomainPropertyDefinition

Returns the documentation of the property.

Specified by:

getDocumentation in interface IDomainPropertyDefinition

Returns:

The documentation, may be null

isRequired

public boolean isRequired()

Description copied from interface: IDomainPropertyDefinition

Returns an indicator whether the property is mandatory.

Specified by:

isRequired in interface IDomainPropertyDefinition

Returns:

Required indicator.

isMultivalued

public boolean isMultivalued()

Description copied from interface: IDomainPropertyDefinition

Returns an indicator whether the property is multivalued.

Specified by:

isMultivalued in interface IDomainPropertyDefinition

Returns:

Multivalued indicator.

getAttributeName

public String getAttributeName()

Description copied from interface: IDomainPropertyDefinition

Returns the name of the attribute. The attribute must be a relation for an object definition. Also, it must match the datatype and the cardinality must match.

Specified by:

getAttributeName in interface IDomainPropertyDefinition

Returns:

The name of the attribute, may be null.

getItemName

public String getItemName()

Description copied from interface: IDomainPropertyDefinition

Returns the optional name of the items within this property.

Specified by:

getItemName in interface IDomainPropertyDefinition

Returns:

The optional item name, may be null.

getDataType

public DataType getDataType()

Description copied from interface: IDomainPropertyDefinition

Returns the data type of the property. When an Entity is the data object must be filled.

Specified by:

getDataType in interface IDomainPropertyDefinition

Returns:

The data type, may be null.

getObjectDefinition

public IDomainObjectDefinition getObjectDefinition()

Description copied from interface: IDomainPropertyDefinition

Returns the object definition.

Specified by:

getObjectDefinition in interface IDomainPropertyDefinition

Returns:

The object definition, mandatory in case of entity data type.

getSchemaName

public String getSchemaName()

Description copied from interface: IDomainPropertyDefinition

Returns the schemaName

Specified by:

getSchemaName in interface IDomainPropertyDefinition

Returns:

The domain schema name.

getValidations

public IFieldValidationDefinition[] getValidations()

Description copied from interface: IDomainPropertyDefinition

This method returns the validations of the attribute.

Specified by:

getValidations in interface IDomainPropertyDefinition

Returns:

The validations of the attribute, may not be null.

getAttributeRelationEntityName

public String getAttributeRelationEntityName()

Description copied from interface: IDomainPropertyDefinition

This method returns the name of entity where the domain property has a relation to. This method only returns a value when the domain property refers to a relation.

Specified by:

getAttributeRelationEntityName in interface IDomainPropertyDefinition

Returns:

The name of entity where the domain property has a relation to, can be null.

getCustomSchemaElement

public IElementReference getCustomSchemaElement()

Description copied from interface: IDomainPropertyDefinition

Returns the custom schema element.

Specified by:

getCustomSchemaElement in interface IDomainPropertyDefinition

Returns:

The custom schema element, otherwise null.