com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface PrintQueueItemService

All Superinterfaces:

BatchService<PrintQueueItemServiceBatch>

All Known Implementing Classes:

DefaultPrintQueueItemService

public interface PrintQueueItemService
extends BatchService<PrintQueueItemServiceBatch>

This service enables you to retrieve print queue items of all print queues of a specified user. The status of the print queue items can be modified according to the performed processing in the external application.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CLOUD_PRINT_PULL_SRV
API Version:	1
Communication Scenario:	Printing - Pull Integration (SAP_COM_0466)
Scope Items:	Output Management (‏1LQ‏)
Authentication Methods:	Basic

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
Get_IcmCacheFluentHelper	get_IcmCache() Creates a fluent helper for the Get_IcmCache OData function import.
Get_PrintOptionsFluentHelper	get_PrintOptions(String qname, String item_id) Creates a fluent helper for the Get_PrintOptions OData function import.
Get_PrintQueuesOfUserFluentHelper	get_PrintQueuesOfUser() Creates a fluent helper for the Get_PrintQueuesOfUser OData function import.
Get_QItem_DocumentFluentHelper	get_QItem_Document(String item_id, Boolean main_doc, Boolean attachments, String qname) Creates a fluent helper for the Get_QItem_Document OData function import.
RetrieveNextQueueItemFluentHelper	retrieveNextQueueItem(String qname, String language) Creates a fluent helper for the RetrieveNextQueueItem OData function import.
Set_PrintParameterFluentHelper	set_PrintParameter(String printParams, String qname) Creates a fluent helper for the Set_PrintParameter OData function import.
Set_QItem_StatusFluentHelper	set_QItem_Status(String qname, String item_id, String item_status, String status_desc) Creates a fluent helper for the Set_QItem_Status OData function import.
PrintQueueItemService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
PrintQueueItemService withServicePath(@Nonnull
                                               String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

retrieveNextQueueItem

@Nonnull
RetrieveNextQueueItemFluentHelper retrieveNextQueueItem(String qname,
                                                                 String language)

Creates a fluent helper for the RetrieveNextQueueItem OData function import.

Parameters:

qname - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: Qname

language - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: Language

Returns:

A fluent helper object that will execute the RetrieveNextQueueItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

get_IcmCache

@Nonnull
Get_IcmCacheFluentHelper get_IcmCache()

Creates a fluent helper for the Get_IcmCache OData function import.

Returns:

A fluent helper object that will execute the Get_IcmCache OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

get_PrintQueuesOfUser

@Nonnull
Get_PrintQueuesOfUserFluentHelper get_PrintQueuesOfUser()

Creates a fluent helper for the Get_PrintQueuesOfUser OData function import.

Returns:

A fluent helper object that will execute the Get_PrintQueuesOfUser OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

set_QItem_Status

@Nonnull
Set_QItem_StatusFluentHelper set_QItem_Status(String qname,
                                                       String item_id,
                                                       String item_status,
                                                       String status_desc)

Creates a fluent helper for the Set_QItem_Status OData function import.

Parameters:

status_desc - Constraints: Not nullable, Maximum length: 80

Original parameter name from the Odata EDM: status_desc

item_id - Constraints: Not nullable, Maximum length: 64

Original parameter name from the Odata EDM: item_id

qname - Constraints: Not nullable, Maximum length: 64

Original parameter name from the Odata EDM: qname

item_status - Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: item_status

Returns:

A fluent helper object that will execute the Set_QItem_Status OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

get_QItem_Document

@Nonnull
Get_QItem_DocumentFluentHelper get_QItem_Document(String item_id,
                                                           Boolean main_doc,
                                                           Boolean attachments,
                                                           String qname)

Creates a fluent helper for the Get_QItem_Document OData function import.

Parameters:

attachments - Constraints: none

Original parameter name from the Odata EDM: attachments

item_id - Constraints: none

Original parameter name from the Odata EDM: item_id

main_doc - Constraints: none

Original parameter name from the Odata EDM: main_doc

qname - Constraints: none

Original parameter name from the Odata EDM: qname

Returns:

A fluent helper object that will execute the Get_QItem_Document OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

get_PrintOptions

@Nonnull
Get_PrintOptionsFluentHelper get_PrintOptions(String qname,
                                                       String item_id)

Creates a fluent helper for the Get_PrintOptions OData function import.

Parameters:

item_id - Constraints: none

Original parameter name from the Odata EDM: item_id

qname - Constraints: none

Original parameter name from the Odata EDM: qname

Returns:

A fluent helper object that will execute the Get_PrintOptions OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

set_PrintParameter

@Nonnull
Set_PrintParameterFluentHelper set_PrintParameter(String printParams,
                                                           String qname)

Creates a fluent helper for the Set_PrintParameter OData function import.

Parameters:

qname - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: Qname

printParams - Constraints: none

Original parameter name from the Odata EDM: PrintParams

Returns:

A fluent helper object that will execute the Set_PrintParameter OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.