DocumentInfoRecordFluentHelper (SAP S/4HANA Cloud SDK

java.lang.Object
- com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.DocumentInfoRecordFluentHelper

```
public class DocumentInfoRecordFluentHelper
extends Object
```
Fluent helper to fetch multiple DocumentInfoRecord entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself.

Constructor Summary

Constructors
Constructor and Description

DocumentInfoRecordFluentHelper()
Creates a fluent helper object that will fetch multiple DocumentInfoRecord entities.

Constructors
Constructor and Description
`DocumentInfoRecordFluentHelper()` Creates a fluent helper object that will fetch multiple `DocumentInfoRecord` entities.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<DocumentInfoRecord>`	`execute()` Executes the underlying query using any query modifiers that were previously called.
`List<DocumentInfoRecord>`	`execute(ErpConfigContext erpConfigContext)` Executes the underlying query using any query modifiers that were previously called.
`List<DocumentInfoRecord>`	`execute(ErpEndpoint erpEndpoint)` Executes the underlying query using any query modifiers that were previously called.
`DocumentInfoRecordFluentHelper`	`filter(ExpressionFluentHelper<DocumentInfoRecord> expression)` Query modifier to restrict the set of returned entities based on the values of one or more fields.
`DocumentInfoRecordFluentHelper`	`orderBy(EntityField<DocumentInfoRecord,?> field, Order order)` Query modifier to sort the set of returned entities by one or more fields.
`DocumentInfoRecordFluentHelper`	`select(EntityField<DocumentInfoRecord,?>... fields)` Query modifier to limit which field values within an entity get fetched & populated.
`DocumentInfoRecordFluentHelper`	`skip(Number skip)` Query modifier to not return the first N entities of the result set.
`DocumentInfoRecordFluentHelper`	`top(Number top)` Query modifier to limit the number of entities returned.
`com.sap.cloud.sdk.odatav2.connectivity.ODataQuery`	`toQuery()` Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by the virtual data model.
`DocumentInfoRecordFluentHelper`	`withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)` An error handling class that implements the `ErrorResultHandler` interface can be attached to this fluent helper.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentInfoRecordFluentHelper
```
public DocumentInfoRecordFluentHelper()
```
    Creates a fluent helper object that will fetch multiple DocumentInfoRecord entities. To perform execution, call the execute method on the fluent helper object.
- Method Detail
  - filter
```
public DocumentInfoRecordFluentHelper filter(ExpressionFluentHelper<DocumentInfoRecord> expression)
```
    Query modifier to restrict the set of returned entities based on the values of one or more fields. If this method is never called, then all accessible entities will be fetched. Calling this multiple times will combine the filters into one that is the intersection of all filters (filter1 AND filter2 AND ... filterN).
    
    Parameters:
    
    expression - Fluent helper that represents a field value expression. To create this, start with an EntityField constant in DocumentInfoRecord for the desired entity field. Then call one of the comparison operators and provide a comparison value. Optionally the resulting fluent helper can be chained with other expression fluent helpers.
    
    Returns:
    
    The same fluent helper with this query modifier applied.
  - orderBy
```
public DocumentInfoRecordFluentHelper orderBy(EntityField<DocumentInfoRecord,?> field,
                                              Order order)
```
    Query modifier to sort the set of returned entities by one or more fields. If this method is called more than once, then the result entity set will be sorted by each field in the order that the methods were called.
    
    Parameters:
    
    field - Field to sort by. See DocumentInfoRecord for available fields.
    
    order - Sorting direction to use (ascending or descending).
    
    Returns:
    
    The same fluent helper with this query modifier applied.
  - select
```
public DocumentInfoRecordFluentHelper select(EntityField<DocumentInfoRecord,?>... fields)
```
    Query modifier to limit which field values within an entity get fetched & populated. If this method is never called, then all fields will be fetched & populated. But if this method is called at least once, then only the specified fields will be fetched & populated. Calling this multiple times will combine the set(s) of fields of each call.
    
    Parameters:
    
    fields - Fields to fetch & populate. See DocumentInfoRecord for available fields.
    
    Returns:
    
    The same fluent helper with this query modifier applied.
  - top
```
public DocumentInfoRecordFluentHelper top(Number top)
```
    Query modifier to limit the number of entities returned. If this method is never called, then the result entity list will not be limited in size. If this method is called multiple times, then only the value of the last call will be used.
    
    Parameters:
    
    top - Number of entities to limit the result set to.
    
    Returns:
    
    The same fluent helper with this query modifier applied.
  - skip
```
public DocumentInfoRecordFluentHelper skip(Number skip)
```
    Query modifier to not return the first N entities of the result set. If this method is never called, then the full list will be returned from the first entity. If this method is called multiple times, then only the value of the last call will be used.
    
    Parameters:
    
    skip - Number of entities to skip by.
    
    Returns:
    
    The same fluent helper with this query modifier applied.
  - withErrorHandler
```
public DocumentInfoRecordFluentHelper withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)
```
    An error handling class that implements the ErrorResultHandler interface can be attached to this fluent helper. This allows custom logic to be called when an error occurs in the execute method. If this method is not called, then an instance of ODataVdmErrorResultHandler is used. Only one handler can be attached at a time per fluent helper object, so calling this multiple times will replace the handler.
    
    Parameters:
    
    errorResultHandler - Instance of an error handler class that implements the ErrorResultHandler interface.
    
    Returns:
    
    The same fluent helper with its error handler set to the provided object.
  - toQuery
```
public com.sap.cloud.sdk.odatav2.connectivity.ODataQuery toQuery()
```
    Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by the virtual data model.
    
    Returns:
    
    The underlying query object.
  - execute
```
public List<DocumentInfoRecord> execute(ErpEndpoint erpEndpoint)
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Executes the underlying query using any query modifiers that were previously called.
    
    Parameters:
    
    erpEndpoint - Supply the ERP system instance for executing the underlying OData query.
    
    Returns:
    
    A collection of DocumentInfoRecord entities if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException
    
    See Also:
    
    ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)
  - execute
```
public List<DocumentInfoRecord> execute(ErpConfigContext erpConfigContext)
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Executes the underlying query using any query modifiers that were previously called.
    
    Parameters:
    
    erpConfigContext - Supply the ERP system context for executing the underlying OData query.
    
    Returns:
    
    A collection of DocumentInfoRecord entities if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException
    
    See Also:
    
    ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)
  - execute
```
public List<DocumentInfoRecord> execute()
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Executes the underlying query using any query modifiers that were previously called.
    The default ERP configuration context will be used.
    
    Returns:
    
    A collection of DocumentInfoRecord entities if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown.
    
    Throws:
    
    com.sap.cloud.sdk.odatav2.connectivity.ODataException
    
    See Also:
    
    ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)

Class DocumentInfoRecordFluentHelper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentInfoRecordFluentHelper

Method Detail

filter

orderBy

select

top

skip

withErrorHandler

toQuery

execute

execute

execute