IUpdatePreflightProfileCmdData Class Reference

#include <IUpdatePreflightProfileCmdData.h>

Inheritance diagram for IUpdatePreflightProfileCmdData:

Public Types
enum	{ kDefaultIID = IID_IUPDATEPREFLIGHTPROFILECMDDATA }

Public Member Functions
virtual void	SetDstProfile (const UIDRef &dstProfileRef)=0
virtual UIDRef	GetDstProfile () const =0
virtual void	SetNew (const IPreflightProfile *iSrcProfile, bool copyNamesOnly)=0
virtual bool	GetCopyNamesOnly () const =0
virtual IPreflightProfile *	QueryNewProfile () const =0
virtual void	SetOld (const IPreflightProfile *iCurProfile)=0
virtual IPreflightProfile *	QueryOldProfile () const =0
virtual void	SetWhatChanged (IPreflightProfileUtils::ProfileChangeFlags flags)=0
virtual IPreflightProfileUtils::ProfileChangeFlags	GetWhatChanged () const =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

This interface provides the settings to accompany an UpdatePreflightProfile command. The UpdatePreflightProfile command modifies an existing profile with new settings. You can also perform this operation through IPreflightFacade.

Member Function Documentation

virtual bool IUpdatePreflightProfileCmdData::GetCopyNamesOnly ( ) const

pure virtual

Return whether to copy only the names (ie IPreflightProfile members); or whether to deep-copy the entire profile.

Returns

True to do only a name-copy; False to do a deep, full copy.

virtual UIDRef IUpdatePreflightProfileCmdData::GetDstProfile ( ) const

pure virtual

Get the profile this command will modify.

Returns

The UIDRef of the target profile.

virtual IPreflightProfileUtils::ProfileChangeFlags IUpdatePreflightProfileCmdData::GetWhatChanged ( ) const

pure virtual

Get a rough idea of what the command changed. This is set up once the command has executed. It's useful for observers that want to know what might have changed.

Returns

A set of the change flags.

virtual IPreflightProfile* IUpdatePreflightProfileCmdData::QueryNewProfile ( ) const

pure virtual

Returns

the (refcounted) source data that will be applied to the DstProfile, or nil if SetNew has not been called.

Note

this is an in-memory COPY of the data passed into the SetNew method.

virtual IPreflightProfile* IUpdatePreflightProfileCmdData::QueryOldProfile ( ) const

pure virtual

Get the old data for the DstProfile. This allows observers to see the old vs the new data to see if the change is something they're concerned with.

Returns

A refcounted interface to the old profile data.

virtual void IUpdatePreflightProfileCmdData::SetDstProfile ( const UIDRef &  dstProfileRef )

pure virtual

Set the destination profile.

Parameters

dstProfileRef

IN The profile you want the command to modify.

virtual void IUpdatePreflightProfileCmdData::SetNew ( const IPreflightProfile *  iSrcProfile, bool  copyNamesOnly  )

pure virtual

Set the "new" data for the command (ie the new profile data you want to set). This method MAKES A COPY of the profile data. If copyNamesOnly is false then it also makes a copy of the profile's other data (namely, rules).

Parameters

iSrcProfile	IN The profile data you want to apply to the DstProfile.
copyNamesOnly	IN True if all you want to set are the names in the IPreflightProfile interface. False if you want to make a complete copy of the profile data. If True then ONLY iSrcProfile is considered. If false then the method will Query the rules interface from iSrcProfile and make a copy of that too.

virtual void IUpdatePreflightProfileCmdData::SetOld ( const IPreflightProfile *  iCurProfile )

pure virtual

Set the old data for the DstProfile. This is set up when the command is executed. Only the command itself should call this method.

Parameters

iCurProfile

IN The current state of the profile prior to making changes.

virtual void IUpdatePreflightProfileCmdData::SetWhatChanged ( IPreflightProfileUtils::ProfileChangeFlags  flags )

pure virtual

Set what changed. This is called by the command itself; you shouldn't call it.

Parameters

flags

IN The new change flags.