com.sap.cloud.sdk.s4hana.datamodel.odata.services.ChangeMasterService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDateByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmtByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmtFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.batch.ChangeMasterServiceBatch;
/**
*
* This service enables you to read change masters.
*
*
*
* Reference:
* SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_CHANGEMASTER
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Product Lifecycle Management - Master Data Integration (SAP_COM_0105)
*
*
* Scope Items:
* Engineering Bill of Material - Versions Management (1NR),
* Engineering Bill of Material - Change Master Management
* (1R3)
*
*
* Authentication Methods:
* Basic, x509
*
*
* Business Object:
* ChangeMaster
*
*
*
*/
public interface ChangeMasterService extends BatchService
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_CHANGEMASTER";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
ChangeMasterService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMaster ChangeMaster}
* entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMaster ChangeMaster}
* entities. This fluent helper allows methods which modify the underlying query to be called before
* executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterFluentHelper getAllChangeMaster();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMaster ChangeMaster}
* entity using key fields.
*
* @param changeNumber
* Number used to uniquely identify a change master record.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMaster ChangeMaster} entity
* using key fields. This fluent helper allows methods which modify the underlying query to be called before
* executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterByKeyFluentHelper getChangeMasterByKey( final String changeNumber );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDate
* ChangeMasterAltDate} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDate
* ChangeMasterAltDate} entities. This fluent helper allows methods which modify the underlying query to be
* called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterAltDateFluentHelper getAllChangeMasterAltDate();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDate
* ChangeMasterAltDate} entity using key fields.
*
* @param chgNmbrAlternativeDateCounter
* Engineering change management: alternative date counter
*
* Constraints: Not nullable, Maximum length: 3
*
* @param changeNumber
* Number used to uniquely identify a change master record.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDate
* ChangeMasterAltDate} entity using key fields. This fluent helper allows methods which modify the
* underlying query to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterAltDateByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterAltDateByKeyFluentHelper
getChangeMasterAltDateByKey( final String changeNumber, final String chgNmbrAlternativeDateCounter );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectType
* ChangeMasterObjectType} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectType
* ChangeMasterObjectType} entities. This fluent helper allows methods which modify the underlying query to
* be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterObjectTypeFluentHelper getAllChangeMasterObjectType();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectType
* ChangeMasterObjectType} entity using key fields.
*
* @param changeNumberObjectType
* Categorization of change objects (such as material BOM, document structure, routing, material)
* according to their distinguishing features.
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectType
* ChangeMasterObjectType} entity using key fields. This fluent helper allows methods which modify the
* underlying query to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterObjectTypeByKeyFluentHelper getChangeMasterObjectTypeByKey( final String changeNumberObjectType );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeText
* ChangeMasterObjectTypeText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeText
* ChangeMasterObjectTypeText} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterObjectTypeTextFluentHelper getAllChangeMasterObjectTypeText();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeText
* ChangeMasterObjectTypeText} entity using key fields.
*
* @param changeNumberObjectType
* Categorization of change objects (such as material BOM, document structure, routing, material)
* according to their distinguishing features.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeText
* ChangeMasterObjectTypeText} entity using key fields. This fluent helper allows methods which modify the
* underlying query to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjectTypeTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterObjectTypeTextByKeyFluentHelper
getChangeMasterObjectTypeTextByKey( final String changeNumberObjectType, final String language );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmt
* ChangeMasterObjTypeAssgmt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmt
* ChangeMasterObjTypeAssgmt} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmtFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterObjTypeAssgmtFluentHelper getAllChangeMasterObjTypeAssgmt();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmt
* ChangeMasterObjTypeAssgmt} entity using key fields.
*
* @param changeNumberObjectType
* Categorization of change objects (such as material BOM, document structure, routing, material)
* according to their distinguishing features.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param changeNumber
* Number used to uniquely identify a change master record.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmt
* ChangeMasterObjTypeAssgmt} entity using key fields. This fluent helper allows methods which modify the
* underlying query to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterObjTypeAssgmtByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterObjTypeAssgmtByKeyFluentHelper
getChangeMasterObjTypeAssgmtByKey( final String changeNumber, final String changeNumberObjectType );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatus
* ChangeMasterStatus} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatus
* ChangeMasterStatus} entities. This fluent helper allows methods which modify the underlying query to be
* called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterStatusFluentHelper getAllChangeMasterStatus();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatus
* ChangeMasterStatus} entity using key fields.
*
* @param changeNumberStatus
* Status of Change Number
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatus
* ChangeMasterStatus} entity using key fields. This fluent helper allows methods which modify the
* underlying query to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterStatusByKeyFluentHelper getChangeMasterStatusByKey( final String changeNumberStatus );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusText
* ChangeMasterStatusText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusText
* ChangeMasterStatusText} entities. This fluent helper allows methods which modify the underlying query to
* be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterStatusTextFluentHelper getAllChangeMasterStatusText();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusText
* ChangeMasterStatusText} entity using key fields.
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @param changeNumberStatus
* Status of Change Number
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusText
* ChangeMasterStatusText} entity using key fields. This fluent helper allows methods which modify the
* underlying query to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.changemaster.ChangeMasterStatusTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ChangeMasterStatusTextByKeyFluentHelper
getChangeMasterStatusTextByKey( final String changeNumberStatus, final String language );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy