Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Interface RealEstateOccupancyService

All Known Implementing Classes:

DefaultRealEstateOccupancyService

@Deprecated
public interface RealEstateOccupancyService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service provides the possibility to get occupancy related information on Real Estate objects for a specific key date as well as over its entire timeline. The service only supports read operations. If there are any issues during processing, the system displays error messages in the response..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	CE_REOCCUPANCY_0001
API Version:	1.0.1
Minimum ERP Version:	2302
Communication Scenario:	SAP Real Estate Master Data Integration(SAP_COM_0697)
Scope Items:	Enable for Use and Contract Management(5VX), External Occupancy and Contract Management(5VY), Internal Occupancy and Cost Allocation(5VZ), Intercompany Occupancy and Contract Management(5W0), Enable for Use and Contract Management(OVX), External Occupancy and Contract Management(OVY), Internal Occupancy and Cost Allocation(OVZ), Intercompany Occupancy and Contract Management(OW0)
Authentication Methods:	x509
Service Group Name:	API_RE_OCCUPANCY
Business Object:	Real Estate Integration Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE_PATH	Deprecated. If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<REOccupancy>	countREOccupancy()	Deprecated. Fetch the number of entries from the REOccupancy entity collection matching the filter and search expressions.
GetAllRequestBuilder<REOccupancy>	getAllREOccupancy()	Deprecated. Fetch multiple REOccupancy entities.
GetByKeyRequestBuilder<REOccupancy>	getREOccupancyByKey(String companyCode, String realEstateExternalID, String rEInternalNumberForOccupancy, LocalDate validityEndDate)	Deprecated. Fetch a single REOccupancy entity using key fields.
RealEstateOccupancyService	withServicePath(String servicePath)	Deprecated. Overrides the default service path and returns a new service instance with the specified service path.

Field Details

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

Deprecated.

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

• Constant Field Values

Method Details

withServicePath

@Nonnull
RealEstateOccupancyService withServicePath(@Nonnull
 String servicePath)

Deprecated.

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
BatchRequestBuilder batch()

Deprecated.

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllREOccupancy

@Nonnull
GetAllRequestBuilder<REOccupancy> getAllREOccupancy()

Deprecated.

Fetch multiple REOccupancy entities.

Returns:

A request builder to fetch multiple REOccupancy entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countREOccupancy

@Nonnull
CountRequestBuilder<REOccupancy> countREOccupancy()

Deprecated.

Fetch the number of entries from the REOccupancy entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of REOccupancy entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getREOccupancyByKey

@Nonnull
GetByKeyRequestBuilder<REOccupancy> getREOccupancyByKey(String companyCode,
 String realEstateExternalID,
 String rEInternalNumberForOccupancy,
 LocalDate validityEndDate)

Deprecated.

Fetch a single REOccupancy entity using key fields.

Parameters:

companyCode - Company Code

Constraints: Not nullable, Maximum length: 4

rEInternalNumberForOccupancy - Internal Key of Real Estate Object

Constraints: Not nullable, Maximum length: 13

realEstateExternalID - Integration Object Space - External Identification

Constraints: Not nullable, Maximum length: 45

validityEndDate - Validity End Date

Constraints: Not nullable

Returns:

A request builder to fetch a single REOccupancy entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.