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

Class CostCenter

java.lang.Object

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

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

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

public class CostCenter
extends VdmEntity<CostCenter>

Consolidation - Combined Cost Center

Original entity name from the Odata EDM: CostCenterType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CostCenterField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static CostCenterSelectable	ALL_FIELDS Selector for all available fields of CostCenter.
static CostCenterField<String>	CONTROLLING_AREA Use with available fluent helpers to apply the ControllingArea field to query operations.
static CostCenterField<String>	COST_CENTER Use with available fluent helpers to apply the CostCenter field to query operations.
static CostCenterField<String>	COST_CENTER_TEXT Use with available fluent helpers to apply the CostCenter_Text field to query operations.
static CostCenterLink<CostCenterHier>	TO_CNSLDTN_COST_CENTER_HIER Use with available fluent helpers to apply the to_CnsldtnCostCenterHier navigation property to query operations.
static CostCenterLink<CostCenterText>	TO_CNSLDTN_COST_CENTER_T Use with available fluent helpers to apply the to_CnsldtnCostCenterT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
CostCenter()
CostCenter(String costCenter, String costCenter_Text, String controllingArea, String additionalMasterDataSource, List<CostCenterHier> toCnsldtnCostCenterHier, List<CostCenterText> toCnsldtnCostCenterT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnCostCenterHier(CostCenterHier... entity) Adds elements to the list of associated CostCenterHier entities.
void	addCnsldtnCostCenterT(CostCenterText... entity) Adds elements to the list of associated CostCenterText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static CostCenter.CostCenterBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<CostCenterHier>	fetchCnsldtnCostCenterHier() Fetches the CostCenterHier entities (one to many) associated with this entity.
List<CostCenterText>	fetchCnsldtnCostCenterT() Fetches the CostCenterText entities (one to many) associated with this entity.
static <T> CostCenterField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CostCenterField<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<CostCenterHier>>	getCnsldtnCostCenterHierIfPresent() Retrieval of associated CostCenterHier entities (one to many).
List<CostCenterHier>	getCnsldtnCostCenterHierOrFetch() Retrieval of associated CostCenterHier entities (one to many).
io.vavr.control.Option<List<CostCenterText>>	getCnsldtnCostCenterTIfPresent() Retrieval of associated CostCenterText entities (one to many).
List<CostCenterText>	getCnsldtnCostCenterTOrFetch() Retrieval of associated CostCenterText entities (one to many).
String	getControllingArea() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getCostCenter_Text() Constraints: Not nullable, Maximum length: 20
String	getCostCenter() (Key Field) Constraints: Not nullable, Maximum length: 10
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()
Class<CostCenter>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnCostCenterHier(List<CostCenterHier> value) Overwrites the list of associated CostCenterHier entities for the loaded navigation property to_CnsldtnCostCenterHier.
void	setCnsldtnCostCenterT(List<CostCenterText> value) Overwrites the list of associated CostCenterText entities for the loaded navigation property to_CnsldtnCostCenterT.
void	setControllingArea(String controllingArea) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setCostCenter_Text(String costCenter_Text) Constraints: Not nullable, Maximum length: 20
void	setCostCenter(String costCenter) (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 CostCenterSelectable ALL_FIELDS

Selector for all available fields of CostCenter.

COST_CENTER

public static final CostCenterField<String> COST_CENTER

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

COST_CENTER_TEXT

public static final CostCenterField<String> COST_CENTER_TEXT

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

CONTROLLING_AREA

public static final CostCenterField<String> CONTROLLING_AREA

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final CostCenterField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_COST_CENTER_HIER

public static final CostCenterLink<CostCenterHier> TO_CNSLDTN_COST_CENTER_HIER

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

TO_CNSLDTN_COST_CENTER_T

public static final CostCenterLink<CostCenterText> TO_CNSLDTN_COST_CENTER_T

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

Constructor Detail

CostCenter

public CostCenter()

CostCenter

public CostCenter(@Nullable
                  String costCenter,
                  @Nullable
                  String costCenter_Text,
                  @Nullable
                  String controllingArea,
                  @Nullable
                  String additionalMasterDataSource,
                  List<CostCenterHier> toCnsldtnCostCenterHier,
                  List<CostCenterText> toCnsldtnCostCenterT)

Method Detail

getType

@Nonnull
public Class<CostCenter> getType()

Specified by:

getType in class VdmObject<CostCenter>

Returns:

The class of this object.

setCostCenter

public void setCostCenter(@Nullable
                          String costCenter)

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

Original property name from the Odata EDM: CostCenter

Parameters:

costCenter - A key that uniquely identifies a cost center.

setCostCenter_Text

public void setCostCenter_Text(@Nullable
                               String costCenter_Text)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: CostCenter_Text

Parameters:

costCenter_Text - Cost 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<CostCenter>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<CostCenter>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<CostCenter>

fromMap

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

Overrides:

fromMap in class VdmObject<CostCenter>

field

@Nonnull
public static <T> CostCenterField<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> CostCenterField<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<CostCenter>

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

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

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

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

fetchCnsldtnCostCenterHier

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

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

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

Returns:

List containing one or more associated CostCenterHier 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.

getCnsldtnCostCenterHierOrFetch

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

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

If the navigation property to_CnsldtnCostCenterHier of a queried CostCenter 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 CostCenterHier 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.

getCnsldtnCostCenterHierIfPresent

@Nonnull
public io.vavr.control.Option<List<CostCenterHier>> getCnsldtnCostCenterHierIfPresent()

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

If the navigation property for an entity CostCenter 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_CnsldtnCostCenterHier is already loaded, the result will contain the CostCenterHier entities. If not, an Option with result state empty is returned.

setCnsldtnCostCenterHier

public void setCnsldtnCostCenterHier(@Nonnull
                                     List<CostCenterHier> value)

Overwrites the list of associated CostCenterHier entities for the loaded navigation property to_CnsldtnCostCenterHier.

If the navigation property to_CnsldtnCostCenterHier of a queried CostCenter 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 CostCenterHier entities.

addCnsldtnCostCenterHier

public void addCnsldtnCostCenterHier(CostCenterHier... entity)

Adds elements to the list of associated CostCenterHier entities. This corresponds to the OData navigation property to_CnsldtnCostCenterHier.

If the navigation property to_CnsldtnCostCenterHier of a queried CostCenter 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 CostCenterHier entities.

fetchCnsldtnCostCenterT

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

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

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

Returns:

List containing one or more associated CostCenterText 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.

getCnsldtnCostCenterTOrFetch

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

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

If the navigation property to_CnsldtnCostCenterT of a queried CostCenter 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 CostCenterText 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.

getCnsldtnCostCenterTIfPresent

@Nonnull
public io.vavr.control.Option<List<CostCenterText>> getCnsldtnCostCenterTIfPresent()

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

If the navigation property for an entity CostCenter 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_CnsldtnCostCenterT is already loaded, the result will contain the CostCenterText entities. If not, an Option with result state empty is returned.

setCnsldtnCostCenterT

public void setCnsldtnCostCenterT(@Nonnull
                                  List<CostCenterText> value)

Overwrites the list of associated CostCenterText entities for the loaded navigation property to_CnsldtnCostCenterT.

If the navigation property to_CnsldtnCostCenterT of a queried CostCenter 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 CostCenterText entities.

addCnsldtnCostCenterT

public void addCnsldtnCostCenterT(CostCenterText... entity)

Adds elements to the list of associated CostCenterText entities. This corresponds to the OData navigation property to_CnsldtnCostCenterT.

If the navigation property to_CnsldtnCostCenterT of a queried CostCenter 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 CostCenterText entities.

builder

public static CostCenter.CostCenterBuilder builder()

getCostCenter

@Nullable
public String getCostCenter()

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

Original property name from the Odata EDM: CostCenter

Returns:

A key that uniquely identifies a cost center.

getCostCenter_Text

@Nullable
public String getCostCenter_Text()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: CostCenter_Text

Returns:

Cost 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<CostCenter>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<CostCenter>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<CostCenter>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<CostCenter>