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

Class DocumentInfoRecordDocStsVH

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.DocumentInfoRecordDocStsVH

public class DocumentInfoRecordDocStsVH
extends VdmEntity<DocumentInfoRecordDocStsVH>

Document Info Record Status Value help

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentInfoRecordDocStsVH.DocumentInfoRecordDocStsVHBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentInfoRecordDocStsVHSelectable	ALL_FIELDS Selector for all available fields of DocumentInfoRecordDocStsVH.
static DocumentInfoRecordDocStsVHField<String>	DOCUMENT_INFO_RECORD_DOC_TYPE Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.
static DocumentInfoRecordDocStsVHField<String>	DOCUMENT_STATUS_NAME Use with available fluent helpers to apply the DocumentStatusName field to query operations.
static DocumentInfoRecordDocStsVHField<String>	EXTERNAL_DOCUMENT_STATUS Use with available fluent helpers to apply the ExternalDocumentStatus field to query operations.
static DocumentInfoRecordDocStsVHField<String>	INTERNAL_DOCUMENT_STATUS Use with available fluent helpers to apply the InternalDocumentStatus field to query operations.
static DocumentInfoRecordDocStsVHField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.

Constructor Summary

Constructors

Constructor and Description
DocumentInfoRecordDocStsVH()
DocumentInfoRecordDocStsVH(String documentInfoRecordDocType, String language, String externalDocumentStatus, String internalDocumentStatus, String documentStatusName, ErpConfigContext erpConfigContext)

Method Summary

Modifier and Type	Method and Description
static DocumentInfoRecordDocStsVH.DocumentInfoRecordDocStsVHBuilder	builder()
boolean	equals(Object o)
static <T> DocumentInfoRecordDocStsVHField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getDocumentInfoRecordDocType() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getDocumentStatusName() Constraints: Not nullable, Maximum length: 16
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
String	getExternalDocumentStatus() (Key Field) Constraints: Not nullable, Maximum length: 2 If a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.
String	getInternalDocumentStatus() Constraints: Not nullable, Maximum length: 2 For each document type, you can define a status network in which one or more previous statuses are defined for a status.
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2 During processing, you can switch to all languages allowed in the SAP System.
Class<DocumentInfoRecordDocStsVH>	getType()
int	hashCode()
void	setDocumentInfoRecordDocType(String documentInfoRecordDocType) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setDocumentStatusName(String documentStatusName) Constraints: Not nullable, Maximum length: 16
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setExternalDocumentStatus(String externalDocumentStatus) (Key Field) Constraints: Not nullable, Maximum length: 2 If a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.
void	setInternalDocumentStatus(String internalDocumentStatus) Constraints: Not nullable, Maximum length: 2 For each document type, you can define a status network in which one or more previous statuses are defined for a status.
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2 During processing, you can switch to all languages allowed in the SAP System.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final DocumentInfoRecordDocStsVHSelectable ALL_FIELDS

Selector for all available fields of DocumentInfoRecordDocStsVH.

DOCUMENT_INFO_RECORD_DOC_TYPE

public static final DocumentInfoRecordDocStsVHField<String> DOCUMENT_INFO_RECORD_DOC_TYPE

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

LANGUAGE

public static final DocumentInfoRecordDocStsVHField<String> LANGUAGE

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

EXTERNAL_DOCUMENT_STATUS

public static final DocumentInfoRecordDocStsVHField<String> EXTERNAL_DOCUMENT_STATUS

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

INTERNAL_DOCUMENT_STATUS

public static final DocumentInfoRecordDocStsVHField<String> INTERNAL_DOCUMENT_STATUS

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

DOCUMENT_STATUS_NAME

public static final DocumentInfoRecordDocStsVHField<String> DOCUMENT_STATUS_NAME

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

Constructor Detail

DocumentInfoRecordDocStsVH

public DocumentInfoRecordDocStsVH()

DocumentInfoRecordDocStsVH

public DocumentInfoRecordDocStsVH(@Nullable
                                  String documentInfoRecordDocType,
                                  @Nullable
                                  String language,
                                  @Nullable
                                  String externalDocumentStatus,
                                  @Nullable
                                  String internalDocumentStatus,
                                  @Nullable
                                  String documentStatusName,
                                  @Nullable
                                  ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<DocumentInfoRecordDocStsVH> getType()

Specified by:

getType in class VdmObject<DocumentInfoRecordDocStsVH>

Returns:

The class of this object.

field

public static <T> DocumentInfoRecordDocStsVHField<T> field(String fieldName,
                                                           Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

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.

builder

public static DocumentInfoRecordDocStsVH.DocumentInfoRecordDocStsVHBuilder builder()

getDocumentInfoRecordDocType

@Nullable
public String getDocumentInfoRecordDocType()

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

Returns:

Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them.

getLanguage

@Nullable
public String getLanguage()

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

During processing, you can switch to all languages allowed in the SAP System. You can even make an entry in this field when displaying a document.The default is always the language key of the logon language.If the field Description has been defined as a required field via Customizing (Document management), this only applies to your logon language. If you change to another language, the field Description becomes an optional field.

Returns:

Key for the language in which you want to maintain the text.

getExternalDocumentStatus

@Nullable
public String getExternalDocumentStatus()

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

If a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.

Returns:

This key shows the document status.

getInternalDocumentStatus

@Nullable
public String getInternalDocumentStatus()

Constraints: Not nullable, Maximum length: 2

For each document type, you can define a status network in which one or more previous statuses are defined for a status. You can display the current possible entries (language-dependent) in any processing situation.When you set a new status, the system checks whether the current status is one of the possible previous statuses.When you set a status, the system checks your authorization.

Returns:

Key which represents the current document status.

getDocumentStatusName

@Nullable
public String getDocumentStatusName()

Constraints: Not nullable, Maximum length: 16

Returns:

Description of the current document status.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

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

Returns:

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

setDocumentInfoRecordDocType

public void setDocumentInfoRecordDocType(@Nullable
                                         String documentInfoRecordDocType)

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

Parameters:

documentInfoRecordDocType -

setLanguage

public void setLanguage(@Nullable
                        String language)

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

During processing, you can switch to all languages allowed in the SAP System. You can even make an entry in this field when displaying a document.The default is always the language key of the logon language.If the field Description has been defined as a required field via Customizing (Document management), this only applies to your logon language. If you change to another language, the field Description becomes an optional field.

Parameters:

language -

setExternalDocumentStatus

public void setExternalDocumentStatus(@Nullable
                                      String externalDocumentStatus)

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

If a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.

Parameters:

externalDocumentStatus -

setInternalDocumentStatus

public void setInternalDocumentStatus(@Nullable
                                      String internalDocumentStatus)

Constraints: Not nullable, Maximum length: 2

For each document type, you can define a status network in which one or more previous statuses are defined for a status. You can display the current possible entries (language-dependent) in any processing situation.When you set a new status, the system checks whether the current status is one of the possible previous statuses.When you set a status, the system checks your authorization.

Parameters:

internalDocumentStatus -

setDocumentStatusName

public void setDocumentStatusName(@Nullable
                                  String documentStatusName)

Constraints: Not nullable, Maximum length: 16

Parameters:

documentStatusName -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

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

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<DocumentInfoRecordDocStsVH>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<DocumentInfoRecordDocStsVH>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<DocumentInfoRecordDocStsVH>