All Implemented Interfaces:


public final class IppJob

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`IppJob.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private IppSubscription`	`subscription`
`private Boolean`	`useJobOwnerAsUserName`
`private Boolean`	`useJobUri`
`private final Integer`	`id`
`private final URI`	`uri`
`private final URI`	`printerUri`
`private final JobState`	`state`
`private final List<String>`	`stateReasons`
`private final IppString`	`name`
`private final IppString`	`originatingUserName`
`private final IppString`	`originatingHostName`
`private final Integer`	`impressionsCompleted`
`private final Integer`	`mediaSheetsCompleted`
`private final Integer`	`kOctets`
`private final Collection<IntRange>`	`pageRanges`
`private final Integer`	`numberOfDocuments`
`private final IppString`	`documentNameSupplied`
`private final String`	`documentFormat`
`private final ZonedDateTime`	`timeAtCreation`
`private final ZonedDateTime`	`timeAtProcessing`
`private final ZonedDateTime`	`timeAtCompleted`
`private final String`	`appleJobOwner`
`private final IppPrinter`	`printer`
`private final IppAttributesGroup`	`attributes`

Constructor Summary

Constructors
Constructor	Description
`IppJob(IppPrinter printer, IppResponse response)`
`IppJob(IppPrinter printer, IppAttributesGroup attributes)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final IppSubscription`	`getSubscription()`
`final Unit`	`setSubscription(IppSubscription subscription)`
`final Boolean`	`getUseJobOwnerAsUserName()`
`final Unit`	`setUseJobOwnerAsUserName(Boolean useJobOwnerAsUserName)`
`final Boolean`	`getUseJobUri()`
`final Unit`	`setUseJobUri(Boolean useJobUri)`
`final Integer`	`getId()`
`final URI`	`getUri()`
`final URI`	`getPrinterUri()`
`final JobState`	`getState()`
`final List<String>`	`getStateReasons()`
`final IppString`	`getName()`
`final IppString`	`getOriginatingUserName()`
`final IppString`	`getOriginatingHostName()`
`final Integer`	`getImpressionsCompleted()`
`final Integer`	`getMediaSheetsCompleted()`
`final Integer`	`getKOctets()`
`final Collection<IntRange>`	`getPageRanges()`
`final Integer`	`getNumberOfDocuments()`
`final IppString`	`getDocumentNameSupplied()`
`final String`	`getDocumentFormat()`
`final ZonedDateTime`	`getTimeAtCreation()`
`final ZonedDateTime`	`getTimeAtProcessing()`
`final ZonedDateTime`	`getTimeAtCompleted()`
`final String`	`getAppleJobOwner()`
`final IppPrinter`	`getPrinter()`
`final IppAttributesGroup`	`getAttributes()`
`final Boolean`	`isPending(Boolean updateStateAttributes)`
`final Boolean`	`isPending()`
`final Boolean`	`isAborted(Boolean updateStateAttributes)`
`final Boolean`	`isAborted()`
`final Boolean`	`isCanceled(Boolean updateStateAttributes)`
`final Boolean`	`isCanceled()`
`final Boolean`	`isCompleted(Boolean updateStateAttributes)`
`final Boolean`	`isCompleted()`
`final Boolean`	`isProcessing(Boolean updateStateAttributes)`
`final Boolean`	`isProcessing()`
`final Boolean`	`isProcessingStopped(Boolean updateStateAttributes)`
`final Boolean`	`isProcessingStopped()`
`final Boolean`	`isTerminated(Boolean updateStateAttributes)`
`final Boolean`	`isTerminated()`
`final Boolean`	`stateReasonsContain(String reason)`
`final Boolean`	`isProcessingToStopPoint()`
`final Boolean`	`resourcesAreNotReady()`
`final Boolean`	`isPrinterStopped()`
`final Boolean`	`isIncoming()`
`final String`	`getOriginatingUserNameOrAppleJobOwnerOrNull()`
`final String`	`getJobNameOrDocumentNameSuppliedOrAppleJobNameOrNull()`
`final Integer`	`getNumberOfDocumentsOrDocumentCount()`
`final IppAttributesGroup`	`getJobAttributes(List<String> requestedAttributes)`
`final IppAttributesGroup`	`getJobAttributes()`
`final IppAttributesGroup`	`getJobAttributes(String requestedAttribute)`
`final Unit`	`updateAttributes(List<String> requestedAttributes)`
`final Unit`	`updateAttributes()`
`final Unit`	`updateAttributes(String requestedAttributes)`
`final Unit`	`waitForTermination(Duration delay, Level jobProgressLogLevel, Level printerStateLogLevel)`
`final Unit`	`waitForTermination(Duration delay, Level jobProgressLogLevel)`
`final Unit`	`waitForTermination(Duration delay)`
`final Unit`	`waitForTermination()`
`final IppResponse`	`hold()`
`final IppResponse`	`close()`
`final IppResponse`	`release()`
`final IppResponse`	`restart()`
`final IppResponse`	`resubmit()`
`final IppResponse`	`cancel(String messageForOperator)`
`final IppResponse`	`cancel()`
`final Unit`	`sendDocument(InputStream inputStream, Boolean lastDocument, String documentName, String documentNaturalLanguage, DocumentFormat documentFormat)`
`final Unit`	`sendDocument(InputStream inputStream, Boolean lastDocument, String documentName, String documentNaturalLanguage)`
`final Unit`	`sendDocument(InputStream inputStream, Boolean lastDocument, String documentName)`
`final Unit`	`sendDocument(InputStream inputStream, Boolean lastDocument)`
`final Unit`	`sendDocument(InputStream inputStream)`
`final Unit`	`sendDocument(File file, Boolean lastDocument, String documentName, String documentNaturalLanguage, DocumentFormat documentFormat)`
`final Unit`	`sendDocument(File file, Boolean lastDocument, String documentName, String documentNaturalLanguage)`
`final Unit`	`sendDocument(File file, Boolean lastDocument, String documentName)`
`final Unit`	`sendDocument(File file, Boolean lastDocument)`
`final Unit`	`sendDocument(File file)`
`final Unit`	`sendUri(URI documentUri, Boolean lastDocument, String documentName, String documentNaturalLanguage, DocumentFormat documentFormat)`
`final Unit`	`sendUri(URI documentUri, Boolean lastDocument, String documentName, String documentNaturalLanguage)`
`final Unit`	`sendUri(URI documentUri, Boolean lastDocument, String documentName)`
`final Unit`	`sendUri(URI documentUri, Boolean lastDocument)`
`final Unit`	`sendUri(URI documentUri)`
`final IppResponse`	`cupsMoveJob(URI printerUri)`
`final IppResponse`	`cupsMoveJob(IppPrinter ippPrinter)`
`final IppSubscription`	`createJobSubscription(List<String> notifyEvents)`
`final IppSubscription`	`createJobSubscription()`
`final IppDocument`	`cupsGetDocument(Integer documentNumber)`
`final IppDocument`	`cupsGetDocument()`
`final List<IppDocument>`	`cupsGetDocuments(Boolean save, File directory, String optionalCommandToHandleFile)`
`final List<IppDocument>`	`cupsGetDocuments(Boolean save, File directory)`
`final List<IppDocument>`	`cupsGetDocuments(Boolean save)`
`final List<IppDocument>`	`cupsGetDocuments()`
`String`	`toString()`
`final Unit`	`log(Logger logger, Level level)`
`final Unit`	`log(Logger logger)`

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

Constructor Detail

IppJob

IppJob(IppPrinter printer, IppResponse response)

IppJob

IppJob(IppPrinter printer, IppAttributesGroup attributes)

Method Detail

getSubscription

 final IppSubscription getSubscription()

setSubscription

 final Unit setSubscription(IppSubscription subscription)

getUseJobOwnerAsUserName

 final Boolean getUseJobOwnerAsUserName()

setUseJobOwnerAsUserName

 final Unit setUseJobOwnerAsUserName(Boolean useJobOwnerAsUserName)

getUseJobUri
```
 final Boolean getUseJobUri()
```

setUseJobUri

 final Unit setUseJobUri(Boolean useJobUri)

getId
```
 final Integer getId()
```

getUri
```
 final URI getUri()
```

getPrinterUri
```
 final URI getPrinterUri()
```

getState
```
 final JobState getState()
```

getStateReasons
```
 final List<String> getStateReasons()
```

getName
```
 final IppString getName()
```

getOriginatingUserName

 final IppString getOriginatingUserName()

getOriginatingHostName

 final IppString getOriginatingHostName()

getImpressionsCompleted

 final Integer getImpressionsCompleted()

getMediaSheetsCompleted

 final Integer getMediaSheetsCompleted()

getKOctets
```
 final Integer getKOctets()
```

getPageRanges

 final Collection<IntRange> getPageRanges()

getNumberOfDocuments
```
 final Integer getNumberOfDocuments()
```

getDocumentNameSupplied

 final IppString getDocumentNameSupplied()

getDocumentFormat
```
 final String getDocumentFormat()
```

getTimeAtCreation

 final ZonedDateTime getTimeAtCreation()

getTimeAtProcessing

 final ZonedDateTime getTimeAtProcessing()

getTimeAtCompleted

 final ZonedDateTime getTimeAtCompleted()

getAppleJobOwner
```
 final String getAppleJobOwner()
```

getPrinter
```
 final IppPrinter getPrinter()
```

getAttributes

 final IppAttributesGroup getAttributes()

isPending

@JvmOverloads() final Boolean isPending(Boolean updateStateAttributes)

isPending

@JvmOverloads() final Boolean isPending()

isAborted

@JvmOverloads() final Boolean isAborted(Boolean updateStateAttributes)

isAborted

@JvmOverloads() final Boolean isAborted()

isCanceled

@JvmOverloads() final Boolean isCanceled(Boolean updateStateAttributes)

isCanceled

@JvmOverloads() final Boolean isCanceled()

isCompleted

@JvmOverloads() final Boolean isCompleted(Boolean updateStateAttributes)

isCompleted

@JvmOverloads() final Boolean isCompleted()

isProcessing

@JvmOverloads() final Boolean isProcessing(Boolean updateStateAttributes)

isProcessing

@JvmOverloads() final Boolean isProcessing()

isProcessingStopped

@JvmOverloads() final Boolean isProcessingStopped(Boolean updateStateAttributes)

isProcessingStopped

@JvmOverloads() final Boolean isProcessingStopped()

isTerminated

@JvmOverloads() final Boolean isTerminated(Boolean updateStateAttributes)

isTerminated

@JvmOverloads() final Boolean isTerminated()

stateReasonsContain

 final Boolean stateReasonsContain(String reason)

isProcessingToStopPoint

 final Boolean isProcessingToStopPoint()

resourcesAreNotReady
```
 final Boolean resourcesAreNotReady()
```

isPrinterStopped
```
 final Boolean isPrinterStopped()
```

isIncoming
```
 final Boolean isIncoming()
```

getOriginatingUserNameOrAppleJobOwnerOrNull

 final String getOriginatingUserNameOrAppleJobOwnerOrNull()

getJobNameOrDocumentNameSuppliedOrAppleJobNameOrNull

 final String getJobNameOrDocumentNameSuppliedOrAppleJobNameOrNull()

getNumberOfDocumentsOrDocumentCount

 final Integer getNumberOfDocumentsOrDocumentCount()

getJobAttributes

@JvmOverloads() final IppAttributesGroup getJobAttributes(List<String> requestedAttributes)

getJobAttributes

@JvmOverloads() final IppAttributesGroup getJobAttributes()

getJobAttributes

 final IppAttributesGroup getJobAttributes(String requestedAttribute)

updateAttributes

@JvmOverloads() final Unit updateAttributes(List<String> requestedAttributes)

updateAttributes

@JvmOverloads() final Unit updateAttributes()

updateAttributes

 final Unit updateAttributes(String requestedAttributes)

waitForTermination

@JvmOverloads() final Unit waitForTermination(Duration delay, Level jobProgressLogLevel, Level printerStateLogLevel)

waitForTermination

@JvmOverloads() final Unit waitForTermination(Duration delay, Level jobProgressLogLevel)

waitForTermination

@JvmOverloads() final Unit waitForTermination(Duration delay)

waitForTermination

@JvmOverloads() final Unit waitForTermination()

hold
```
 final IppResponse hold()
```

close
```
 final IppResponse close()
```

release
```
 final IppResponse release()
```

restart
```
 final IppResponse restart()
```

resubmit
```
 final IppResponse resubmit()
```

cancel

@JvmOverloads() final IppResponse cancel(String messageForOperator)

cancel

@JvmOverloads() final IppResponse cancel()

sendDocument

@JvmOverloads() final Unit sendDocument(InputStream inputStream, Boolean lastDocument, String documentName, String documentNaturalLanguage, DocumentFormat documentFormat)

sendDocument

@JvmOverloads() final Unit sendDocument(InputStream inputStream, Boolean lastDocument, String documentName, String documentNaturalLanguage)

sendDocument

@JvmOverloads() final Unit sendDocument(InputStream inputStream, Boolean lastDocument, String documentName)

sendDocument

@JvmOverloads() final Unit sendDocument(InputStream inputStream, Boolean lastDocument)

sendDocument

@JvmOverloads() final Unit sendDocument(InputStream inputStream)

sendDocument

@JvmOverloads() final Unit sendDocument(File file, Boolean lastDocument, String documentName, String documentNaturalLanguage, DocumentFormat documentFormat)

sendDocument

@JvmOverloads() final Unit sendDocument(File file, Boolean lastDocument, String documentName, String documentNaturalLanguage)

sendDocument

@JvmOverloads() final Unit sendDocument(File file, Boolean lastDocument, String documentName)

sendDocument

@JvmOverloads() final Unit sendDocument(File file, Boolean lastDocument)

sendDocument

@JvmOverloads() final Unit sendDocument(File file)

sendUri

@JvmOverloads() final Unit sendUri(URI documentUri, Boolean lastDocument, String documentName, String documentNaturalLanguage, DocumentFormat documentFormat)

sendUri

@JvmOverloads() final Unit sendUri(URI documentUri, Boolean lastDocument, String documentName, String documentNaturalLanguage)

sendUri

@JvmOverloads() final Unit sendUri(URI documentUri, Boolean lastDocument, String documentName)

sendUri

@JvmOverloads() final Unit sendUri(URI documentUri, Boolean lastDocument)

sendUri

@JvmOverloads() final Unit sendUri(URI documentUri)

cupsMoveJob

 final IppResponse cupsMoveJob(URI printerUri)

cupsMoveJob

 final IppResponse cupsMoveJob(IppPrinter ippPrinter)

createJobSubscription

@JvmOverloads() final IppSubscription createJobSubscription(List<String> notifyEvents)

createJobSubscription

@JvmOverloads() final IppSubscription createJobSubscription()

cupsGetDocument

@JvmOverloads() final IppDocument cupsGetDocument(Integer documentNumber)

cupsGetDocument

@JvmOverloads() final IppDocument cupsGetDocument()

cupsGetDocuments

@JvmOverloads() final List<IppDocument> cupsGetDocuments(Boolean save, File directory, String optionalCommandToHandleFile)

cupsGetDocuments

@JvmOverloads() final List<IppDocument> cupsGetDocuments(Boolean save, File directory)

cupsGetDocuments

@JvmOverloads() final List<IppDocument> cupsGetDocuments(Boolean save)

cupsGetDocuments

@JvmOverloads() final List<IppDocument> cupsGetDocuments()

toString
```
 String toString()
```

log

@JvmOverloads() final Unit log(Logger logger, Level level)

log

@JvmOverloads() final Unit log(Logger logger)

Class IppJob

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IppJob

IppJob

Method Detail

getSubscription

setSubscription

getUseJobOwnerAsUserName

setUseJobOwnerAsUserName

getUseJobUri

setUseJobUri

getId

getUri

getPrinterUri

getState

getStateReasons

getName

getOriginatingUserName

getOriginatingHostName

getImpressionsCompleted

getMediaSheetsCompleted

getKOctets

getPageRanges

getNumberOfDocuments

getDocumentNameSupplied

getDocumentFormat

getTimeAtCreation

getTimeAtProcessing

getTimeAtCompleted

getAppleJobOwner

getPrinter

getAttributes

isPending

isPending

isAborted

isAborted

isCanceled

isCanceled

isCompleted

isCompleted

isProcessing

isProcessing

isProcessingStopped

isProcessingStopped

isTerminated

isTerminated

stateReasonsContain

isProcessingToStopPoint

resourcesAreNotReady

isPrinterStopped

isIncoming

getOriginatingUserNameOrAppleJobOwnerOrNull

getJobNameOrDocumentNameSuppliedOrAppleJobNameOrNull

getNumberOfDocumentsOrDocumentCount

getJobAttributes

getJobAttributes

getJobAttributes

updateAttributes

updateAttributes

updateAttributes

waitForTermination

waitForTermination

waitForTermination

waitForTermination

hold

close

release

restart

resubmit

cancel

cancel

sendDocument

sendDocument

sendDocument