public interface

OModifyRequest

org.odata4j.core.OModifyRequest<T>

Class Overview

A consumer-side modification-request builder, used for operations such as MERGE and UPDATE. Call #execute() to issue the request.

Summary

Public Methods
abstract boolean execute(String serviceUri)
Sends the modification-request to the OData service and returns success or failure.
abstract ODataClientRequest getRawRequest(String serviceUri)
Returns the low level, not yet executed OData request
abstract OModifyRequest<T> link(String navProperty, OEntityKey targetKey)
Define an explicit link to another related entity.
abstract OModifyRequest<T> link(String navProperty, OEntity target)
Define an explicit link to another related entity.
abstract OModifyRequest<T> nav(String navProperty, OEntityKey key)
Select a new modification entity by navigating to a referenced entity in a child collection.
abstract OModifyRequest<T> properties(Iterable<OProperty<?>> props)
Set properties on the new entity.
abstract OModifyRequest<T> properties(OProperty...<?> props)
Set properties on the new entity.

Public Methods

public abstract boolean execute (String serviceUri)

Sends the modification-request to the OData service and returns success or failure.

Parameters
serviceUri
Returns
  • success or failure

public abstract ODataClientRequest getRawRequest (String serviceUri)

Returns the low level, not yet executed OData request

Parameters
serviceUri

public abstract OModifyRequest<T> link (String navProperty, OEntityKey targetKey)

Define an explicit link to another related entity.

Parameters
navProperty The entity's relationship navigation property
targetKey The key of the link target entity
Returns
  • the modification-request builder

public abstract OModifyRequest<T> link (String navProperty, OEntity target)

Define an explicit link to another related entity.

Parameters
navProperty The entity's relationship navigation property
target The link target entity
Returns
  • the modification-request builder

public abstract OModifyRequest<T> nav (String navProperty, OEntityKey key)

Select a new modification entity by navigating to a referenced entity in a child collection.

Parameters
navProperty The child collection
key The referenced entity's key
Returns
  • the modification-request builder

public abstract OModifyRequest<T> properties (Iterable<OProperty<?>> props)

Set properties on the new entity.

Parameters
props The properties
Returns
  • the modification-request builder

public abstract OModifyRequest<T> properties (OProperty...<?> props)

Set properties on the new entity.

Parameters
props The properties
Returns
  • the modification-request builder