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

Class DefaultPrintQueueItemService

java.lang.Object

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

All Implemented Interfaces:

BatchService<PrintQueueItemServiceBatch>, PrintQueueItemService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPrintQueueItemService")
public class DefaultPrintQueueItemService
extends Object
implements PrintQueueItemService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PrintQueueItemService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPrintQueueItemService() Creates a service using PrintQueueItemService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultPrintQueueItemServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultPrintQueueItemService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPrintQueueItemService

public DefaultPrintQueueItemService()

Creates a service using PrintQueueItemService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultPrintQueueItemService withServicePath(@Nonnull
                                                             String servicePath)

Description copied from interface: PrintQueueItemService

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

Specified by:

withServicePath in interface PrintQueueItemService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultPrintQueueItemServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<PrintQueueItemServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

retrieveNextQueueItem

@Nonnull
public RetrieveNextQueueItemFluentHelper retrieveNextQueueItem(String qname,
                                                                        String language)

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the RetrieveNextQueueItem OData function import.

Specified by:

retrieveNextQueueItem in interface PrintQueueItemService

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
public Get_IcmCacheFluentHelper get_IcmCache()

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the Get_IcmCache OData function import.

Specified by:

get_IcmCache in interface PrintQueueItemService

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
public Get_PrintQueuesOfUserFluentHelper get_PrintQueuesOfUser()

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the Get_PrintQueuesOfUser OData function import.

Specified by:

get_PrintQueuesOfUser in interface PrintQueueItemService

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
public Set_QItem_StatusFluentHelper set_QItem_Status(String qname,
                                                              String item_id,
                                                              String item_status,
                                                              String status_desc)

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the Set_QItem_Status OData function import.

Specified by:

set_QItem_Status in interface PrintQueueItemService

Parameters:

qname - Constraints: Not nullable, Maximum length: 64

Original parameter name from the Odata EDM: qname

item_id - Constraints: Not nullable, Maximum length: 64

Original parameter name from the Odata EDM: item_id

item_status - Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: item_status

status_desc - Constraints: Not nullable, Maximum length: 80

Original parameter name from the Odata EDM: status_desc

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
public Get_QItem_DocumentFluentHelper get_QItem_Document(String item_id,
                                                                  Boolean main_doc,
                                                                  Boolean attachments,
                                                                  String qname)

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the Get_QItem_Document OData function import.

Specified by:

get_QItem_Document in interface PrintQueueItemService

Parameters:

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

attachments - Constraints: none

Original parameter name from the Odata EDM: attachments

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
public Get_PrintOptionsFluentHelper get_PrintOptions(String qname,
                                                              String item_id)

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the Get_PrintOptions OData function import.

Specified by:

get_PrintOptions in interface PrintQueueItemService

Parameters:

qname - Constraints: none

Original parameter name from the Odata EDM: qname

item_id - Constraints: none

Original parameter name from the Odata EDM: item_id

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
public Set_PrintParameterFluentHelper set_PrintParameter(String printParams,
                                                                  String qname)

Description copied from interface: PrintQueueItemService

Creates a fluent helper for the Set_PrintParameter OData function import.

Specified by:

set_PrintParameter in interface PrintQueueItemService

Parameters:

printParams - Constraints: none

Original parameter name from the Odata EDM: PrintParams

qname - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: Qname

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.