CUDRequestFactoryImpl (OData V4 Library 1.33.1 API)

java.lang.Object
- org.apache.olingo.client.core.communication.request.cud.CUDRequestFactoryImpl

All Implemented Interfaces:: CUDRequestFactory

public class CUDRequestFactoryImpl
extends Object
implements CUDRequestFactory

Field Summary

Fields
Modifier and Type Field and Description

protected ODataClient client

Fields
Modifier and Type	Field and Description
`protected ODataClient`	`client`

Constructor Summary

Constructors
Constructor and Description

CUDRequestFactoryImpl(ODataClient client)

Constructors
Constructor and Description
`CUDRequestFactoryImpl(ODataClient client)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ODataDeleteRequest`	`getDeleteRequest(URI targetURI)` Gets a delete request object instance.
`<E extends ClientEntity> ODataEntityCreateRequest<E>`	`getEntityCreateRequest(URI targetURI, E entity)` Gets a create request object instance.
`<E extends ClientEntity> ODataEntityUpdateRequest<E>`	`getEntityUpdateRequest(UpdateType type, E entity)` Gets an update request object instance; uses entity's edit link as endpoint.
`<E extends ClientEntity> ODataEntityUpdateRequest<E>`	`getEntityUpdateRequest(URI targetURI, UpdateType type, E changes)` Gets an update request object instance.
`<E extends ClientEntity> ODataMediaEntityCreateRequest<E>`	`getMediaEntityCreateRequest(URI targetURI, InputStream media)` Gets a media entity create request object instance.
`<E extends ClientEntity> ODataMediaEntityUpdateRequest<E>`	`getMediaEntityUpdateRequest(URI editURI, InputStream media)` Gets a media entity update request object instance.
`ODataPropertyUpdateRequest`	`getPropertyCollectionValueUpdateRequest(URI targetURI, ClientProperty property)` Gets an update request object instance.
`ODataPropertyUpdateRequest`	`getPropertyComplexValueUpdateRequest(URI targetURI, UpdateType type, ClientProperty property)` Gets an update request object instance.
`ODataPropertyUpdateRequest`	`getPropertyPrimitiveValueUpdateRequest(URI targetURI, ClientProperty property)` Gets an update request object instance.
`ODataReferenceAddingRequest`	`getReferenceAddingRequest(URI serviceRoot, URI targetURI, URI reference)` A successful POST request to a navigation property's references collection adds a relationship to an existing entity.
`ODataReferenceAddingRequest`	`getReferenceSingleChangeRequest(URI serviceRoot, URI targetURI, URI reference)` A successful PUT request to a single-valued navigation property�s reference resource changes the related entity.
`ODataEntityUpdateRequest<ClientSingleton>`	`getSingletonUpdateRequest(UpdateType type, ClientSingleton entity)`
`ODataEntityUpdateRequest<ClientSingleton>`	`getSingletonUpdateRequest(URI targetURI, UpdateType type, ClientSingleton changes)`
`ODataStreamUpdateRequest`	`getStreamUpdateRequest(URI targetURI, InputStream stream)` Gets a stream update request object instance.
`ODataValueUpdateRequest`	`getValueUpdateRequest(URI targetURI, UpdateType type, ClientPrimitiveValue value)` Gets a create request object instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - client
```
protected final ODataClient client
```
- Constructor Detail
  - CUDRequestFactoryImpl
```
public CUDRequestFactoryImpl(ODataClient client)
```
- Method Detail
  - getEntityCreateRequest
```
public <E extends ClientEntity> ODataEntityCreateRequest<E> getEntityCreateRequest(URI targetURI,
                                                                                   E entity)
```
    Description copied from interface: CUDRequestFactory
    
    Gets a create request object instance.
    Use this kind of request to create a new entity.
    
    Specified by:
    
    getEntityCreateRequest in interface CUDRequestFactory
    
    Type Parameters:
    
    E - concrete ODataEntity implementation
    
    Parameters:
    
    targetURI - entity set URI.
    
    entity - entity to be created.
    
    Returns:
    
    new ODataEntityCreateRequest instance.
  - getEntityUpdateRequest
```
public <E extends ClientEntity> ODataEntityUpdateRequest<E> getEntityUpdateRequest(URI targetURI,
                                                                                   UpdateType type,
                                                                                   E changes)
```
    Description copied from interface: CUDRequestFactory
    
    Gets an update request object instance.
    
    Specified by:
    
    getEntityUpdateRequest in interface CUDRequestFactory
    
    Type Parameters:
    
    E - concrete ODataEntity implementation
    
    Parameters:
    
    targetURI - edit link of the object to be updated.
    
    type - type of update to be performed.
    
    changes - changes to be applied.
    
    Returns:
    
    new ODataEntityUpdateRequest instance.
  - getEntityUpdateRequest
```
public <E extends ClientEntity> ODataEntityUpdateRequest<E> getEntityUpdateRequest(UpdateType type,
                                                                                   E entity)
```
    Description copied from interface: CUDRequestFactory
    
    Gets an update request object instance; uses entity's edit link as endpoint.
    
    Specified by:
    
    getEntityUpdateRequest in interface CUDRequestFactory
    
    Type Parameters:
    
    E - concrete ODataEntity implementation
    
    Parameters:
    
    type - type of update to be performed.
    
    entity - changes to be applied.
    
    Returns:
    
    new ODataEntityUpdateRequest instance.
  - getValueUpdateRequest
```
public ODataValueUpdateRequest getValueUpdateRequest(URI targetURI,
                                                     UpdateType type,
                                                     ClientPrimitiveValue value)
```
    Description copied from interface: CUDRequestFactory
    
    Gets a create request object instance.
    Use this kind of request to create a new value (e.g. http://Northwind.svc/Customer(1)/Picture/$value).
    
    Specified by:
    
    getValueUpdateRequest in interface CUDRequestFactory
    
    Parameters:
    
    targetURI - entity set or entity or entity property URI.
    
    type - type of update to be performed.
    
    value - value to be created.
    
    Returns:
    
    new ODataValueUpdateRequest instance.
  - getPropertyPrimitiveValueUpdateRequest
```
public ODataPropertyUpdateRequest getPropertyPrimitiveValueUpdateRequest(URI targetURI,
                                                                         ClientProperty property)
```
    Description copied from interface: CUDRequestFactory
    
    Gets an update request object instance.
    Use this kind of request to update a primitive property value.
    
    Specified by:
    
    getPropertyPrimitiveValueUpdateRequest in interface CUDRequestFactory
    
    Parameters:
    
    targetURI - entity set or entity or entity property URI.
    
    property - value to be update.
    
    Returns:
    
    new ODataPropertyUpdateRequest instance.
  - getPropertyComplexValueUpdateRequest
```
public ODataPropertyUpdateRequest getPropertyComplexValueUpdateRequest(URI targetURI,
                                                                       UpdateType type,
                                                                       ClientProperty property)
```
    Description copied from interface: CUDRequestFactory
    
    Gets an update request object instance.
    Use this kind of request to update a complex property value.
    
    Specified by:
    
    getPropertyComplexValueUpdateRequest in interface CUDRequestFactory
    
    Parameters:
    
    targetURI - entity set or entity or entity property URI.
    
    type - type of update to be performed.
    
    property - value to be update.
    
    Returns:
    
    new ODataPropertyUpdateRequest instance.
  - getPropertyCollectionValueUpdateRequest
```
public ODataPropertyUpdateRequest getPropertyCollectionValueUpdateRequest(URI targetURI,
                                                                          ClientProperty property)
```
    Description copied from interface: CUDRequestFactory
    
    Gets an update request object instance.
    Use this kind of request to update a collection property value.
    
    Specified by:
    
    getPropertyCollectionValueUpdateRequest in interface CUDRequestFactory
    
    Parameters:
    
    targetURI - entity set or entity or entity property URI.
    
    property - value to be update.
    
    Returns:
    
    new ODataPropertyUpdateRequest instance.
  - getDeleteRequest
```
public ODataDeleteRequest getDeleteRequest(URI targetURI)
```
    Description copied from interface: CUDRequestFactory
    
    Gets a delete request object instance.
    Use this kind of request to delete an entity and media entity as well.
    
    Specified by:
    
    getDeleteRequest in interface CUDRequestFactory
    
    Parameters:
    
    targetURI - edit link of the object to be removed.
    
    Returns:
    
    new ODataDeleteRequest instance.
  - getMediaEntityCreateRequest
```
public <E extends ClientEntity> ODataMediaEntityCreateRequest<E> getMediaEntityCreateRequest(URI targetURI,
                                                                                             InputStream media)
```
    Description copied from interface: CUDRequestFactory
    
    Gets a media entity create request object instance.
    Use this kind of request to create a new media entity.
    
    Specified by:
    
    getMediaEntityCreateRequest in interface CUDRequestFactory
    
    Type Parameters:
    
    E - concrete ODataEntity implementation
    
    Parameters:
    
    targetURI - entity set URI.
    
    media - entity blob to be created.
    
    Returns:
    
    new ODataMediaEntityCreateRequest instance.
  - getStreamUpdateRequest
```
public ODataStreamUpdateRequest getStreamUpdateRequest(URI targetURI,
                                                       InputStream stream)
```
    Description copied from interface: CUDRequestFactory
    
    Gets a stream update request object instance.
    Use this kind of request to update a named stream property.
    
    Specified by:
    
    getStreamUpdateRequest in interface CUDRequestFactory
    
    Parameters:
    
    targetURI - target URI.
    
    stream - stream to be updated.
    
    Returns:
    
    new ODataStreamUpdateRequest instance.
  - getMediaEntityUpdateRequest
```
public <E extends ClientEntity> ODataMediaEntityUpdateRequest<E> getMediaEntityUpdateRequest(URI editURI,
                                                                                             InputStream media)
```
    Description copied from interface: CUDRequestFactory
    
    Gets a media entity update request object instance.
    Use this kind of request to update a media entity.
    
    Specified by:
    
    getMediaEntityUpdateRequest in interface CUDRequestFactory
    
    Type Parameters:
    
    E - concrete ODataEntity implementation
    
    Parameters:
    
    editURI - media entity edit link URI.
    
    media - entity blob to be updated.
    
    Returns:
    
    new ODataMediaEntityUpdateRequest instance.
  - getSingletonUpdateRequest
```
public ODataEntityUpdateRequest<ClientSingleton> getSingletonUpdateRequest(UpdateType type,
                                                                           ClientSingleton entity)
```
    Specified by:
    
    getSingletonUpdateRequest in interface CUDRequestFactory
  - getSingletonUpdateRequest
```
public ODataEntityUpdateRequest<ClientSingleton> getSingletonUpdateRequest(URI targetURI,
                                                                           UpdateType type,
                                                                           ClientSingleton changes)
```
    Specified by:
    
    getSingletonUpdateRequest in interface CUDRequestFactory
  - getReferenceAddingRequest
```
public ODataReferenceAddingRequest getReferenceAddingRequest(URI serviceRoot,
                                                             URI targetURI,
                                                             URI reference)
```
    Description copied from interface: CUDRequestFactory
    
    A successful POST request to a navigation property's references collection adds a relationship to an existing entity. The request body MUST contain a single entity reference that identifies the entity to be added. [OData-Protocol 4.0 - 11.4.6.1]
    
    Specified by:
    
    getReferenceAddingRequest in interface CUDRequestFactory
    
    Parameters:
    
    serviceRoot - serviceRoot URI
    
    targetURI - navigation property reference collection URI
    
    reference - entity reference
    
    Returns:
    
    new ODataReferenceAddingRequest instance.
  - getReferenceSingleChangeRequest
```
public ODataReferenceAddingRequest getReferenceSingleChangeRequest(URI serviceRoot,
                                                                   URI targetURI,
                                                                   URI reference)
```
    Description copied from interface: CUDRequestFactory
    
    A successful PUT request to a single-valued navigation property�s reference resource changes the related entity. The request body MUST contain a single entity reference that identifies the existing entity to be related. [OData-Protocol 4.0 - 11.4.6.3]
    
    Specified by:
    
    getReferenceSingleChangeRequest in interface CUDRequestFactory
    
    Parameters:
    
    serviceRoot - serviceRoot URI
    
    targetURI - single-valued navigation property URI
    
    reference - reference
    
    Returns:
    
    new ODataReferenceAddingRequest instance

Class CUDRequestFactoryImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

Constructor Detail

CUDRequestFactoryImpl

Method Detail

getEntityCreateRequest

getEntityUpdateRequest

getEntityUpdateRequest

getValueUpdateRequest

getPropertyPrimitiveValueUpdateRequest

getPropertyComplexValueUpdateRequest

getPropertyCollectionValueUpdateRequest

getDeleteRequest

getMediaEntityCreateRequest

getStreamUpdateRequest

getMediaEntityUpdateRequest

getSingletonUpdateRequest

getSingletonUpdateRequest

getReferenceAddingRequest

getReferenceSingleChangeRequest