oracle.ifs.beans

Class PrintJob

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.beans.PrintJob

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TiePrintJob

public class PrintJob
extends TieApplicationObject

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME This class name for this class.
static String	DOCUMENT_ATTRIBUTE The Document that holds the content for this PrintJob.
static String	PRINTER_ATTRIBUTE The Printer that this PrintJob is destined for.
static String	PRIORITY_ATTRIBUTE The priority of this PrintJob.
static String	STATUS_ATTRIBUTE The status of this PrintJob.
static int	STATUS_CANCELLED A value for the status attribute indicating that the job has been cancelled.
static int	STATUS_CREATED A value for the status attribute indicating that the job has been created.
static int	STATUS_PRINTING A value for the status attribute indicating that the job is currently being printed.
static int	STATUS_READY A value for the status attribute indicating that the job is ready to be printed.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrintJob(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a PrintJob object - standard variant.

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Get the Document that contains the content of this PrintJob.
Printer	getPrinter() Get the Printer for which this PrintJob is destined.
int	getPriority() Get the priority of this PrintJob.
int	getStatus() Get the status of this PrintJob.
String	getStatusLabel() Gets the localized String label for the Status set for this instance.
void	setPriority(int priority) Set the priority of this PrintJob.
void	setStatus(int status) Set the status of this PrintJob.
static String	toStatusLabel(int status) Converts the specified Status constant to a localized label.
static String	toStatusLabel(int status, LibrarySession session) Converts the specified Status constant to a localized label, using the Localizer from the specified LibrarySession.
static String	toStatusLabel(int status, Localizer localizer) Converts the specified Status constant to a localized label, using the specified Localizer.

Methods inherited from class oracle.ifs.beans.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, postCreate, preFree, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryFolderPathIds, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Unpublished)

PRIORITY_ATTRIBUTE

public static final String PRIORITY_ATTRIBUTE

The priority of this PrintJob.

See Also:

Constant Field Values

(Unpublished)

DOCUMENT_ATTRIBUTE

public static final String DOCUMENT_ATTRIBUTE

The Document that holds the content for this PrintJob.

See Also:

Constant Field Values

(Unpublished)

STATUS_ATTRIBUTE

public static final String STATUS_ATTRIBUTE

The status of this PrintJob.

See Also:

Constant Field Values

(Unpublished)

PRINTER_ATTRIBUTE

public static final String PRINTER_ATTRIBUTE

The Printer that this PrintJob is destined for.

See Also:

Constant Field Values

(Unpublished)

STATUS_CREATED

public static final int STATUS_CREATED

A value for the status attribute indicating that the job has been created. This is the default value.

See Also:

Constant Field Values

(Unpublished)

STATUS_READY

public static final int STATUS_READY

A value for the status attribute indicating that the job is ready to be printed.

See Also:

Constant Field Values

(Unpublished)

STATUS_PRINTING

public static final int STATUS_PRINTING

A value for the status attribute indicating that the job is currently being printed.

See Also:

Constant Field Values

(Unpublished)

STATUS_CANCELLED

public static final int STATUS_CANCELLED

A value for the status attribute indicating that the job has been cancelled.

See Also:

Constant Field Values

(Unpublished)

Constructor Detail

PrintJob

protected PrintJob(LibrarySession session,
                   Long id,
                   Long classId,
                   S_LibraryObjectData data)
            throws IfsException

Construct a PrintJob object - standard variant.

Parameters:

session - current LibSession

id - the id

classId - the class id

data - the object's data

Throws:

IfsException

(Unpublished)

Method Detail

getPriority

public int getPriority()
                throws IfsException

Get the priority of this PrintJob.

Returns:

the priority

Throws:

IfsException - if operation fails.

(Unpublished)

setPriority

public void setPriority(int priority)
                 throws IfsException

Set the priority of this PrintJob.

Throws:

IfsException - if operation fails.

(Unpublished)

getStatus

public int getStatus()
              throws IfsException

Get the status of this PrintJob.

Returns:

the status

Throws:

IfsException - if operation fails.

(Unpublished)

setStatus

public void setStatus(int status)
               throws IfsException

Set the status of this PrintJob.

Throws:

IfsException - if operation fails.

(Unpublished)

getDocument

public Document getDocument()
                     throws IfsException

Get the Document that contains the content of this PrintJob.

Returns:

the PrintJob's document

Throws:

IfsException - if operation fails.

(Unpublished)

getPrinter

public Printer getPrinter()
                   throws IfsException

Get the Printer for which this PrintJob is destined.

Returns:

the printer

Throws:

IfsException - if operation fails.

(Unpublished)

getStatusLabel

public String getStatusLabel()
                      throws IfsException

Gets the localized String label for the Status set for this instance.

Returns:

the label corresponding to the Status

Throws:

IfsException - if operation fails.

(Published)

toStatusLabel

public static String toStatusLabel(int status)
                            throws IfsException

Converts the specified Status constant to a localized label. The default Localizer is used.

Parameters:

status - the Status constant.

Returns:

the label corresponding to the specified Status constant.

Throws:

IfsException - if operation fails.

(Published)

toStatusLabel

public static String toStatusLabel(int status,
                                   LibrarySession session)
                            throws IfsException

Converts the specified Status constant to a localized label, using the Localizer from the specified LibrarySession.

Parameters:

status - the Status constant

session - the LibrarySession, whose current Localizer will be used for the conversion

Returns:

the label corresponding to the specified Status constant

Throws:

IfsException - if operation fails.

(Published)

toStatusLabel

public static String toStatusLabel(int status,
                                   Localizer localizer)
                            throws IfsException

Converts the specified Status constant to a localized label, using the specified Localizer. If a null is specified for the Localizer, a temporary Localizer (constructed based on the default Locale) is used for the conversion.

Parameters:

status - the Status constant.

localizer - the Localizer that performs the conversion

Returns:

the label corresponding to the specified Status constant.

Throws:

IfsException - if operation fails.

(Published)