1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
  2           // <change cr="CIMCoreCR00752.000" type ="change">Update of
  3           // descriptions based on Tech Edit review.</
  4           // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
  5           // qualifier values to CIM Schema.</change>
  6           // <change cr="CIMCoreCR00857" type ="change'>Update the
  7           // description of the class and the properties descriptions
  8           // and MappingStrings.</
  9           // <change cr="ArchCR00089.003" type="add">Add PUnit qualifier values
 10           // to Units qualifier values.</change>
 11           // ==================================================================
 12           //  CIM_PrintQueue
 13           // ==================================================================
 14              [Version ( "2.14.0" ), 
 15               UMLPackagePath ( "CIM::Device::Printing" ), 
 16               Description ( 
 17                  "Capabilities and management of a Printer Queue. A PrintQueue "
 18                  "holds PrintJobs that are placed on the Queue by a Print "
 19                  "Service. Jobs can move from Queue to Queue. The ABNF for CIM "
 20                  "references to PWG Standards and MIBs is in the directory "
 21                  "\'ftp://ftp.pwg.org/pub/pwg/general/process\' in the file "
 22 marek 1.1        "\'pwg-cim-references-format-20060309.txt\'. An example for a "
 23                  "MappingStrings reference to a PWG Standard is "
 24                  "\'PWG5101-1.PWG|Section 4 Media Color Names\'. An example for "
 25                  "a MappingStrings reference to a PWG MIB is "
 26                  "\'MIB.PWG|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobs\'." )]
 27           class CIM_PrintQueue : CIM_JobDestination {
 28           
 29                 [Deprecated { "CIM_EnabledLogicalElement.EnabledState" }, 
 30                  Description ( 
 31                     "Note: Both this property and QueueAccepting are "
 32                     "deprecated in lieu of EnabledState. \n"
 33                     "Deprecated description: Indicates that Jobs on the Queue "
 34                     "will be passed to a Printer. When false, a Job will "
 35                     "remain on the Queue and will not be passed to a Printer "
 36                     "for output. This property, coupled with the information "
 37                     "in QueueAccepting, aligns with various values of the "
 38                     "inherited EnabledState property: \n"
 39                     "- When both QueueEnabled and QueueAccepting are true, "
 40                     "then EnabledState is set to 2 (\"Enabled\") \n"
 41                     "- When both QueueEnabled and QueueAccepting are false, "
 42                     "then EnabledState is set to 3 (\"Disabled\") \n"
 43 marek 1.1           "- When QueueEnabled is true and QueueAccepting is false "
 44                     "(for instance, when the Queue outputs jobs to the "
 45                     "printer, but does not accept new jobs), then "
 46                     "EnabledState is set to 6 (\"Enabled but Offline\") \n"
 47                     "- When QueueEnabled is false and QueueAccepting is true "
 48                     "(for instance, when the Queue accepts print jobs but "
 49                     "does not send them to a printer), then EnabledState is "
 50                     "set to 8 (\"Deferred\")." )]
 51              boolean QueueEnabled;
 52           
 53                 [Deprecated { "CIM_EnabledLogicalElement.EnabledState" }, 
 54                  Description ( 
 55                     "Note: Both this property and QueueEnabled are deprecated "
 56                     "in lieu of EnabledState. \n"
 57                     "Deprecated description: When false, no PrintService can "
 58                     "place PrintJobs on the PrintQueue. The ability of an "
 59                     "individual PrintService to place a Job on the Queue can "
 60                     "be specified using the QueueAcceptingFromService "
 61                     "property in the QueueForPrint Service association. This "
 62                     "property, coupled with the information in QueueEnabled, "
 63                     "aligns with various values of the inherited EnabledState "
 64 marek 1.1           "property: \n"
 65                     "- When both QueueEnabled and QueueAccepting are true, "
 66                     "then EnabledState is set to 2 (\"Enabled\") \n"
 67                     "- When both QueueEnabled and QueueAccepting are false, "
 68                     "then EnabledState is set to 3 (\"Disabled\") \n"
 69                     "- When QueueEnabled is true and QueueAccepting is false "
 70                     "(for instance, when the Queue outputs jobs to the "
 71                     "printer, but does not accept new jobs), then "
 72                     "EnabledState is set to 6 (\"Enabled but Offline\") \n"
 73                     "- When QueueEnabled is false and QueueAccepting is true "
 74                     "(for instance, when the Queue accepts print jobs but "
 75                     "does not send them to a printer), then EnabledState is "
 76                     "set to 8 (\"Deferred\")." )]
 77              boolean QueueAccepting;
 78           
 79                 [Description ( "The current number of Jobs on the Queue." ), 
 80                  Gauge, MappingStrings { 
 81                     "MIB.IETF|Job-Monitoring-MIB.jmGeneralNumberOfActiveJobs", 
 82                     "RFC2911.IETF|Printer.queued-job-count" }]
 83              uint32 NumberOnQueue;
 84           
 85 marek 1.1       [Description ( 
 86                     "Gives Queue-specific status information, beyond the "
 87                     "ManagedSystemElement.Status property. This method can be "
 88                     "used to provide further qualification as to the status "
 89                     "of the Queue or to indicate a secondary condition (for "
 90                     "example, spool area is full)." ), 
 91                  ValueMap { "0", "1", "2", "3" }, 
 92                  Values { "Other", "Unknown", "No Additional Status", 
 93                     "QueueSpoolAreaFull" }, 
 94                  MappingStrings { "RFC2911.IETF|Printer.printer-state-reasons" }]
 95              uint16 QueueStatus;
 96           
 97                 [Description ( 
 98                     "Provides a textual explanation for the status of the "
 99                     "Queue. The settings of both QueueStatus and the Status "
100                     "property that are inherited from ManagedSystemElement "
101                     "can be described by QueueStatusInfo. For example, if "
102                     "\"Stopping\" is the value that is assigned to Status, "
103                     "then this property might contain an explanation as to "
104                     "why the Queue is being stopped." ), 
105                  MappingStrings { "RFC2911.IETF|Printer.printer-state-message" }]
106 marek 1.1    string QueueStatusInfo;
107           
108                 [Description ( 
109                     "Specifies the largest possible Job (in terms of a single "
110                     "byte stream) that can be submitted to this Queue. A "
111                     "value of 0 indicates that no limit has been set. Units "
112                     "are Kbytes." ), 
113                  Units ( "KiloBytes" ), 
114                  MappingStrings { 
115                     "RFC2911.IETF|Section 4.4.33 job-k-octets-supported" }, 
116                  ModelCorrespondence { "CIM_PrintJob.JobSize" }, 
117                  PUnit ( "byte * 10^3" )]
118              uint32 MaxJobSize;
119           
120                 [Description ( 
121                     "Specifies the priority that will be assigned to a new "
122                     "Job that is submitted to this Queue, if the Job does not "
123                     "explicitly specify a priority. The range of valid "
124                     "priorities and the interpretation of priorities can be "
125                     "determined from the JobPriorityHigh and JobPriorityLow "
126                     "properties." ), 
127 marek 1.1        MappingStrings { "RFC2911.IETF|Printer.job-priority-default" }, 
128                  ModelCorrespondence { "CIM_PrintQueue.JobPriorityHigh", 
129                     "CIM_PrintQueue.JobPriorityLow" }]
130              uint32 DefaultJobPriority;
131           
132                 [Description ( 
133                     "Specifies the numeric value that is used to represent "
134                     "the highest priority Jobs that are submitted to this "
135                     "Queue. The range of numeric values for priority can be "
136                     "inverted, for example, a high priority job is "
137                     "represented by a low integer value. This value is "
138                     "indicated by JobPriorityLow being greater than "
139                     "JobPriorityHigh. If both values (PriorityLow and "
140                     "PriorityHigh) are assigned to 0, then the Queue does not "
141                     "support Job priorities. The values and usage of the "
142                     "property SHOULD conform to the semantics of the "
143                     "\'job-priority-supported\' attribute of the Printer "
144                     "object defined in IPP/1.1 [RFC2911]." ), 
145                  MappingStrings { "RFC2911.IETF|Printer.job-priority-supported" }, 
146                  ModelCorrespondence { "CIM_PrintQueue.JobPriorityLow", 
147                     "CIM_Job.Priority" }]
148 marek 1.1    uint32 JobPriorityHigh;
149           
150                 [Description ( 
151                     "Specifies the numeric value that is used to represent "
152                     "the lowest priority Jobs that are submitted to this "
153                     "Queue. The range of numeric values for priority can be "
154                     "inverted, for example, a low priority job is represented "
155                     "by a high integer value. This value is indicated by "
156                     "JobPriorityLow being greater than JobPriorityHigh. If "
157                     "both values (PriorityLow and PriorityHigh) are assigned "
158                     "to 0, then the Queue does not support Job priorities. "
159                     "The values and usage of the property SHOULD conform to "
160                     "the semantics of the \'job-priority-supported\' "
161                     "attribute of the Printer object defined in IPP/1.1 "
162                     "[RFC2911]." ), 
163                  MappingStrings { "RFC2911.IETF|Printer.job-priority-supported" }, 
164                  ModelCorrespondence { "CIM_PrintQueue.JobPriorityHigh", 
165                     "CIM_Job.Priority" }]
166              uint32 JobPriorityLow;
167           
168                 [Description ( 
169 marek 1.1           "Specifies the job sheets that are supported by this "
170                     "Queue. Typically the job sheets that are provided by a "
171                     "Queue will be the union or aggregation of those provided "
172                     "by all the Printers that it supports. However, a system "
173                     "administrator can choose to restrict access to some job "
174                     "sheets on a particular Queue. A Queue can also support "
175                     "additional job sheets through the use of a filter that "
176                     "adds a banner or some other page when a Job is taken "
177                     "from the Queue." ), 
178                  MappingStrings { 
179                     "MIB.IETF|Printer-MIB.prtAuxiliarySheetStartupPage", 
180                     "MIB.IETF|Printer-MIB.prtAuxiliarySheetBannerPage", 
181                     "RFC2911.IETF|Printer.job-sheets-supported" }, 
182                  ModelCorrespondence { "CIM_PrintJob.RequiredJobSheets" }]
183              string AvailableJobSheets[];
184           
185           
186           };