IAssignmentPackageUIFacade Class Reference

#include <IAssignmentPackageUIFacade.h>

Inheritance diagram for IAssignmentPackageUIFacade:

Public Types
enum	{ kDefaultIID = IID_IASSIGNMENTPACKAGEUIFACADE }

Public Member Functions
virtual bool16	CanPackage () const =0
virtual ErrorCode	Package (bool16 email=kFalse)=0
virtual bool16	EnableUpdatePackage () const =0
virtual ErrorCode	UpdatePackage (bool16 email=kFalse)=0
virtual bool16	CanForwardPackage () const =0
virtual ErrorCode	ForwardPackage (bool16 email=kFalse)=0
virtual bool16	CanReturnPackage () const =0
virtual ErrorCode	ReturnPackage (bool16 email=kFalse)=0
virtual bool16	CanOpenPackage () const =0
virtual ErrorCode	OpenPackage (UIDRef &openDocRef)=0
virtual bool16	CanCancelPackage () const =0
virtual ErrorCode	CancelPackage ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IAssignmentPackageUIFacade is an utility functions to help to enable and process the package menu items on assignment panel

Member Function Documentation

virtual bool16 IAssignmentPackageUIFacade::CanCancelPackage ( ) const

pure virtual

Can cancel package

Returns

kTrue if the can cancel

virtual ErrorCode IAssignmentPackageUIFacade::CancelPackage ( )

pure virtual

Cancels package

Returns

An error code indicating whether the package cancel operation succeeded or not.

virtual bool16 IAssignmentPackageUIFacade::CanForwardPackage ( ) const

pure virtual

Can forward packaged assignment to InCopy user

Returns

kTrue if the panel items can be packaged

virtual bool16 IAssignmentPackageUIFacade::CanOpenPackage ( ) const

pure virtual

Can open package

Returns

kTrue if the can open

virtual bool16 IAssignmentPackageUIFacade::CanPackage ( ) const

pure virtual

Can package selected assignment

Returns

kTrue if the panel items can be packaged

virtual bool16 IAssignmentPackageUIFacade::CanReturnPackage ( ) const

pure virtual

Can return packaged assignment to InDesign user

Returns

kTrue if the panel items can be packaged

virtual bool16 IAssignmentPackageUIFacade::EnableUpdatePackage ( ) const

pure virtual

Whether or not update package is enabled. This is true when there is a single packaged assignment selected that is out of date or has been updated since packaged.

Returns

kTrue if the can update

virtual ErrorCode IAssignmentPackageUIFacade::ForwardPackage ( bool16  email = kFalse )

pure virtual

Forward package assignment to InCopy user

Parameters

email

a boolean to indicate whether package and email

Returns

An error code indicating whether the package operation succeeded or not.

virtual ErrorCode IAssignmentPackageUIFacade::OpenPackage ( UIDRef &  openDocRef )

pure virtual

Opens package: prompts user for assignment package file to open and opens the selected file.

Parameters

openedDocRef

OUT the open document, if one opened

Returns

An error code indicating whether the package open operation succeeded or not, could be kCancel if user cancelled.

virtual ErrorCode IAssignmentPackageUIFacade::Package ( bool16  email = kFalse )

pure virtual

Package all selected items

Parameters

email

a boolean to indicate whether package and email

Returns

An error code indicating whether the package operation succeeded or not.

virtual ErrorCode IAssignmentPackageUIFacade::ReturnPackage ( bool16  email = kFalse )

pure virtual

Return package assignment to InDesign user

Parameters

email

a boolean to indicate whether package and email

Returns

An error code indicating whether the package operation succeeded or not.

virtual ErrorCode IAssignmentPackageUIFacade::UpdatePackage ( bool16  email = kFalse )

pure virtual

Updates the package; convenience method that performs a cancel package then a package.

Returns

An error code indicating whether the update package operation succeeded or not.