Modifier and Type | Class and Description |
---|---|
static class |
Segment.SegmentBuilder
Helper class to allow for fluent creation of Segment instances.
|
Modifier and Type | Field and Description |
---|---|
static SegmentSelectable |
ALL_FIELDS
Selector for all available fields of Segment.
|
static SegmentField<String> |
SEGMENT
Use with available fluent helpers to apply the Segment field to query operations.
|
static SegmentLink<SegmentText> |
TO_TEXT
Use with available fluent helpers to apply the to_Text navigation property to query operations.
|
changedOriginalFields
Constructor and Description |
---|
Segment() |
Segment(String segment,
List<SegmentText> toText) |
Modifier and Type | Method and Description |
---|---|
void |
addText(SegmentText... entity)
Adds elements to the list of associated SegmentText entities.
|
void |
attachToService(String servicePath,
HttpDestinationProperties destination)
Sets the service path and destination for the fetch commands of this entity.
|
static Segment.SegmentBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
List<SegmentText> |
fetchText()
Fetches the SegmentText entities (one to many) associated with this entity.
|
static <T> SegmentField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
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 |
getSegment()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
io.vavr.control.Option<List<SegmentText>> |
getTextIfPresent()
Retrieval of associated SegmentText entities (one to many).
|
List<SegmentText> |
getTextOrFetch()
Retrieval of associated SegmentText entities (one to many).
|
Class<Segment> |
getType() |
int |
hashCode() |
void |
setSegment(String segment)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
void |
setText(List<SegmentText> value)
Overwrites the list of associated SegmentText entities for the loaded navigation property to_Text.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final SegmentSelectable ALL_FIELDS
public static final SegmentField<String> SEGMENT
public static final SegmentLink<SegmentText> TO_TEXT
public Segment()
public Segment(@Nullable String segment, List<SegmentText> toText)
public void setSegment(@Nullable String segment)
Original property name from the Odata EDM: Segment
segment
- Segment for Segmental Reportingprotected String getEntityCollection()
VdmEntity
getEntityCollection
in class VdmEntity<Segment>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<Segment>
@Nonnull public static <T> SegmentField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> SegmentField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<Segment>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
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.
setServicePathForFetch
in class VdmEntity<Segment>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
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.
attachToService
in class VdmEntity<Segment>
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.protected String getDefaultServicePath()
VdmEntity
getDefaultServicePath
in class VdmEntity<Segment>
protocol://hostname:port
and the OData resource name (entity set, $metadata
, etc.)@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<Segment>
@Nonnull public List<SegmentText> fetchText() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nonnull public List<SegmentText> getTextOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_Text of a queried Segment is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nonnull public io.vavr.control.Option<List<SegmentText>> getTextIfPresent()
If the navigation property for an entity Segment has not been resolved yet, this method will not
query further information. Instead its Option
result state will be empty
.
Option
with result state empty
is
returned.public void setText(@Nonnull List<SegmentText> value)
If the navigation property to_Text of a queried Segment is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
value
- List of SegmentText entities.public void addText(SegmentText... entity)
If the navigation property to_Text of a queried Segment is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
entity
- Array of SegmentText entities.@Nonnull public static Segment.SegmentBuilder builder()
@Nullable public String getSegment()
Original property name from the Odata EDM: Segment
Copyright © 2021 SAP SE. All rights reserved.