public class BreakdownTypeText extends VdmEntity<BreakdownTypeText>
Original entity name from the Odata EDM: BreakdownTypeTextType
| Modifier and Type | Class and Description |
|---|---|
static class |
BreakdownTypeText.BreakdownTypeTextBuilder
Helper class to allow for fluent creation of BreakdownTypeText instances.
|
| Modifier and Type | Field and Description |
|---|---|
static BreakdownTypeTextSelectable |
ALL_FIELDS
Selector for all available fields of BreakdownTypeText.
|
static BreakdownTypeTextField<String> |
BREAKDOWN_TYPE
Use with available fluent helpers to apply the BreakdownType field to query operations.
|
static BreakdownTypeTextField<String> |
BREAKDOWN_TYPE_TEXT
Use with available fluent helpers to apply the BreakdownTypeText field to query operations.
|
static BreakdownTypeTextField<String> |
LANGUAGE
Use with available fluent helpers to apply the Language field to query operations.
|
static BreakdownTypeTextOneToOneLink<BreakdownType> |
TO_CNSLDTN_BREAKDOWN_TYPE
Use with available fluent helpers to apply the to_CnsldtnBreakdownType navigation property to query
operations.
|
changedOriginalFields| Constructor and Description |
|---|
BreakdownTypeText() |
BreakdownTypeText(String language,
String breakdownType,
String breakdownTypeText,
BreakdownType toCnsldtnBreakdownType) |
| 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 BreakdownTypeText.BreakdownTypeTextBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
BreakdownType |
fetchCnsldtnBreakdownType()
Fetches the BreakdownType entity (one to one) associated with this entity.
|
static <T> BreakdownTypeTextField<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) |
String |
getBreakdownType()
(Key Field) Constraints: Not nullable, Maximum length: 1
|
String |
getBreakdownTypeText()
Constraints: Not nullable, Maximum length: 60
|
io.vavr.control.Option<BreakdownType> |
getCnsldtnBreakdownTypeIfPresent()
Retrieval of associated BreakdownType entity (one to one).
|
BreakdownType |
getCnsldtnBreakdownTypeOrFetch()
Retrieval of associated BreakdownType entity (one to one).
|
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 |
getLanguage()
(Key Field) Constraints: Not nullable, Maximum length: 2
|
Class<BreakdownTypeText> |
getType() |
int |
hashCode() |
void |
setBreakdownType(String breakdownType)
(Key Field) Constraints: Not nullable, Maximum length: 1
|
void |
setBreakdownTypeText(String breakdownTypeText)
Constraints: Not nullable, Maximum length: 60
|
void |
setCnsldtnBreakdownType(BreakdownType value)
Overwrites the associated BreakdownType entity for the loaded navigation property
to_CnsldtnBreakdownType.
|
void |
setLanguage(String language)
(Key Field) Constraints: Not nullable, Maximum length: 2
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifiergetChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFieldspublic static final BreakdownTypeTextSelectable ALL_FIELDS
public static final BreakdownTypeTextField<String> LANGUAGE
public static final BreakdownTypeTextField<String> BREAKDOWN_TYPE
public static final BreakdownTypeTextField<String> BREAKDOWN_TYPE_TEXT
public static final BreakdownTypeTextOneToOneLink<BreakdownType> TO_CNSLDTN_BREAKDOWN_TYPE
@Nonnull public Class<BreakdownTypeText> getType()
getType in class VdmObject<BreakdownTypeText>public void setLanguage(@Nullable String language)
Original property name from the Odata EDM: Language
- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
language - The language key indicatespublic void setBreakdownType(@Nullable String breakdownType)
Original property name from the Odata EDM: BreakdownType
The following breakdown types exist:If you do not specify a subassignment in the breakdown category, or if you specify breakdown type 0 (no breakdown) for a subassignment in the breakdown category, then the associated items cannot be sub-classified by the subassignment.If you specify breakdown type 1 (optional breakdown) for a subassignment in the breakdown category, then you can sub-classify the associated items by the subassignment; but it is also possible not to break down the items by the subassignment. The values permitted for the subassignment are all values permitted by the data type of the subassignment, including the initialized (blank) value.All other breakdown types (2, 3 and 4) make the breakdown mandatory, that is, the associated items must be broken down by the subassignment; the initialized value is not permitted for the subassignment. These required breakdown types differ as follows:If you specify breakdown type 2 for a subassignment in the breakdown category, then a value does not need to be specified for the subassignment. If no value is specified, the system uses the general default value.If you specify breakdown type 3 for a subassignment in the breakdown category, then a value must be entered for the subassignment. Manual transaction, such as data entry or manual posting, prompt you to enter a value. Automatic posting produces an error message.If you specify breakdown type 4 for a subassignment in the breakdown category, then a value must be entered, as with breakdown type 3. However, the general default value is not permitted.Special Considerations:If subassignment has no general default value, breakdown types 2 and 4 are not permitted.Only breakdown types 0 and 3 are permitted for subassignments, the breakdown category of which has a fixed value (for example, the subitem category or the unit of measure).If the given subassignment has a dependent characteristic, keep the following in mind: If there is a breakdown by the independent characteristic (subitem category), there must also be a breakdown by the dependent characteristic (subitem).Note the following for subassignments that belong to a compound of characteristics: If there is breakdown by the dependent characteristic, there must also be a breakdown by the independent characteristic. If the dependent characteristic has a required breakdown, the independent characteristic must also have a required breakdown.The subassignment "transaction currency" only permits breakdown types 0 and 2.The subassignment "unit of measure" only allows the definition of a fixed value in the breakdown category.Say, you want to sub-classify your receivables, payables and revenue by the partner units. For these items you would specify a breakdown category that has the breakdown types 1, 2, 3 or 4 for the partner unit. Consider the following scenario:You want to enter revenue for each partner unit. The partner unit should always be specified for revenue. If, at first, only the total revenue is known for a consolidation unit, and the details are reported at a later date, the data entry should still be possible. To do this, you create the consolidation unit "Third Parties" and define this unit as the general default value for the partner unit. To the revenue item you assign a breakdown category with breakdown type 2 for the partner unit. Now you no longer need to enter a partner unit when entering revenues. Data entry then saves partner unit "Third Parties". Later on, when the details are reported, you can nullify the value for partner unit "Third Parties" and allocate the value to the reported partner units.For the receivables and payables your select a different procedure because the partner unit details are always known. You distinguish between the items for receivables/payables to/from third parties, for which you have no partner breakdown, and the items for receivables/payables to/from affiliated companies. For the latter items you define breakdown type 4 in the breakdown category because you want to prevent these items from being posted with partner unit "Third parties".Say, in Interunit Elimination, you want to allocate elimination differences to currency-related and other differences. To do this, for the items to be eliminated and the differential items you specify breakdown categories with breakdown type 2 for the transaction currency.Say, you want to translate the transferred asset items with historical exchange rates. For this, you want to sub-classify the items by the year of acquisition. To do this, you assign breakdown type 2 or 3 for the year of acquisition in the respective breakdown categories.Say, you use country and region as custom characteristics, these reflecting a compound of characteristics. In Characteristic Maintenance you define for both subassignments that there is no general default. Then only the breakdown types 0, 1 and 3 are allowed. Because of the compound (country being the independent characteristic) only the following combinations of breakdown types are permitted:Country Region0 01 0 <-- Here a country breakdown exists,3 0 <-- but no regional breakdown exists!1 13 13 3
breakdownType - For each subassignment you can define a breakdown type within a breakdown category. The breakdown type
determines whether you can sub-classify an item, to which the breakdown category is assigned, by the
subassignment during data entry or posting.public void setBreakdownTypeText(@Nullable String breakdownTypeText)
Original property name from the Odata EDM: BreakdownTypeText
breakdownTypeText - Breakdown Type Descriptionprotected String getEntityCollection()
VdmEntitygetEntityCollection in class VdmEntity<BreakdownTypeText>@Nonnull protected Map<String,Object> getKey()
getKey in class VdmObject<BreakdownTypeText>@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields in class VdmObject<BreakdownTypeText>protected void fromMap(Map<String,Object> inputValues)
fromMap in class VdmObject<BreakdownTypeText>@Nonnull public static <T> BreakdownTypeTextField<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> BreakdownTypeTextField<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()
VdmEntitygetDestinationForFetch in class VdmEntity<BreakdownTypeText>protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntityNote: 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<BreakdownTypeText>public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntityNote: 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<BreakdownTypeText>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()
VdmEntitygetDefaultServicePath in class VdmEntity<BreakdownTypeText>protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties in class VdmObject<BreakdownTypeText>@Nullable public BreakdownType fetchCnsldtnBreakdownType() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
null if an entity is not associated.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.@Nullable public BreakdownType getCnsldtnBreakdownTypeOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_CnsldtnBreakdownType of a queried BreakdownTypeText 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<BreakdownType> getCnsldtnBreakdownTypeIfPresent()
If the navigation property for an entity BreakdownTypeText 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 setCnsldtnBreakdownType(BreakdownType value)
value - New BreakdownType entity.public static BreakdownTypeText.BreakdownTypeTextBuilder builder()
@Nullable public String getLanguage()
Original property name from the Odata EDM: Language
- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.
@Nullable public String getBreakdownType()
Original property name from the Odata EDM: BreakdownType
The following breakdown types exist:If you do not specify a subassignment in the breakdown category, or if you specify breakdown type 0 (no breakdown) for a subassignment in the breakdown category, then the associated items cannot be sub-classified by the subassignment.If you specify breakdown type 1 (optional breakdown) for a subassignment in the breakdown category, then you can sub-classify the associated items by the subassignment; but it is also possible not to break down the items by the subassignment. The values permitted for the subassignment are all values permitted by the data type of the subassignment, including the initialized (blank) value.All other breakdown types (2, 3 and 4) make the breakdown mandatory, that is, the associated items must be broken down by the subassignment; the initialized value is not permitted for the subassignment. These required breakdown types differ as follows:If you specify breakdown type 2 for a subassignment in the breakdown category, then a value does not need to be specified for the subassignment. If no value is specified, the system uses the general default value.If you specify breakdown type 3 for a subassignment in the breakdown category, then a value must be entered for the subassignment. Manual transaction, such as data entry or manual posting, prompt you to enter a value. Automatic posting produces an error message.If you specify breakdown type 4 for a subassignment in the breakdown category, then a value must be entered, as with breakdown type 3. However, the general default value is not permitted.Special Considerations:If subassignment has no general default value, breakdown types 2 and 4 are not permitted.Only breakdown types 0 and 3 are permitted for subassignments, the breakdown category of which has a fixed value (for example, the subitem category or the unit of measure).If the given subassignment has a dependent characteristic, keep the following in mind: If there is a breakdown by the independent characteristic (subitem category), there must also be a breakdown by the dependent characteristic (subitem).Note the following for subassignments that belong to a compound of characteristics: If there is breakdown by the dependent characteristic, there must also be a breakdown by the independent characteristic. If the dependent characteristic has a required breakdown, the independent characteristic must also have a required breakdown.The subassignment "transaction currency" only permits breakdown types 0 and 2.The subassignment "unit of measure" only allows the definition of a fixed value in the breakdown category.Say, you want to sub-classify your receivables, payables and revenue by the partner units. For these items you would specify a breakdown category that has the breakdown types 1, 2, 3 or 4 for the partner unit. Consider the following scenario:You want to enter revenue for each partner unit. The partner unit should always be specified for revenue. If, at first, only the total revenue is known for a consolidation unit, and the details are reported at a later date, the data entry should still be possible. To do this, you create the consolidation unit "Third Parties" and define this unit as the general default value for the partner unit. To the revenue item you assign a breakdown category with breakdown type 2 for the partner unit. Now you no longer need to enter a partner unit when entering revenues. Data entry then saves partner unit "Third Parties". Later on, when the details are reported, you can nullify the value for partner unit "Third Parties" and allocate the value to the reported partner units.For the receivables and payables your select a different procedure because the partner unit details are always known. You distinguish between the items for receivables/payables to/from third parties, for which you have no partner breakdown, and the items for receivables/payables to/from affiliated companies. For the latter items you define breakdown type 4 in the breakdown category because you want to prevent these items from being posted with partner unit "Third parties".Say, in Interunit Elimination, you want to allocate elimination differences to currency-related and other differences. To do this, for the items to be eliminated and the differential items you specify breakdown categories with breakdown type 2 for the transaction currency.Say, you want to translate the transferred asset items with historical exchange rates. For this, you want to sub-classify the items by the year of acquisition. To do this, you assign breakdown type 2 or 3 for the year of acquisition in the respective breakdown categories.Say, you use country and region as custom characteristics, these reflecting a compound of characteristics. In Characteristic Maintenance you define for both subassignments that there is no general default. Then only the breakdown types 0, 1 and 3 are allowed. Because of the compound (country being the independent characteristic) only the following combinations of breakdown types are permitted:Country Region0 01 0 <-- Here a country breakdown exists,3 0 <-- but no regional breakdown exists!1 13 13 3
@Nullable public String getBreakdownTypeText()
Original property name from the Odata EDM: BreakdownTypeText
public String toString()
toString in class VdmObject<BreakdownTypeText>public boolean equals(Object o)
equals in class VdmObject<BreakdownTypeText>protected boolean canEqual(Object other)
canEqual in class VdmObject<BreakdownTypeText>public int hashCode()
hashCode in class VdmObject<BreakdownTypeText>Copyright © 2020 SAP SE. All rights reserved.