public interface

OFunctionRequest

implements OQueryRequest<T>
org.odata4j.core.OFunctionRequest<T>

Class Overview

A consumer-side function-request builder. Call execute() or simply iterate to issue the request.

Usage example: 

 Enumerable<OObject> e = myConsumer.callFunction("AFunction")
     .pBoolean("Parameter1", false)
     .pInt32("Parameter2", 55)
     .execute();

Note: OData functions can return single instances or collections of instances. To keep the interface simple, callFunction always returns an Enumerable.

Summary

Public Methods
abstract OFunctionRequest<T> pBoolean(String name, boolean value)
Adds a boolean parameter.
abstract OFunctionRequest<T> pByte(String name, UnsignedByte value)
Adds a byte parameter.
abstract OFunctionRequest<T> pDateTime(String name, Calendar value)
Adds a datetime parameter.
abstract OFunctionRequest<T> pDateTime(String name, Date value)
Adds a datetime parameter.
abstract OFunctionRequest<T> pDateTime(String name, LocalDateTime value)
Adds a datetime parameter.
abstract OFunctionRequest<T> pDecimal(String name, BigDecimal value)
Adds a decimal parameter.
abstract OFunctionRequest<T> pDouble(String name, double value)
Adds a double parameter.
abstract OFunctionRequest<T> pGuid(String name, Guid value)
Adds a guid parameter.
abstract OFunctionRequest<T> pInt16(String name, short value)
Adds a 16-bit integer parameter.
abstract OFunctionRequest<T> pInt32(String name, int value)
Adds a 32-bit integer parameter.
abstract OFunctionRequest<T> pInt64(String name, long value)
Adds a 64-bit integer parameter.
abstract OFunctionRequest<T> pSByte(String name, byte value)
Adds a sbyte parameter.
abstract OFunctionRequest<T> pSingle(String name, float value)
Adds a single parameter.
abstract OFunctionRequest<T> pString(String name, String value)
Adds a string parameter.
abstract OFunctionRequest<T> pTime(String name, Date value)
Adds a time parameter.
abstract OFunctionRequest<T> pTime(String name, Calendar value)
Adds a time parameter.
abstract OFunctionRequest<T> pTime(String name, LocalDateTime value)
Adds a time parameter.
abstract OFunctionRequest<T> parameter(String name, OObject value)
Adds a generic parameter.
[Expand]
Inherited Methods
From interface java.lang.Iterable
From interface org.odata4j.core.OQueryRequest

Public Methods

public abstract OFunctionRequest<T> pBoolean (String name, boolean value)

Adds a boolean parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pByte (String name, UnsignedByte value)

Adds a byte parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pDateTime (String name, Calendar value)

Adds a datetime parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pDateTime (String name, Date value)

Adds a datetime parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pDateTime (String name, LocalDateTime value)

Adds a datetime parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pDecimal (String name, BigDecimal value)

Adds a decimal parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pDouble (String name, double value)

Adds a double parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pGuid (String name, Guid value)

Adds a guid parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pInt16 (String name, short value)

Adds a 16-bit integer parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pInt32 (String name, int value)

Adds a 32-bit integer parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pInt64 (String name, long value)

Adds a 64-bit integer parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pSByte (String name, byte value)

Adds a sbyte parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pSingle (String name, float value)

Adds a single parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pString (String name, String value)

Adds a string parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pTime (String name, Date value)

Adds a time parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pTime (String name, Calendar value)

Adds a time parameter.

Parameters
name
value

public abstract OFunctionRequest<T> pTime (String name, LocalDateTime value)

Adds a time parameter.

Parameters
name
value

public abstract OFunctionRequest<T> parameter (String name, OObject value)

Adds a generic parameter.

Parameters
name
value