Класс JobState
- java.lang.Object
-
- javax.print.attribute.EnumSyntax
-
- javax.print.attribute.standard.JobState
- Все реализованные интерфейсы:
-
Serializable,Cloneable,Attribute,PrintJobAttribute
public class JobState extends EnumSyntax implements PrintJobAttribute
JobState — это класс атрибутов печати, перечисление, которое идентифицирует текущее состояние задания печати. Класс JobState определяет стандартные значения состояния задания. Реализация Print Service должна сообщать только о тех состояниях заданий, которые подходят для конкретной реализации; она не обязана сообщать о каждом определённом состоянии задания. Атрибут JobStateReasons дополняет атрибут JobState, чтобы предоставить более подробную информацию о задании в данном состоянии.
Совместимость с IPP: Имя категории, возвращаемое getName(), — это имя атрибута IPP. Целочисленное значение перечисления — это значение перечисления IPP. Метод toString() возвращает строковое представление атрибута IPP.
- См. также:
- Сериализованная форма
Поля
| Модификатор и тип | Поле | Описание |
|---|---|---|
static JobState | ABORTED | Задание было прервано системой (обычно, когда задание было в состоянии |
static JobState | CANCELED | Задание было отменено каким-либо человеческим агентом, принтер завершил отмену задания, и все атрибуты состояния задания достигли своих конечных значений для задания. |
static JobState | COMPLETED | Задание успешно завершено или с предупреждениями или ошибками после обработки, все листы носителя задания были успешно уложены в соответствующие выходные лотки, и все атрибуты состояния задания достигли своих конечных значений для задания. |
static JobState | PENDING | Задание готово к началу обработки, но ещё не обрабатывается. |
static JobState | PENDING_HELD | Задание не является кандидатом на обработку по ряду причин, но вернётся в состояние |
static JobState | PROCESSING | Задание обрабатывается. |
static JobState | PROCESSING_STOPPED | Задание приостановлено во время обработки по ряду причин и вернётся в состояние |
static JobState | UNKNOWN | Состояние задания неизвестно. |
Конструкторы
| Модификатор | Конструктор | Описание |
|---|---|---|
protected | JobState(int value) | Создаёт новое значение перечисления состояния задания с заданным целочисленным значением. |
Методы
| Модификатор и тип | Метод | Описание |
|---|---|---|
Class<? extends Attribute> | getCategory() | Получить класс атрибутов печати, который должен использоваться в качестве «категории» для этого значения атрибута печати. |
protected EnumSyntax[] | getEnumValueTable() | Возвращает таблицу значений перечисления для класса |
String | getName() | Получить имя категории, экземпляром которой является это значение атрибута. |
protected String[] | getStringTable() | Возвращает таблицу строк для класса |
Методы, унаследованные от класса javax.print.attribute.EnumSyntax
clone, getOffset, getValue, hashCode, readResolve, toString Методы, унаследованные от класса java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait Поля
НЕИЗВЕСТНО
public static final JobState UNKNOWN
Состояние задания неизвестно.
ОЖИДАЕТСЯ
public static final JobState PENDING
Задание является кандидатом на начало обработки, но пока не обрабатывается.
ОЖИДАЕТСЯ_ЗАДЕРЖАНО
public static final JobState PENDING_HELD
Задание не является кандидатом на обработку по ряду причин, но вернется в состояние PENDING как только причины больше не будут актуальны. Атрибут задания JobStateReasons должен указать причину, по которой задание больше не является кандидатом на обработку.
ОБРАБАТЫВАЕТСЯ
public static final JobState PROCESSING
Задание обрабатывается. Происходит одна или несколько из следующих активностей:
- Задание использует или пытается использовать один или несколько чисто программных процессов, которые анализируют, создают или интерпретируют PDL и т. д.
- Задание использует или пытается использовать один или несколько аппаратных устройств, которые интерпретируют PDL, делают отметки на носителе и/или выполняют обработку, такую как скрепление и т. д.
- Принтер подготовил задание к печати, но устройство вывода пока не печатает его, либо потому, что задание еще не достигло устройства вывода, либо потому, что задание находится в очереди на устройстве вывода или в другом планировщике, ожидая, когда устройство вывода напечатает его.
PROCESSING, весь статус задания включает подробный статус, представленный в атрибутах принтера PrinterState и PrinterStateReasons.
Реализации могут, но не обязаны, включать дополнительные значения в атрибут задания JobStateReasons для указания прогресса задания, например, добавляя значение JOB_PRINTING, чтобы указать, когда устройство вывода фактически делает отметки на бумаге, и/или значение PROCESSING_TO_STOP_POINT, чтобы указать, что принтер в процессе отмены или прерывания задания.
ОБРАБОТКА_ОСТАНОВЛЕНА
public static final JobState PROCESSING_STOPPED
Задание остановилось во время обработки по ряду причин и вернется в состояние PROCESSING как только причины больше не будут актуальны.
Атрибут задания JobStateReasons может указать причину остановки обработки задания. Например, если устройство вывода остановлено, значение PRINTER_STOPPED может быть включено в атрибут задания JobStateReasons.
Примечание: Когда устройство вывода остановлено, устройство обычно указывает своё состояние в удобочитаемой форме локально на устройстве. Клиент может получить более полную информацию о состоянии устройства удалённо, запросив атрибуты принтера PrinterState и PrinterStateReasons.
ОТМЕНЕНО
public static final JobState CANCELED
Задание было отменено каким-либо пользователем, принтер завершил отмену задания, и все атрибуты состояния задания достигли своих конечных значений для задания. Пока принтер отменяет задание, задание остаётся в своём текущем состоянии, но атрибут задания JobStateReasons должен содержать значение PROCESSING_TO_STOP_POINT и одно из значений CANCELED_BY_USER, CANCELED_BY_OPERATOR, или CANCELED_AT_DEVICE. Когда задание переходит в состояние CANCELED, значение PROCESSING_TO_STOP_POINT, если оно присутствует, должно быть удалено, но значение CANCELED_BY_xxx, если оно присутствует, должно остаться.
ПРЕРВАНО
public static final JobState ABORTED
Задание было прервано системой (обычно, когда задание находилось в состоянии PROCESSING или PROCESSING_STOPPED), принтер завершил прерывание задания, и все атрибуты состояния задания достигли своих конечных значений для задания. Пока принтер прерывает задание, задание остаётся в своём текущем состоянии, но атрибут задания JobStateReasons должен содержать значения PROCESSING_TO_STOP_POINT и ABORTED_BY_SYSTEM. Когда задание переходит в состояние ABORTED, значение PROCESSING_TO_STOP_POINT, если оно присутствует, должно быть удалено, но значение ABORTED_BY_SYSTEM, если оно присутствует, должно остаться.
ЗАВЕРШЕНО
public static final JobState COMPLETED
Задание успешно завершено или завершено с предупреждениями или ошибками после обработки, все листы носителя задания успешно уложены в соответствующий(ие) лоток(и) вывода, и все атрибуты состояния задания достигли своих конечных значений для задания. Атрибут задания JobStateReasons должен содержать одно из этих значений: COMPLETED_SUCCESSFULLY, COMPLETED_WITH_WARNINGS, или COMPLETED_WITH_ERRORS.
Краткое описание конструкторов
JobState
protected JobState(int value)
Создаёт новое значение перечисления состояния задания со заданным целочисленным значением.
- Параметры:
-
value- Целочисленное значение
Краткое описание методов
getStringTable
protected String[] getStringTable()
Возвращает таблицу строк для класса JobState.
- Переопределяет:
-
getStringTableв классеEnumSyntax - Возвращает:
- таблицу строк
getEnumValueTable
protected EnumSyntax[] getEnumValueTable()
Возвращает таблицу значений перечисления для класса JobState.
- Переопределяет:
-
getEnumValueTableв классеEnumSyntax - Возвращает:
- таблицу значений
getCategory
public final Class<? extends Attribute> getCategory()
Получить класс атрибута печати, который должен использоваться в качестве «категории» для этого значения атрибута печати.
Для класса JobState и любых определённых поставщиком подклассов категорией является сам класс JobState.
- Определено в:
-
getCategoryв интерфейсеAttribute - Возвращает:
- класс атрибута печати (категория), экземпляр класса
java.lang.Class
getName
public final String getName()
Получить имя категории, экземпляром которой является это значение атрибута.
Для класса JobState и любых определённых поставщиком подклассов имя категории — "job-state".
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/print/attribute/standard/JobState.html