com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue

Class BusinessObjectKeys

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BusinessObjectKeys>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventqueue.BusinessObjectKeys

public class BusinessObjectKeys
extends VdmEntity<BusinessObjectKeys>

SAP Object Type Keys

Original entity name from the Odata EDM: I_BusinessObjectKeysType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessObjectKeys.BusinessObjectKeysBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BusinessObjectKeysSelectable	ALL_FIELDS Selector for all available fields of BusinessObjectKeys.
static BusinessObjectKeysField<String>	KEY_FIELD_NAME1 Use with available fluent helpers to apply the KeyFieldName1 field to query operations.
static BusinessObjectKeysField<String>	KEY_FIELD_NAME2 Use with available fluent helpers to apply the KeyFieldName2 field to query operations.
static BusinessObjectKeysField<String>	KEY_FIELD_NAME3 Use with available fluent helpers to apply the KeyFieldName3 field to query operations.
static BusinessObjectKeysField<String>	KEY_FIELD_NAME4 Use with available fluent helpers to apply the KeyFieldName4 field to query operations.
static BusinessObjectKeysField<String>	KEY_FIELD_NAME5 Use with available fluent helpers to apply the KeyFieldName5 field to query operations.
static BusinessObjectKeysField<String>	KEY_FIELD_NAME6 Use with available fluent helpers to apply the KeyFieldName6 field to query operations.
static BusinessObjectKeysField<String>	SAP_OBJECT_TYPE Use with available fluent helpers to apply the SAPObjectType field to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BusinessObjectKeys()
BusinessObjectKeys(String sAPObjectType, String keyFieldName1, String keyFieldName2, String keyFieldName3, String keyFieldName4, String keyFieldName5, String keyFieldName6)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BusinessObjectKeys.BusinessObjectKeysBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> BusinessObjectKeysField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BusinessObjectKeysField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
String	getKeyFieldName1() Constraints: Not nullable, Maximum length: 40
String	getKeyFieldName2() Constraints: Not nullable, Maximum length: 40
String	getKeyFieldName3() Constraints: Not nullable, Maximum length: 40
String	getKeyFieldName4() Constraints: Not nullable, Maximum length: 40
String	getKeyFieldName5() Constraints: Not nullable, Maximum length: 40
String	getKeyFieldName6() Constraints: Not nullable, Maximum length: 40
String	getSAPObjectType() (Key Field) Constraints: Not nullable, Maximum length: 30
Class<BusinessObjectKeys>	getType()
int	hashCode()
void	setKeyFieldName1(String keyFieldName1) Constraints: Not nullable, Maximum length: 40
void	setKeyFieldName2(String keyFieldName2) Constraints: Not nullable, Maximum length: 40
void	setKeyFieldName3(String keyFieldName3) Constraints: Not nullable, Maximum length: 40
void	setKeyFieldName4(String keyFieldName4) Constraints: Not nullable, Maximum length: 40
void	setKeyFieldName5(String keyFieldName5) Constraints: Not nullable, Maximum length: 40
void	setKeyFieldName6(String keyFieldName6) Constraints: Not nullable, Maximum length: 40
void	setSAPObjectType(String sAPObjectType) (Key Field) Constraints: Not nullable, Maximum length: 30
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
String	toString()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final BusinessObjectKeysSelectable ALL_FIELDS

Selector for all available fields of BusinessObjectKeys.

SAP_OBJECT_TYPE

public static final BusinessObjectKeysField<String> SAP_OBJECT_TYPE

Use with available fluent helpers to apply the SAPObjectType field to query operations.

KEY_FIELD_NAME1

public static final BusinessObjectKeysField<String> KEY_FIELD_NAME1

Use with available fluent helpers to apply the KeyFieldName1 field to query operations.

KEY_FIELD_NAME2

public static final BusinessObjectKeysField<String> KEY_FIELD_NAME2

Use with available fluent helpers to apply the KeyFieldName2 field to query operations.

KEY_FIELD_NAME3

public static final BusinessObjectKeysField<String> KEY_FIELD_NAME3

Use with available fluent helpers to apply the KeyFieldName3 field to query operations.

KEY_FIELD_NAME4

public static final BusinessObjectKeysField<String> KEY_FIELD_NAME4

Use with available fluent helpers to apply the KeyFieldName4 field to query operations.

KEY_FIELD_NAME5

public static final BusinessObjectKeysField<String> KEY_FIELD_NAME5

Use with available fluent helpers to apply the KeyFieldName5 field to query operations.

KEY_FIELD_NAME6

public static final BusinessObjectKeysField<String> KEY_FIELD_NAME6

Use with available fluent helpers to apply the KeyFieldName6 field to query operations.

Constructor Detail

BusinessObjectKeys

public BusinessObjectKeys()

BusinessObjectKeys

public BusinessObjectKeys(@Nullable
                          String sAPObjectType,
                          @Nullable
                          String keyFieldName1,
                          @Nullable
                          String keyFieldName2,
                          @Nullable
                          String keyFieldName3,
                          @Nullable
                          String keyFieldName4,
                          @Nullable
                          String keyFieldName5,
                          @Nullable
                          String keyFieldName6)

Method Detail

getType

@Nonnull
public Class<BusinessObjectKeys> getType()

Specified by:

getType in class VdmObject<BusinessObjectKeys>

Returns:

The class of this object.

setSAPObjectType

public void setSAPObjectType(@Nullable
                             String sAPObjectType)

(Key Field) Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SAPObjectType

Parameters:

sAPObjectType - Indicates the name of the business object type.

setKeyFieldName1

public void setKeyFieldName1(@Nullable
                             String keyFieldName1)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName1

Parameters:

keyFieldName1 - Indicates the value of key field of the given business object instance.

setKeyFieldName2

public void setKeyFieldName2(@Nullable
                             String keyFieldName2)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName2

Parameters:

keyFieldName2 - Indicates the value of key field of the given business object instance.

setKeyFieldName3

public void setKeyFieldName3(@Nullable
                             String keyFieldName3)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName3

Parameters:

keyFieldName3 - Indicates the value of key field of the given business object instance.

setKeyFieldName4

public void setKeyFieldName4(@Nullable
                             String keyFieldName4)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName4

Parameters:

keyFieldName4 - Indicates the value of key field of the given business object instance.

setKeyFieldName5

public void setKeyFieldName5(@Nullable
                             String keyFieldName5)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName5

Parameters:

keyFieldName5 - Indicates the value of key field of the given business object instance.

setKeyFieldName6

public void setKeyFieldName6(@Nullable
                             String keyFieldName6)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName6

Parameters:

keyFieldName6 - Indicates the value of key field of the given business object instance.

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<BusinessObjectKeys>

Returns:

EDMX name of the entity collection identifier.

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<BusinessObjectKeys>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<BusinessObjectKeys>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<BusinessObjectKeys>

field

@Nonnull
public static <T> BusinessObjectKeysField<T> field(@Nonnull
                                                            String fieldName,
                                                            @Nonnull
                                                            Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

field

@Nonnull
public static <T,DomainT> BusinessObjectKeysField<T> field(@Nonnull
                                                                    String fieldName,
                                                                    @Nonnull
                                                                    TypeConverter<T,DomainT> typeConverter)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

fieldName - The name of the extension field as returned by the OData service.

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities).

Overrides:

getDestinationForFetch in class VdmEntity<BusinessObjectKeys>

Returns:

The stored destination for executing queries, or null if no such context has been set.

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<BusinessObjectKeys>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<BusinessObjectKeys>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<BusinessObjectKeys>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

builder

@Nonnull
public static BusinessObjectKeys.BusinessObjectKeysBuilder builder()

getSAPObjectType

@Nullable
public String getSAPObjectType()

(Key Field) Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: SAPObjectType

Returns:

Indicates the name of the business object type.

getKeyFieldName1

@Nullable
public String getKeyFieldName1()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName1

Returns:

Indicates the value of key field of the given business object instance.

getKeyFieldName2

@Nullable
public String getKeyFieldName2()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName2

Returns:

Indicates the value of key field of the given business object instance.

getKeyFieldName3

@Nullable
public String getKeyFieldName3()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName3

Returns:

Indicates the value of key field of the given business object instance.

getKeyFieldName4

@Nullable
public String getKeyFieldName4()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName4

Returns:

Indicates the value of key field of the given business object instance.

getKeyFieldName5

@Nullable
public String getKeyFieldName5()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName5

Returns:

Indicates the value of key field of the given business object instance.

getKeyFieldName6

@Nullable
public String getKeyFieldName6()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: KeyFieldName6

Returns:

Indicates the value of key field of the given business object instance.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BusinessObjectKeys>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BusinessObjectKeys>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BusinessObjectKeys>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BusinessObjectKeys>