Package com.ptc.odata.core.entity.processor

Interface EntityObjectProcessor

All Known Implementing Classes:

BasicEntityProcessor, ClfStructureProcessor, PersistableEntityProcessor, RemoteChangeItemEntityProcessor

public interface EntityObjectProcessor

The Entity processor is responsible for processing all Create, Read, Update and Delete operations of an Entity or Entity Collection. The Entity processor is created by the EntityProviderDelegate and called by the EntityProviderProcessor.

Supported API: true

Extendable: false

See Also:

• EntityProviderDelegate
• EntityProviderProcessor

Method Summary

Modifier and Type	Method	Description
org.apache.olingo.commons.api.data.Entity	createEntityData(org.apache.olingo.commons.api.data.Entity createdEntity, EntityProcessorData processorData)	Creates an Entity for the posted entity data.
void	deleteEntityData(org.apache.olingo.commons.api.data.Entity deletedEntity, EntityProcessorData processorData)	Deletes the requested entity data.
default Map<Object,Collection>	getRelatedEntityCollection(NavigationProcessorData navigationData)	Provides a collection of related entities which match the requested criteria.
default boolean	isValidEntityKey(String entityKey, EntityProcessorData processorData)	Validates that keys provided in the URL is valid.
Object	readEntityData(EntityProcessorData processorData)	Provides a specific entity for the requested entity id.
Collection	readEntitySetData(EntityProcessorData processorData)	Provides a collection of entities which match the requested entity criteria.
Map<Object,org.apache.olingo.commons.api.data.Entity>	toEntities(Collection objects, EntityProcessorData processorData)	Converts a collection backing system objects to a collection of Entity objects.
Map<Object,org.apache.olingo.commons.api.data.Entity>	toEntities(Collection objects, EntityProcessorData processorData, Set<String> entityProperties)	Converts a collection backing system objects to a collection of Entity objects but only the properties whose names are supplied in the last parameter are populated Supported API: true
org.apache.olingo.commons.api.data.Entity	toEntity(Object object, EntityProcessorData processorData)	Single object API for converting a backing system object to a Entity object.
Object	toObject(org.apache.olingo.commons.api.data.Entity entity, EntityProcessorData processorData)	Converts a Entity object to the backing system object.
Map<org.apache.olingo.commons.api.data.Entity,Object>	toObjects(org.apache.olingo.commons.api.data.EntityCollection entities, EntityProcessorData processorData)	Converts a collection Entity objects a collection of the backing system objects.
org.apache.olingo.commons.api.data.Entity	updateEntityData(org.apache.olingo.commons.api.data.Entity updatedEntity, EntityProcessorData processorData)	Updates an Entity for the patched entity data.

Method Details

readEntityData

Object readEntityData(EntityProcessorData processorData)
               throws org.apache.olingo.server.api.ODataApplicationException

Provides a specific entity for the requested entity id.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

readEntitySetData

Collection readEntitySetData(EntityProcessorData processorData)
                      throws org.apache.olingo.server.api.ODataApplicationException

Provides a collection of entities which match the requested entity criteria.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

getRelatedEntityCollection

default Map<Object,Collection> getRelatedEntityCollection(NavigationProcessorData navigationData)
                                                   throws org.apache.olingo.server.api.ODataApplicationException

Provides a collection of related entities which match the requested criteria.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• NavigationProcessorData

createEntityData

org.apache.olingo.commons.api.data.Entity createEntityData(org.apache.olingo.commons.api.data.Entity createdEntity,
 EntityProcessorData processorData)
                                                    throws org.apache.olingo.server.api.ODataApplicationException

Creates an Entity for the posted entity data.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

updateEntityData

org.apache.olingo.commons.api.data.Entity updateEntityData(org.apache.olingo.commons.api.data.Entity updatedEntity,
 EntityProcessorData processorData)
                                                    throws org.apache.olingo.server.api.ODataApplicationException

Updates an Entity for the patched entity data.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

deleteEntityData

void deleteEntityData(org.apache.olingo.commons.api.data.Entity deletedEntity,
 EntityProcessorData processorData)
               throws org.apache.olingo.server.api.ODataApplicationException

Deletes the requested entity data.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

toObjects

Map<org.apache.olingo.commons.api.data.Entity,Object> toObjects(org.apache.olingo.commons.api.data.EntityCollection entities,
 EntityProcessorData processorData)
                                                         throws org.apache.olingo.server.api.ODataApplicationException

Converts a collection Entity objects a collection of the backing system objects.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

toObject

Object toObject(org.apache.olingo.commons.api.data.Entity entity,
 EntityProcessorData processorData)
         throws org.apache.olingo.server.api.ODataApplicationException

Converts a Entity object to the backing system object.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

toEntities

Map<Object,org.apache.olingo.commons.api.data.Entity> toEntities(Collection objects,
 EntityProcessorData processorData)
                                                          throws org.apache.olingo.server.api.ODataApplicationException

Converts a collection backing system objects to a collection of Entity objects.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

toEntities

Map<Object,org.apache.olingo.commons.api.data.Entity> toEntities(Collection objects,
 EntityProcessorData processorData,
 Set<String> entityProperties)
                                                          throws org.apache.olingo.server.api.ODataApplicationException

Converts a collection backing system objects to a collection of Entity objects but only the properties whose names are supplied in the last parameter are populated

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

toEntity

org.apache.olingo.commons.api.data.Entity toEntity(Object object,
 EntityProcessorData processorData)
                                            throws org.apache.olingo.server.api.ODataApplicationException

Single object API for converting a backing system object to a Entity object.

Supported API: true

Throws:

org.apache.olingo.server.api.ODataApplicationException

See Also:

• EntityProcessorData

isValidEntityKey

default boolean isValidEntityKey(String entityKey,
 EntityProcessorData processorData)
                          throws org.apache.olingo.server.api.ODataApplicationException

Validates that keys provided in the URL is valid.

Given the URL segment 'odata/v1/ProdMgmt/Parts('') the value will be passed as the entityKey

Supported API: true

Parameters:

entityKey -

processorData -

Returns:

the result of the test or true when no test is performed.

Throws:

org.apache.olingo.server.api.ODataApplicationException