com.sap.cloud.sdk.datamodel.odata.client.request

Class ODataEntityKey

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.request.ODataEntityKey

@Beta
public class ODataEntityKey
extends Object

Wrapper class to hold an OData entity composite key.

Constructor Summary

Constructors

Constructor and Description
ODataEntityKey()

Method Summary

Modifier and Type	Method and Description
ODataEntityKey	addKeyProperties(Map<String,Object> properties) Add properties to the OData entity key.
<PrimitiveT> void	addKeyProperty(String propertyName, PrimitiveT value) Add an entity property to this composite key.
Set<String>	getFieldNames() Get the field names that are part of the composite key.
static ODataEntityKey	of(Map<String,Object> key) Create an instance of ODataEntityKey from a generic key-value composition.
String	toString(ODataProtocol protocol) Serializes key properties into an OData URL format for entity keys.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ODataEntityKey

public ODataEntityKey()

Method Detail

getFieldNames

@Nonnull
public Set<String> getFieldNames()

Get the field names that are part of the composite key.

Returns:

A set of entity property field names.

addKeyProperty

public <PrimitiveT> void addKeyProperty(@Nonnull
                                        String propertyName,
                                        @Nonnull
                                        PrimitiveT value)

Add an entity property to this composite key.

Type Parameters:

PrimitiveT - Type of the primitive value.

Parameters:

propertyName - Name of the property (derived from the EDMX)

value - Property value, assumed to be a primitive.

Throws:

IllegalArgumentException - When there is no mapping found for the provided Java literal.

addKeyProperties

@Nonnull
public ODataEntityKey addKeyProperties(@Nonnull
                                                Map<String,Object> properties)

Add properties to the OData entity key.

Parameters:

properties - The key-value mapping.

Returns:

The same instance.

of

@Nonnull
public static ODataEntityKey of(@Nonnull
                                         Map<String,Object> key)

Create an instance of ODataEntityKey from a generic key-value composition.

Parameters:

key - Key-value pairs for primitive entity properties (derived from the EDMX)

Returns:

A new instance of ODataEntityKey.

Throws:

IllegalArgumentException - When there is no mapping found for the provided Java literal.

toString

@Nonnull
public String toString(@Nonnull
                                ODataProtocol protocol)

Serializes key properties into an OData URL format for entity keys.

Returns:

URL string representation of entity key.