A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.
The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".
Plant. Maximum length: 4.
Formula GUID.
Recipe ID. Maximum length: 20.
Alternative Recipe Identifier. Maximum length: 3.
Authorization Group for Recipes. With authorization groups, the access rights of users to recipes can be restricted. Not all users may be allowed to see all recipes. Normally, users are allowed to see certain groups of recipes, perhaps the ones from their lab, the ones dealing with their chemical compound, and so on. This authorization group is used to facilitate giving groups of people access to groups of recipes.The authorization group can be freely defined in Customizing and can then be assigned to each recipe.Authorization groups can be used in combination with Access Control Management (ACM).Use the authorization group logic for static authorizations that reflect the larger organizational set-up within your company. For more dynamic assignments of authorizations, use the Access Control Management logic in recipe development.You can use different authorization groups for specifications and for recipes, or you can assign the same authorization group for specifications and recipes. If you choose the same authorization groups, you only define the authorization group once in Customizing and then assign both specification types (specification and recipes) to this authorization group.For Recipe Development that operates in a Web UI you have to select RECIPE_WUI as the relevant specification type. Maximum length: 10.
User Who Created Object (Item). Maximum length: 12.
UTC Time Stamp in Short Form (YYYYMMDDhhmmss).
Marked for Archiving.
Marked for Deletion.
UTC Time Stamp in Short Form (YYYYMMDDhhmmss).
User Who Last Changed Object. Maximum length: 12.
Recipe Authorization Group. Maximum length: 10.
Specification Type. Maximum length: 10.
Primary Output ID. Maximum length: 12.
Specification Key. Maximum length: 20.
Process GUID.
Recipe Purpose. Maximum length: 5.
Status. Maximum length: 20.
Status Scheme. The status scheme defines the initial status and the possible transitions from one status to another. You define a status scheme in Customizing for Recipe Development under Status Management -> Define Status Scheme. Maximum length: 20.
Recipe Type. Maximum length: 20.
Recipe GUID in character format used in FRW linkage. Maximum length: 70.
Common Recipe GUID.
Recipe Description. Maximum length: 132.
Valid-To Date of a Recipe.
Quantity To.
Quantity From.
Valid-From Date of a Recipe.
Unit of Measure. Maximum length: 3.
Recipe Version. Maximum length: 3.
The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.
One-to-many navigation property to the RecipeCharc entity.
One-to-many navigation property to the RecipeClass entity.
One-to-many navigation property to the RecipeFormulaItem entity.
One-to-many navigation property to the RecipeProcessElement entity.
One-to-many navigation property to the RecipeProcessEquipRqmt entity.
One-to-many navigation property to the RecipeProcessParamValue entity.
One-to-many navigation property to the RecipeText entity.
ETag version identifier accessor.
All fields selector.
Static representation of the plant property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the rcpFmlaUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipe property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeAlternativeNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeAuthorizationGroup property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeCreatedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeCreationDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeIsArchived property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeIsDeleted property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeLastChangedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeLastChangeDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipePrimaryOutput property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipePrimaryOutputInternalId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipePrimOutpAuthznGrp property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipePrimOutpSpecType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeProcessUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipePurpose property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeStatusSchema property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeUniqueId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeUuidText property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeValidityEndDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeValidityMaxQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeValidityMinQuantity property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeValidityStartDate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeValidityUnit property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the recipeVersionNumber property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toCharacteristics for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toClassification for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toFormulaItem for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toRecipeProcessElement for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toRecipeProcessEquipRqmt for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toRecipeProcessParamValue for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toRecipeText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the Recipe entity.
Default url path for the according service.
Technical entity name for Recipe.
All key fields of the Recipe entity.
Mapping of all key field names to the respective static field property Recipe.
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances Recipe
.
A builder that constructs instances of entity type Recipe
.
Returns a selectable object that allows the selection of custom field in a get request for the entity Recipe
.
Name of the custom field to select
A builder that constructs instances of entity type Recipe
.
Returns a request builder to construct requests for operations on the Recipe
entity type.
A Recipe
request builder.
This class represents the entity "A_Recipe" of service "API_RECIPE". This service is part of the following communication scenarios: Product Lifecycle Management - Recipe Development Integration (SAP_COM_0136). See https://api.sap.com/api/API_RECIPE for more information.