Package com.sap.cds.reflect.overlay

Interface CdsEntityExtender

@Beta
public interface CdsEntityExtender

The CdsEntityExtender allows to extend the underlying CdsEntity with additional elements, associations/compositions and annotations or extend its existing elements.

Method Summary

Modifier and Type	Method	Description
CdsEntityExtender	addAnnotation(String key, Object value)	Adds an annotation to the entity.
CdsAssociationExtender	addAssociation(String name)	Returns a new CdsAssociationExtender for an association with the given name to be added to the entity.
CdsAssociationExtender	addComposition(String name)	Returns a new CdsAssociationExtender for a composition with the given name to be added to the entity.
CdsElementExtender	addElement(String name)	Creates a new CdsElementExtender for an element with the given name to be added to the entity.
CdsModelExtender	and()	Returns to the CdsModelExtender that created this CdsEntityExtender.
CdsElementExtender	element(String name)	Returns a new CdsElementExtender for an element with the given name.
CdsEntityExtender	query(CqnSelect query)	Sets the CqnSelect query for the entity.

Method Details

addElement

CdsElementExtender addElement(String name)

Creates a new CdsElementExtender for an element with the given name to be added to the entity. If the entity has an element with the same name already, an IllegalArgumentException is thrown.

Parameters:

name - the name of the element to add

Returns:

a CdsElementExtender to further configure the element

Throws:

IllegalArgumentException - if an element with the same name already exists

element

CdsElementExtender element(String name)

Returns a new CdsElementExtender for an element with the given name. If the element does not exist in the entity, a CdsElementNotFoundException is thrown.

Parameters:

name - the name of the element to extend

Returns:

a CdsElementExtender to further configure the element

Throws:

CdsElementNotFoundException - if the element does not exist in the entity

addAssociation

CdsAssociationExtender addAssociation(String name)

Returns a new CdsAssociationExtender for an association with the given name to be added to the entity. If the entity has an element with the same name already, an IllegalArgumentException is thrown.

Parameters:

name - the name of the association to add

Returns:

a CdsAssociationExtender to further configure the association

Throws:

IllegalArgumentException - if an element with the same name already exists

addComposition

CdsAssociationExtender addComposition(String name)

Returns a new CdsAssociationExtender for a composition with the given name to be added to the entity. If the entity has an element with the same name already, an IllegalArgumentException is thrown.

Parameters:

name - the name of the composition to add

Returns:

a CdsAssociationExtender to further configure the composition

Throws:

IllegalArgumentException - if an element with the same name already exists

addAnnotation

CdsEntityExtender addAnnotation(String key,
 Object value)

Adds an annotation to the entity.

Parameters:

key - the annotation key

value - the annotation value

Returns:

this CdsEntityExtender

query

CdsEntityExtender query(CqnSelect query)

Sets the CqnSelect query for the entity.

Parameters:

query - the query

Returns:

this CdsEntityExtender

and

CdsModelExtender and()

Returns to the CdsModelExtender that created this CdsEntityExtender.

Returns:

the CdsModelExtender to continue extending the model