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

Class SubscriptionRead

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businesseventsubscription.SubscriptionRead

public class SubscriptionRead
extends VdmEntity<SubscriptionRead>

Original entity name from the Odata EDM: SubscriptionRead

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionRead.SubscriptionReadBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SubscriptionReadSelectable	ALL_FIELDS Selector for all available fields of SubscriptionRead.
static SubscriptionReadField<Short>	BUS_EVENT_PRIORITY Use with available fluent helpers to apply the BusEventPriority field to query operations.
static SubscriptionReadField<String>	BUS_EVENT_SUBSCRIBER_CODE Use with available fluent helpers to apply the BusEventSubscriberCode field to query operations.
static SubscriptionReadField<String>	BUS_EVENT_SUBSCRIPTION_STATE_CODE Use with available fluent helpers to apply the BusEventSubscriptionStateCode field to query operations.
static SubscriptionReadField<String>	BUSINESS_EVENT_SUBSCRIBER_NAME Use with available fluent helpers to apply the BusinessEventSubscriberName field to query operations.
static SubscriptionReadField<String>	CREATED_BY_USER_NAME Use with available fluent helpers to apply the CreatedByUserName field to query operations.
static SubscriptionReadField<BigDecimal>	CREATION_UTC_DATE_TIME Use with available fluent helpers to apply the CreationUTCDateTime field to query operations.
static SubscriptionReadField<String>	SAP_OBJECT_TASK_CODE Use with available fluent helpers to apply the SAPObjectTaskCode field to query operations.
static SubscriptionReadField<String>	SAP_OBJECT_TASK_TYPE_NAME Use with available fluent helpers to apply the SAPObjectTaskTypeName field to query operations.
static SubscriptionReadField<String>	SAP_OBJECT_TYPE Use with available fluent helpers to apply the SAPObjectType field to query operations.
static SubscriptionReadField<String>	SAP_OBJECT_TYPE_NAME Use with available fluent helpers to apply the SAPObjectTypeName field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SubscriptionRead()
SubscriptionRead(String busEventSubscriberCode, String sAPObjectType, String sAPObjectTaskCode, String sAPObjectTypeName, String sAPObjectTaskTypeName, String busEventSubscriptionStateCode, Short busEventPriority, String businessEventSubscriberName, BigDecimal creationUTCDateTime, String createdByUserName)

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 SubscriptionRead.SubscriptionReadBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> SubscriptionReadField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SubscriptionReadField<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)
Short	getBusEventPriority() Constraints: Not nullable
String	getBusEventSubscriberCode() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getBusEventSubscriptionStateCode() Constraints: Not nullable, Maximum length: 1
String	getBusinessEventSubscriberName() Constraints: Not nullable, Maximum length: 32
String	getCreatedByUserName() Constraints: Not nullable, Maximum length: 80
BigDecimal	getCreationUTCDateTime() Constraints: Not nullable, Precision: 15, Scale: 0
protected String	getDefaultServicePath()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
String	getSAPObjectTaskCode() (Key Field) Constraints: Not nullable, Maximum length: 18
String	getSAPObjectTaskTypeName() Constraints: Not nullable, Maximum length: 80
String	getSAPObjectType() (Key Field) Constraints: Not nullable, Maximum length: 30
String	getSAPObjectTypeName() Constraints: Not nullable, Maximum length: 80
Class<SubscriptionRead>	getType()
int	hashCode()
void	setBusEventPriority(Short busEventPriority) Constraints: Not nullable
void	setBusEventSubscriberCode(String busEventSubscriberCode) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setBusEventSubscriptionStateCode(String busEventSubscriptionStateCode) Constraints: Not nullable, Maximum length: 1
void	setBusinessEventSubscriberName(String businessEventSubscriberName) Constraints: Not nullable, Maximum length: 32
void	setCreatedByUserName(String createdByUserName) Constraints: Not nullable, Maximum length: 80
void	setCreationUTCDateTime(BigDecimal creationUTCDateTime) Constraints: Not nullable, Precision: 15, Scale: 0
void	setSAPObjectTaskCode(String sAPObjectTaskCode) (Key Field) Constraints: Not nullable, Maximum length: 18
void	setSAPObjectTaskTypeName(String sAPObjectTaskTypeName) Constraints: Not nullable, Maximum length: 80
void	setSAPObjectType(String sAPObjectType) (Key Field) Constraints: Not nullable, Maximum length: 30
void	setSAPObjectTypeName(String sAPObjectTypeName) Constraints: Not nullable, Maximum length: 80
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 SubscriptionReadSelectable ALL_FIELDS

Selector for all available fields of SubscriptionRead.

BUS_EVENT_SUBSCRIBER_CODE

public static final SubscriptionReadField<String> BUS_EVENT_SUBSCRIBER_CODE

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

SAP_OBJECT_TYPE

public static final SubscriptionReadField<String> SAP_OBJECT_TYPE

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

SAP_OBJECT_TASK_CODE

public static final SubscriptionReadField<String> SAP_OBJECT_TASK_CODE

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

SAP_OBJECT_TYPE_NAME

public static final SubscriptionReadField<String> SAP_OBJECT_TYPE_NAME

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

SAP_OBJECT_TASK_TYPE_NAME

public static final SubscriptionReadField<String> SAP_OBJECT_TASK_TYPE_NAME

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

BUS_EVENT_SUBSCRIPTION_STATE_CODE

public static final SubscriptionReadField<String> BUS_EVENT_SUBSCRIPTION_STATE_CODE

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

BUS_EVENT_PRIORITY

public static final SubscriptionReadField<Short> BUS_EVENT_PRIORITY

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

BUSINESS_EVENT_SUBSCRIBER_NAME

public static final SubscriptionReadField<String> BUSINESS_EVENT_SUBSCRIBER_NAME

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

CREATION_UTC_DATE_TIME

public static final SubscriptionReadField<BigDecimal> CREATION_UTC_DATE_TIME

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

CREATED_BY_USER_NAME

public static final SubscriptionReadField<String> CREATED_BY_USER_NAME

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

Constructor Detail

SubscriptionRead

public SubscriptionRead()

SubscriptionRead

public SubscriptionRead(@Nullable
                        String busEventSubscriberCode,
                        @Nullable
                        String sAPObjectType,
                        @Nullable
                        String sAPObjectTaskCode,
                        @Nullable
                        String sAPObjectTypeName,
                        @Nullable
                        String sAPObjectTaskTypeName,
                        @Nullable
                        String busEventSubscriptionStateCode,
                        @Nullable
                        Short busEventPriority,
                        @Nullable
                        String businessEventSubscriberName,
                        @Nullable
                        BigDecimal creationUTCDateTime,
                        @Nullable
                        String createdByUserName)

Method Detail

getType

@Nonnull
public Class<SubscriptionRead> getType()

Specified by:

getType in class VdmObject<SubscriptionRead>

Returns:

The class of this object.

setBusEventSubscriberCode

public void setBusEventSubscriberCode(@Nullable
                                      String busEventSubscriberCode)

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

Original property name from the Odata EDM: BusEventSubscriberCode

Parameters:

busEventSubscriberCode - Indicates the unique identification that you use to maintain the business object subscriptions

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.

setSAPObjectTaskCode

public void setSAPObjectTaskCode(@Nullable
                                 String sAPObjectTaskCode)

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

Original property name from the Odata EDM: SAPObjectTaskCode

Parameters:

sAPObjectTaskCode - SAP Object Task Code

setSAPObjectTypeName

public void setSAPObjectTypeName(@Nullable
                                 String sAPObjectTypeName)

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: SAPObjectTypeName

Parameters:

sAPObjectTypeName - Indicates the text description of a particular business object type.

setSAPObjectTaskTypeName

public void setSAPObjectTaskTypeName(@Nullable
                                     String sAPObjectTaskTypeName)

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: SAPObjectTaskTypeName

Parameters:

sAPObjectTaskTypeName - Indicates the text description of a particular business object task, which is dependent on the language that you maintain in the text table.

setBusEventSubscriptionStateCode

public void setBusEventSubscriptionStateCode(@Nullable
                                             String busEventSubscriptionStateCode)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: BusEventSubscriptionStateCode

Parameters:

busEventSubscriptionStateCode - Indicates whether the subscription is active or inactive. If the value of this field is 1, then the subscription is active. If the value of this field is 0, then the subscription is inactive. When a subscription is created, then by default, it is in Active state.

setBusEventPriority

public void setBusEventPriority(@Nullable
                                Short busEventPriority)

Constraints: Not nullable

Original property name from the Odata EDM: BusEventPriority

Parameters:

busEventPriority - Indicates the importance level of a subscription. For example, if the priority of a subscription is 1, then it will hold the most importance.

setBusinessEventSubscriberName

public void setBusinessEventSubscriberName(@Nullable
                                           String businessEventSubscriberName)

Constraints: Not nullable, Maximum length: 32

Original property name from the Odata EDM: BusinessEventSubscriberName

Parameters:

businessEventSubscriberName - Indicates the short description that you use for Subscriber ID.

setCreationUTCDateTime

public void setCreationUTCDateTime(@Nullable
                                   BigDecimal creationUTCDateTime)

Constraints: Not nullable, Precision: 15, Scale: 0

Original property name from the Odata EDM: CreationUTCDateTime

Parameters:

creationUTCDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

setCreatedByUserName

public void setCreatedByUserName(@Nullable
                                 String createdByUserName)

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: CreatedByUserName

Parameters:

createdByUserName - User Description

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<SubscriptionRead>

getKey

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

Overrides:

getKey in class VdmObject<SubscriptionRead>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SubscriptionRead>

fromMap

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

Overrides:

fromMap in class VdmObject<SubscriptionRead>

field

@Nonnull
public static <T> SubscriptionReadField<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> SubscriptionReadField<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). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<SubscriptionRead>

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<SubscriptionRead>

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<SubscriptionRead>

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()

Overrides:

getDefaultServicePath in class VdmEntity<SubscriptionRead>

builder

public static SubscriptionRead.SubscriptionReadBuilder builder()

getBusEventSubscriberCode

@Nullable
public String getBusEventSubscriberCode()

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

Original property name from the Odata EDM: BusEventSubscriberCode

Returns:

Indicates the unique identification that you use to maintain the business object subscriptions

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.

getSAPObjectTaskCode

@Nullable
public String getSAPObjectTaskCode()

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

Original property name from the Odata EDM: SAPObjectTaskCode

Returns:

SAP Object Task Code

getSAPObjectTypeName

@Nullable
public String getSAPObjectTypeName()

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: SAPObjectTypeName

Returns:

Indicates the text description of a particular business object type.

getSAPObjectTaskTypeName

@Nullable
public String getSAPObjectTaskTypeName()

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: SAPObjectTaskTypeName

Returns:

Indicates the text description of a particular business object task, which is dependent on the language that you maintain in the text table.

getBusEventSubscriptionStateCode

@Nullable
public String getBusEventSubscriptionStateCode()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: BusEventSubscriptionStateCode

Returns:

Indicates whether the subscription is active or inactive. If the value of this field is 1, then the subscription is active. If the value of this field is 0, then the subscription is inactive. When a subscription is created, then by default, it is in Active state.

getBusEventPriority

@Nullable
public Short getBusEventPriority()

Constraints: Not nullable

Original property name from the Odata EDM: BusEventPriority

Returns:

Indicates the importance level of a subscription. For example, if the priority of a subscription is 1, then it will hold the most importance.

getBusinessEventSubscriberName

@Nullable
public String getBusinessEventSubscriberName()

Constraints: Not nullable, Maximum length: 32

Original property name from the Odata EDM: BusinessEventSubscriberName

Returns:

Indicates the short description that you use for Subscriber ID.

getCreationUTCDateTime

@Nullable
public BigDecimal getCreationUTCDateTime()

Constraints: Not nullable, Precision: 15, Scale: 0

Original property name from the Odata EDM: CreationUTCDateTime

Returns:

UTC Time Stamp in Short Form (YYYYMMDDhhmmss)

getCreatedByUserName

@Nullable
public String getCreatedByUserName()

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: CreatedByUserName

Returns:

User Description

toString

public String toString()

Overrides:

toString in class VdmObject<SubscriptionRead>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SubscriptionRead>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SubscriptionRead>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SubscriptionRead>