IDOMJobTk Class Reference

Represents an EDL JobTicket. More...

#include <idomjobtk.h>

Inheritance diagram for IDOMJobTk:

Public Member Functions
virtual void	setOwner (IDOMJobTkOwnerPtr &ptrOwner)=0
	Sets the owner node, that is, the level of the DOMtree with which the JobTicket is associated.
virtual IDOMJobTkOwnerPtr	getOwner () const =0
	Retrieves the owner node, that is, the level of the DOMtree with which the JobTicket is associated.
virtual void	setContent (const IDOMJobTkContentPtr &ptrContent)=0
	Sets the JobTicket content node.
virtual IDOMJobTkContentPtr	getContent () const =0
	Retrieves the JobTicket content node.
virtual IDOMJobTkNodePtr	findChild (IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLString &name, const EDLSysString &nmspace)=0
	Searches through the node's direct child set for the node type, name and namespace matching the information provided.
virtual IDOMJobTkNodePtr	findChild (IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLQName &qname)=0
	Searches through the node's direct child set for the node type and qname matching the information provided.
virtual bool	getCombinedContent (IDOMJobTkContentPtr &ptrCombinedContent, bool addDefaultJobTk=false)=0
	Generate combined JobTicket content. Combined content is generated by combining the current JobTicket with all upper level JobTickets.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves the class id of IDOMJobTk.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Represents an EDL JobTicket.

EDL JobTickets provide user intent and device configuration information to printers. JobTickets can be attached only to DocumentSequence, FixedDocument and FixedPage nodes. JobTickets can provide override settings to be used when printing the node to which they are attached.

Member Function Documentation

classID()

static const CClassID & IDOMJobTk::classID ( )

inlinestatic

Retrieves the class id of IDOMJobTk.

Returns

CClassID. Class id of the element.

findChild() [1/2]

virtual IDOMJobTkNodePtr IDOMJobTk::findChild ( IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLQName & qname )

pure virtual

Searches through the node's direct child set for the node type and qname matching the information provided.

Parameters

nodeType	Node type of the the node's child to search for.
qname	Qualified name of the the node's child to search for.

Returns

IDOMJobTkNodePtr Smart pointer to the found child node.

findChild() [2/2]

virtual IDOMJobTkNodePtr IDOMJobTk::findChild ( IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLString & name, const EDLSysString & nmspace )

pure virtual

Searches through the node's direct child set for the node type, name and namespace matching the information provided.

Parameters

nodeType	Type of the node's child to search for.
name	Name of the node's child to search for.
nmspace	Namespace of the node's child to search for.

Returns

IDOMJobTkNodePtr Smart pointer to the found child node.

getCombinedContent()

virtual bool IDOMJobTk::getCombinedContent ( IDOMJobTkContentPtr & ptrCombinedContent, bool addDefaultJobTk = false )

pure virtual

Generate combined JobTicket content. Combined content is generated by combining the current JobTicket with all upper level JobTickets.

Parameters

ptrCombinedContent	A smart pointer to receive the resulting combined content.
addDefaultJobTk	If this parameter is set to "true" then combine the default level of JobTicket as well as document, job and page levels.

Returns

bool. Returns true on success, false if the call fails.

getContent()

virtual IDOMJobTkContentPtr IDOMJobTk::getContent ( ) const

pure virtual

Retrieves the JobTicket content node.

Returns

IDOMJobTkContentPtr Returns smart pointer to the JobTicket content node

getOwner()

virtual IDOMJobTkOwnerPtr IDOMJobTk::getOwner ( ) const

pure virtual

Retrieves the owner node, that is, the level of the DOMtree with which the JobTicket is associated.

Returns

IDOMNodePtr. Returns a smart pointer to the owner node.

setContent()

virtual void IDOMJobTk::setContent ( const IDOMJobTkContentPtr & ptrContent )

pure virtual

Sets the JobTicket content node.

Parameters

ptrContent

Smart pointer to the new JobTicket content node.

setOwner()

virtual void IDOMJobTk::setOwner ( IDOMJobTkOwnerPtr & ptrOwner )

pure virtual

Sets the owner node, that is, the level of the DOMtree with which the JobTicket is associated.

Parameters

ptrOwner

Smart pointer to the new owner node.

---

The documentation for this class was generated from the following file:

• idomjobtk.h