com.sap.cloud.sdk.service.prov.api

Interface EntityDataBuilder

All Known Implementing Classes:

DefaultEntityDataBuilder

public interface EntityDataBuilder

Method Summary

Modifier and Type	Method and Description
EntityDataBuilder	addAssociationElement(String name, Object value) Adds an association element and its value to the EntityData which will be built from this EntityDataBuilder object.
EntityDataBuilder	addElement(String name, Object value) Adds an element and its value to the EntityData which will be built from this EntityDataBuilder object.
EntityDataBuilder	addKeyElement(String name, Object value) Adds a key element and its value to the EntityData which will be built from this EntityDataBuilder object.
EntityData	buildEntityData(String name) Builds and returns an entityData based on the current initialized values of the EntityDataBuilder.
EntityDataBuilder	removeElement(String name) Removes an element from the EntityData which is built using this EntityDataBuilder object.

Method Detail

addElement

EntityDataBuilder addElement(String name,
                             Object value)

Adds an element and its value to the EntityData which will be built from this EntityDataBuilder object. This method can be used to add simple as well as structured elements. In the latter case the value should be an instance of HashMap which has the values of the structured type.

Parameters:

name - Name of the element

value - Value of the element

Returns:

The current EntityDataBuilder

removeElement

EntityDataBuilder removeElement(String name)

Removes an element from the EntityData which is built using this EntityDataBuilder object.

Parameters:

name - Name of the element

Returns:

The current EntityDataBuilder

addKeyElement

EntityDataBuilder addKeyElement(String name,
                                Object value)

Adds a key element and its value to the EntityData which will be built from this EntityDataBuilder object. If the element already exists in the builder its value will be overwritten with the new value passed as parameter.

Parameters:

name - Name of the key element

value - Value of the key element

Returns:

The current EntityDataBuilder

buildEntityData

EntityData buildEntityData(String name)

Builds and returns an entityData based on the current initialized values of the EntityDataBuilder.

Parameters:

name - The name of the Entity that would be represented by the created EntityData

Returns:

The created EntityData

addAssociationElement

EntityDataBuilder addAssociationElement(String name,
                                        Object value)

Adds an association element and its value to the EntityData which will be built from this EntityDataBuilder object. This method can be used to add one element as well as list of elements. In the latter case, the value must be an instance of HashMap which has the values of the association.

Parameters:

name - Name of the association element

value - Value of the association element

Returns:

The current EntityDataBuilder