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

Class ProfitCenter

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.ProfitCenter

public class ProfitCenter
extends VdmEntity<ProfitCenter>

Consolidation - Combined Profit Center

Original entity name from the Odata EDM: ProfitCenterType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProfitCenter.ProfitCenterBuilder Helper class to allow for fluent creation of ProfitCenter instances.

Field Summary

Fields

Modifier and Type	Field and Description
static ProfitCenterField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static ProfitCenterSelectable	ALL_FIELDS Selector for all available fields of ProfitCenter.
static ProfitCenterField<String>	CONTROLLING_AREA Use with available fluent helpers to apply the ControllingArea field to query operations.
static ProfitCenterField<String>	PROFIT_CENTER Use with available fluent helpers to apply the ProfitCenter field to query operations.
static ProfitCenterField<String>	PROFIT_CENTER_TEXT Use with available fluent helpers to apply the ProfitCenter_Text field to query operations.
static ProfitCenterLink<ProfitCenterHier>	TO_CNSLDTN_PROFIT_CENTER_HIER Use with available fluent helpers to apply the to_CnsldtnProfitCenterHier navigation property to query operations.
static ProfitCenterLink<ProfitCenterText>	TO_CNSLDTN_PROFIT_CENTER_T Use with available fluent helpers to apply the to_CnsldtnProfitCenterT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ProfitCenter()
ProfitCenter(String profitCenter, String profitCenter_Text, String controllingArea, String additionalMasterDataSource, List<ProfitCenterHier> toCnsldtnProfitCenterHier, List<ProfitCenterText> toCnsldtnProfitCenterT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnProfitCenterHier(ProfitCenterHier... entity) Adds elements to the list of associated ProfitCenterHier entities.
void	addCnsldtnProfitCenterT(ProfitCenterText... entity) Adds elements to the list of associated ProfitCenterText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static ProfitCenter.ProfitCenterBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ProfitCenterHier>	fetchCnsldtnProfitCenterHier() Fetches the ProfitCenterHier entities (one to many) associated with this entity.
List<ProfitCenterText>	fetchCnsldtnProfitCenterT() Fetches the ProfitCenterText entities (one to many) associated with this entity.
static <T> ProfitCenterField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ProfitCenterField<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)
String	getAdditionalMasterDataSource() Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<List<ProfitCenterHier>>	getCnsldtnProfitCenterHierIfPresent() Retrieval of associated ProfitCenterHier entities (one to many).
List<ProfitCenterHier>	getCnsldtnProfitCenterHierOrFetch() Retrieval of associated ProfitCenterHier entities (one to many).
io.vavr.control.Option<List<ProfitCenterText>>	getCnsldtnProfitCenterTIfPresent() Retrieval of associated ProfitCenterText entities (one to many).
List<ProfitCenterText>	getCnsldtnProfitCenterTOrFetch() Retrieval of associated ProfitCenterText entities (one to many).
String	getControllingArea() (Key Field) Constraints: Not nullable, Maximum length: 4
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	getProfitCenter_Text() Constraints: Not nullable, Maximum length: 20
String	getProfitCenter() (Key Field) Constraints: Not nullable, Maximum length: 10
Class<ProfitCenter>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnProfitCenterHier(List<ProfitCenterHier> value) Overwrites the list of associated ProfitCenterHier entities for the loaded navigation property to_CnsldtnProfitCenterHier.
void	setCnsldtnProfitCenterT(List<ProfitCenterText> value) Overwrites the list of associated ProfitCenterText entities for the loaded navigation property to_CnsldtnProfitCenterT.
void	setControllingArea(String controllingArea) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setProfitCenter_Text(String profitCenter_Text) Constraints: Not nullable, Maximum length: 20
void	setProfitCenter(String profitCenter) (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.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
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

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FIELDS

public static final ProfitCenterSelectable ALL_FIELDS

Selector for all available fields of ProfitCenter.

PROFIT_CENTER

public static final ProfitCenterField<String> PROFIT_CENTER

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

PROFIT_CENTER_TEXT

public static final ProfitCenterField<String> PROFIT_CENTER_TEXT

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

CONTROLLING_AREA

public static final ProfitCenterField<String> CONTROLLING_AREA

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final ProfitCenterField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_PROFIT_CENTER_HIER

public static final ProfitCenterLink<ProfitCenterHier> TO_CNSLDTN_PROFIT_CENTER_HIER

Use with available fluent helpers to apply the to_CnsldtnProfitCenterHier navigation property to query operations.

TO_CNSLDTN_PROFIT_CENTER_T

public static final ProfitCenterLink<ProfitCenterText> TO_CNSLDTN_PROFIT_CENTER_T

Use with available fluent helpers to apply the to_CnsldtnProfitCenterT navigation property to query operations.

Constructor Detail

ProfitCenter

public ProfitCenter()

ProfitCenter

public ProfitCenter(@Nullable
                    String profitCenter,
                    @Nullable
                    String profitCenter_Text,
                    @Nullable
                    String controllingArea,
                    @Nullable
                    String additionalMasterDataSource,
                    List<ProfitCenterHier> toCnsldtnProfitCenterHier,
                    List<ProfitCenterText> toCnsldtnProfitCenterT)

Method Detail

getType

@Nonnull
public Class<ProfitCenter> getType()

Specified by:

getType in class VdmObject<ProfitCenter>

Returns:

The class of this object.

setProfitCenter

public void setProfitCenter(@Nullable
                            String profitCenter)

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

Original property name from the Odata EDM: ProfitCenter

Parameters:

profitCenter - Key which together with the controlling area uniquely identifies a profit center.

setProfitCenter_Text

public void setProfitCenter_Text(@Nullable
                                 String profitCenter_Text)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: ProfitCenter_Text

Parameters:

profitCenter_Text - Profit Center Description

setControllingArea

public void setControllingArea(@Nullable
                               String controllingArea)

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

Original property name from the Odata EDM: ControllingArea

The controlling area is the highest organizational unit in Controlling.Whether controlling area and company code are in a 1:1 relationship or a 1:n relationship, the number of posting periods in both controlling area and company code(s) must be identical. However, special periods may vary.

Parameters:

controllingArea - Uniquely identifies a controlling area.

setAdditionalMasterDataSource

public void setAdditionalMasterDataSource(@Nullable
                                          String additionalMasterDataSource)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Parameters:

additionalMasterDataSource - Master Data Source

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ProfitCenter>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ProfitCenter>

fromMap

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

Overrides:

fromMap in class VdmObject<ProfitCenter>

field

@Nonnull
public static <T> ProfitCenterField<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> ProfitCenterField<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<ProfitCenter>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<ProfitCenter>

fetchCnsldtnProfitCenterHier

@Nonnull
public List<ProfitCenterHier> fetchCnsldtnProfitCenterHier()
                                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the ProfitCenterHier entities (one to many) associated with this entity. This corresponds to the OData navigation property to_CnsldtnProfitCenterHier.

Please note: This method will not cache or persist the query results.

Returns:

List containing one or more associated ProfitCenterHier entities. If no entities are associated then an empty list is returned.

Throws:

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.

getCnsldtnProfitCenterHierOrFetch

@Nonnull
public List<ProfitCenterHier> getCnsldtnProfitCenterHierOrFetch()
                                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ProfitCenterHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnProfitCenterHier.

If the navigation property to_CnsldtnProfitCenterHier of a queried ProfitCenter 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.

Returns:

List of associated ProfitCenterHier entities.

Throws:

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.

getCnsldtnProfitCenterHierIfPresent

@Nonnull
public io.vavr.control.Option<List<ProfitCenterHier>> getCnsldtnProfitCenterHierIfPresent()

Retrieval of associated ProfitCenterHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnProfitCenterHier.

If the navigation property for an entity ProfitCenter has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_CnsldtnProfitCenterHier is already loaded, the result will contain the ProfitCenterHier entities. If not, an Option with result state empty is returned.

setCnsldtnProfitCenterHier

public void setCnsldtnProfitCenterHier(@Nonnull
                                       List<ProfitCenterHier> value)

Overwrites the list of associated ProfitCenterHier entities for the loaded navigation property to_CnsldtnProfitCenterHier.

If the navigation property to_CnsldtnProfitCenterHier of a queried ProfitCenter 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.

Parameters:

value - List of ProfitCenterHier entities.

addCnsldtnProfitCenterHier

public void addCnsldtnProfitCenterHier(ProfitCenterHier... entity)

Adds elements to the list of associated ProfitCenterHier entities. This corresponds to the OData navigation property to_CnsldtnProfitCenterHier.

If the navigation property to_CnsldtnProfitCenterHier of a queried ProfitCenter 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.

Parameters:

entity - Array of ProfitCenterHier entities.

fetchCnsldtnProfitCenterT

@Nonnull
public List<ProfitCenterText> fetchCnsldtnProfitCenterT()
                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the ProfitCenterText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_CnsldtnProfitCenterT.

Please note: This method will not cache or persist the query results.

Returns:

List containing one or more associated ProfitCenterText entities. If no entities are associated then an empty list is returned.

Throws:

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.

getCnsldtnProfitCenterTOrFetch

@Nonnull
public List<ProfitCenterText> getCnsldtnProfitCenterTOrFetch()
                                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ProfitCenterText entities (one to many). This corresponds to the OData navigation property to_CnsldtnProfitCenterT.

If the navigation property to_CnsldtnProfitCenterT of a queried ProfitCenter 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.

Returns:

List of associated ProfitCenterText entities.

Throws:

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.

getCnsldtnProfitCenterTIfPresent

@Nonnull
public io.vavr.control.Option<List<ProfitCenterText>> getCnsldtnProfitCenterTIfPresent()

Retrieval of associated ProfitCenterText entities (one to many). This corresponds to the OData navigation property to_CnsldtnProfitCenterT.

If the navigation property for an entity ProfitCenter has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_CnsldtnProfitCenterT is already loaded, the result will contain the ProfitCenterText entities. If not, an Option with result state empty is returned.

setCnsldtnProfitCenterT

public void setCnsldtnProfitCenterT(@Nonnull
                                    List<ProfitCenterText> value)

Overwrites the list of associated ProfitCenterText entities for the loaded navigation property to_CnsldtnProfitCenterT.

If the navigation property to_CnsldtnProfitCenterT of a queried ProfitCenter 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.

Parameters:

value - List of ProfitCenterText entities.

addCnsldtnProfitCenterT

public void addCnsldtnProfitCenterT(ProfitCenterText... entity)

Adds elements to the list of associated ProfitCenterText entities. This corresponds to the OData navigation property to_CnsldtnProfitCenterT.

If the navigation property to_CnsldtnProfitCenterT of a queried ProfitCenter 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.

Parameters:

entity - Array of ProfitCenterText entities.

builder

public static ProfitCenter.ProfitCenterBuilder builder()

getProfitCenter

@Nullable
public String getProfitCenter()

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

Original property name from the Odata EDM: ProfitCenter

Returns:

Key which together with the controlling area uniquely identifies a profit center.

getProfitCenter_Text

@Nullable
public String getProfitCenter_Text()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: ProfitCenter_Text

Returns:

Profit Center Description

getControllingArea

@Nullable
public String getControllingArea()

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

Original property name from the Odata EDM: ControllingArea

The controlling area is the highest organizational unit in Controlling.Whether controlling area and company code are in a 1:1 relationship or a 1:n relationship, the number of posting periods in both controlling area and company code(s) must be identical. However, special periods may vary.

Returns:

Uniquely identifies a controlling area.

getAdditionalMasterDataSource

@Nullable
public String getAdditionalMasterDataSource()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Returns:

Master Data Source

toString

public String toString()

Overrides:

toString in class VdmObject<ProfitCenter>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ProfitCenter>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ProfitCenter>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ProfitCenter>