FileDocCategorySizeDatePackage
JobOriginatingUserName.javaAPI DocJava SE 5 API3963Fri Aug 26 14:57:44 BST 2005javax.print.attribute.standard

JobOriginatingUserName

public final class JobOriginatingUserName extends TextSyntax implements PrintJobAttribute
Class JobOriginatingUserName is a printing attribute class, a text attribute, that contains the name of the end user that submitted the print job. If possible, the printer sets this attribute to the most authenticated printable user name that it can obtain from the authentication service that authenticated the submitted Print Request. If such is not available, the printer uses the value of the {@link RequestingUserName RequestingUserName} attribute supplied by the client in the Print Request's attribute set. If no authentication service is available, and the client did not supply a {@link RequestingUserName RequestingUserName} attribute, the printer sets the JobOriginatingUserName attribute to an empty (zero-length) string.

IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. The category name returned by getName() gives the IPP attribute name.

author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public JobOriginatingUserName(String userName, Locale locale)
Constructs a new job originating user name attribute with the given user name and locale.

param
userName User name.
param
locale Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
exception
NullPointerException (unchecked exception) Thrown if userName is null.


                                                                       
         
	super (userName, locale);
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this job originating user name attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
  1. object is not null.
  2. object is an instance of class JobOriginatingUserName.
  3. This job originating user name attribute's underlying string and object's underlying string are equal.
  4. This job originating user name attribute's locale and object's locale are equal.

param
object Object to compare to.
return
True if object is equivalent to this job originating user name attribute, false otherwise.

	return (super.equals (object) &&
		object instanceof JobOriginatingUserName);
public final java.lang.ClassgetCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class JobOriginatingUserName, the category is class JobOriginatingUserName itself.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return JobOriginatingUserName.class;
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

For class JobOriginatingUserName, the category name is "job-originating-user-name".

return
Attribute category name.

	return "job-originating-user-name";