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

Class PurchaseReqnItemText

java.lang.Object

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

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<PurchaseReqnItemText>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchaserequisition.PurchaseReqnItemText

public class PurchaseReqnItemText
extends VdmEntity<PurchaseReqnItemText>

Purchase Requisition Item Text

Original entity name from the Odata EDM: A_PurchaseReqnItemTextType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurchaseReqnItemText.PurchaseReqnItemTextBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static PurchaseReqnItemTextSelectable	ALL_FIELDS Selector for all available fields of PurchaseReqnItemText.
static PurchaseReqnItemTextField<String>	ARCH_OBJECT_NUMBER Use with available fluent helpers to apply the ArchObjectNumber field to query operations.
static PurchaseReqnItemTextField<String>	DOCUMENT_TEXT Use with available fluent helpers to apply the DocumentText field to query operations.
static PurchaseReqnItemTextField<String>	FIXED_INDICATOR Use with available fluent helpers to apply the FixedIndicator field to query operations.
static PurchaseReqnItemTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static PurchaseReqnItemTextField<String>	NOTE_DESCRIPTION Use with available fluent helpers to apply the NoteDescription field to query operations.
static PurchaseReqnItemTextField<String>	PURCHASE_REQUISITION Use with available fluent helpers to apply the PurchaseRequisition field to query operations.
static PurchaseReqnItemTextField<String>	PURCHASE_REQUISITION_ITEM Use with available fluent helpers to apply the PurchaseRequisitionItem field to query operations.
static PurchaseReqnItemTextField<String>	TECHNICAL_OBJECT_TYPE Use with available fluent helpers to apply the TechnicalObjectType field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
PurchaseReqnItemText()
PurchaseReqnItemText(String purchaseRequisition, String purchaseRequisitionItem, String documentText, String technicalObjectType, String language, String archObjectNumber, String noteDescription, String fixedIndicator)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static PurchaseReqnItemText.PurchaseReqnItemTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> PurchaseReqnItemTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> PurchaseReqnItemTextField<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	getArchObjectNumber() Constraints: Not nullable, Maximum length: 70
protected String	getDefaultServicePath()
String	getDocumentText() (Key Field) Constraints: Not nullable, Maximum length: 4
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getFixedIndicator() Constraints: Not nullable, Maximum length: 1
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getNoteDescription() Constraints: none
String	getPurchaseRequisition() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getPurchaseRequisitionItem() (Key Field) Constraints: Not nullable, Maximum length: 5
String	getTechnicalObjectType() (Key Field) Constraints: Not nullable, Maximum length: 10
Class<PurchaseReqnItemText>	getType()
int	hashCode()
void	setArchObjectNumber(String archObjectNumber) Constraints: Not nullable, Maximum length: 70
void	setDocumentText(String documentText) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setFixedIndicator(String fixedIndicator) Constraints: Not nullable, Maximum length: 1
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setNoteDescription(String noteDescription) Constraints: none
void	setPurchaseRequisition(String purchaseRequisition) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setPurchaseRequisitionItem(String purchaseRequisitionItem) (Key Field) Constraints: Not nullable, Maximum length: 5
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setTechnicalObjectType(String technicalObjectType) (Key Field) Constraints: Not nullable, Maximum length: 10
protected Map<String,Object>	toMapOfFields()
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

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

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FIELDS

public static final PurchaseReqnItemTextSelectable ALL_FIELDS

Selector for all available fields of PurchaseReqnItemText.

PURCHASE_REQUISITION

public static final PurchaseReqnItemTextField<String> PURCHASE_REQUISITION

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

PURCHASE_REQUISITION_ITEM

public static final PurchaseReqnItemTextField<String> PURCHASE_REQUISITION_ITEM

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

DOCUMENT_TEXT

public static final PurchaseReqnItemTextField<String> DOCUMENT_TEXT

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

TECHNICAL_OBJECT_TYPE

public static final PurchaseReqnItemTextField<String> TECHNICAL_OBJECT_TYPE

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

LANGUAGE

public static final PurchaseReqnItemTextField<String> LANGUAGE

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

ARCH_OBJECT_NUMBER

public static final PurchaseReqnItemTextField<String> ARCH_OBJECT_NUMBER

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

NOTE_DESCRIPTION

public static final PurchaseReqnItemTextField<String> NOTE_DESCRIPTION

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

FIXED_INDICATOR

public static final PurchaseReqnItemTextField<String> FIXED_INDICATOR

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

Constructor Detail

PurchaseReqnItemText

public PurchaseReqnItemText()

PurchaseReqnItemText

public PurchaseReqnItemText(@Nullable
                            String purchaseRequisition,
                            @Nullable
                            String purchaseRequisitionItem,
                            @Nullable
                            String documentText,
                            @Nullable
                            String technicalObjectType,
                            @Nullable
                            String language,
                            @Nullable
                            String archObjectNumber,
                            @Nullable
                            String noteDescription,
                            @Nullable
                            String fixedIndicator)

Method Detail

getType

@Nonnull
public Class<PurchaseReqnItemText> getType()

Specified by:

getType in class VdmObject<PurchaseReqnItemText>

Returns:

The class of this object.

setPurchaseRequisition

public void setPurchaseRequisition(@Nullable
                                   String purchaseRequisition)

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

Original property name from the Odata EDM: PurchaseRequisition

Parameters:

purchaseRequisition - Alphanumeric key uniquely identifying the document.

setPurchaseRequisitionItem

public void setPurchaseRequisitionItem(@Nullable
                                       String purchaseRequisitionItem)

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

Original property name from the Odata EDM: PurchaseRequisitionItem

Parameters:

purchaseRequisitionItem - Specifies the number that uniquely identifies an item in .

setDocumentText

public void setDocumentText(@Nullable
                            String documentText)

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

Original property name from the Odata EDM: DocumentText

ST for user-specific standard texts (individual texts)SYST for cross-application system textsvarious IDs for specific application departments. You must have the appropriate access authorization in order to access these texts.

Parameters:

documentText - The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

setTechnicalObjectType

public void setTechnicalObjectType(@Nullable
                                   String technicalObjectType)

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

Original property name from the Odata EDM: TechnicalObjectType

Parameters:

technicalObjectType - In business applications, a text is not considered an independent object. A text can only exist if it has a superior reference object. A material inspection text, for example, only exists if there is a corresponding material. The application object of a text is therefore the global environment in which a text exists.

setLanguage

public void setLanguage(@Nullable
                        String language)

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setArchObjectNumber

public void setArchObjectNumber(@Nullable
                                String archObjectNumber)

Constraints: Not nullable, Maximum length: 70

Original property name from the Odata EDM: ArchObjectNumber

Do not use the characters ',' or '*' in the text name or leave it blank.

Parameters:

archObjectNumber - This is the text name of a text. It can be a maximum of 70 characters in length. However, in specific text applications, only shorter names are usually allowed.

setNoteDescription

public void setNoteDescription(@Nullable
                               String noteDescription)

Constraints: none

Original property name from the Odata EDM: NoteDescription

Parameters:

noteDescription - Long Text

setFixedIndicator

public void setFixedIndicator(@Nullable
                              String fixedIndicator)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: FixedIndicator

You assign the "fixed" indicator to a text to specify whether:The text can be fixed (indicator "*")A text with the status "*" is then displayed in the document and can be adopted in the document if:You change the text and save the documentYou select the text and adopt it (Item -> Texts -> Adopt text)Until you adopt the text, changes in the master record will also be adopted in the text.The text is fixed (indicator " ")The text is copied into the document. Changes to the document text do not have any effect on the original text and changes to the original text have no effect on the document text.The text is not fixed (indicator "N")The text is only displayed in the document (i.e. it cannot be changed or printed).You specify the "fixed" indicator for each purchasing document in Customizing for Purchasing under Text Types and Copying Rules for Header Texts and Text Types and Copying Rules for Item Texts.You wish to adopt a delivery text from a requisition (status "*") in a purchase order. If you select and adopt the text, it acquires the status " " and can be printed.In Customizing for Purchasing under Messages -> Texts for Messages, you can specify for each purchasing document the sequence and priority in which the texts of a document are to be printed.

Parameters:

fixedIndicator - Determines whether a text from a master record or another document can be adopted in a document and processed further in that document.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<PurchaseReqnItemText>

getKey

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

Overrides:

getKey in class VdmObject<PurchaseReqnItemText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PurchaseReqnItemText>

fromMap

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

Overrides:

fromMap in class VdmObject<PurchaseReqnItemText>

field

@Nonnull
public static <T> PurchaseReqnItemTextField<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> PurchaseReqnItemTextField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<PurchaseReqnItemText>

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Overrides:

setErpConfigContext in class VdmEntity<PurchaseReqnItemText>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<PurchaseReqnItemText>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<PurchaseReqnItemText>

builder

public static PurchaseReqnItemText.PurchaseReqnItemTextBuilder builder()

getPurchaseRequisition

@Nullable
public String getPurchaseRequisition()

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

Original property name from the Odata EDM: PurchaseRequisition

Returns:

Alphanumeric key uniquely identifying the document.

getPurchaseRequisitionItem

@Nullable
public String getPurchaseRequisitionItem()

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

Original property name from the Odata EDM: PurchaseRequisitionItem

Returns:

Specifies the number that uniquely identifies an item in .

getDocumentText

@Nullable
public String getDocumentText()

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

Original property name from the Odata EDM: DocumentText

ST for user-specific standard texts (individual texts)SYST for cross-application system textsvarious IDs for specific application departments. You must have the appropriate access authorization in order to access these texts.

Returns:

The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs:

getTechnicalObjectType

@Nullable
public String getTechnicalObjectType()

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

Original property name from the Odata EDM: TechnicalObjectType

Returns:

In business applications, a text is not considered an independent object. A text can only exist if it has a superior reference object. A material inspection text, for example, only exists if there is a corresponding material. The application object of a text is therefore the global environment in which a text exists.

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getArchObjectNumber

@Nullable
public String getArchObjectNumber()

Constraints: Not nullable, Maximum length: 70

Original property name from the Odata EDM: ArchObjectNumber

Do not use the characters ',' or '*' in the text name or leave it blank.

Returns:

This is the text name of a text. It can be a maximum of 70 characters in length. However, in specific text applications, only shorter names are usually allowed.

getNoteDescription

@Nullable
public String getNoteDescription()

Constraints: none

Original property name from the Odata EDM: NoteDescription

Returns:

Long Text

getFixedIndicator

@Nullable
public String getFixedIndicator()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: FixedIndicator

You assign the "fixed" indicator to a text to specify whether:The text can be fixed (indicator "*")A text with the status "*" is then displayed in the document and can be adopted in the document if:You change the text and save the documentYou select the text and adopt it (Item -> Texts -> Adopt text)Until you adopt the text, changes in the master record will also be adopted in the text.The text is fixed (indicator " ")The text is copied into the document. Changes to the document text do not have any effect on the original text and changes to the original text have no effect on the document text.The text is not fixed (indicator "N")The text is only displayed in the document (i.e. it cannot be changed or printed).You specify the "fixed" indicator for each purchasing document in Customizing for Purchasing under Text Types and Copying Rules for Header Texts and Text Types and Copying Rules for Item Texts.You wish to adopt a delivery text from a requisition (status "*") in a purchase order. If you select and adopt the text, it acquires the status " " and can be printed.In Customizing for Purchasing under Messages -> Texts for Messages, you can specify for each purchasing document the sequence and priority in which the texts of a document are to be printed.

Returns:

Determines whether a text from a master record or another document can be adopted in a document and processed further in that document.

toString

public String toString()

Overrides:

toString in class VdmObject<PurchaseReqnItemText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<PurchaseReqnItemText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<PurchaseReqnItemText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PurchaseReqnItemText>