Facade::ILiveEditFacade Class Reference

Inheritance diagram for Facade::ILiveEditFacade:

Public Types
enum	{ kDefaultIID = IID_ILIVEEDITFACADE }
enum	LiveEditError {   kNoError = kICBErr_NoError, kUnknown = kICBErr_Unknown, kInvalidParameter = kICBErr_InvalidParameter, kNoDataLink = kICBErr_NoDataLink,   kBrokenLink = kICBErr_BrokenLink, kLinkIsEmbedded = kICBErr_LinkIsEmbedded, kNotNormalLink = kICBErr_NotNormalLink, kCantGetLinkFile = kICBErr_CantGetLinkFile,   kInvalidUserName = kICBErr_kInvalidUserName, kLinkIsMissing = kICBErr_kLinkIsMissing, kLastInCopyBridgeError = kLinkIsMissing }
enum	CheckInOptions {   enUnlockAsset = 0x00000001, enExportStory = 0x00000002, enSaveVersion = 0x00000004, enKeepUndoStack = 0x00000008,   enLast = 0x7FFFFFFF }

Public Member Functions
virtual ErrorCode	CancelCheckOut (const UIDList &storyList, bool16 updateStoryLink=kTrue, ICommand::Undoability undoabilityFlag=ICommand::kRegularUndo, const PMString *userName=nil, UIFlags uiFlags=kFullUI)=0
virtual ErrorCode	CheckIn (const UIDList &storyList, ILiveEditFacade::CheckInOptions opts=ILiveEditFacade::enUnlockAsset, const PMString *comment=nil, const PMString *userName=nil, ICommand::Undoability undoabilityFlag=ICommand::kAutoUndo, UIFlags uiFlags=kFullUI)=0
virtual ErrorCode	CheckOut (const UIDList &storyList, ICommand::Undoability undoabilityFlag=ICommand::kRegularUndo, const PMString *userName=nil, bool16 displayConflictAlert=kFalse, UIFlags uiFlags=kFullUI)=0
virtual ErrorCode	RelockStories (const UIDList &storyList, UIFlags uiFlags=kFullUI)=0
virtual ErrorCode	SaveStories (const UIDList &storyList, UIFlags uiFlags=kFullUI)=0
virtual ErrorCode	SynchronizeLocks (const UIDList &storyList, ICommand::Undoability undoabilityFlag=ICommand::kRegularUndo, TaskProgressBar *progressBar=nil, UIFlags uiFlags=kFullUI)=0
virtual ErrorCode	UpdateStoryLink (const UIDList &storyList, ICommand::Undoability undoabilityFlag=ICommand::kRegularUndo, PMString *commandName=nil, UIFlags uiFlags=kFullUI)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Enumeration Documentation

enum Facade::ILiveEditFacade::CheckInOptions

CheckInOptions control the subtasks performed by the CheckIn method.

Enumerator
enUnlockAsset	Releases the story lock.
enExportStory	Exports the story page item to the story file.
enSaveVersion	Saves a new version to the asset management system; has no affect if the story is not versioned.
enKeepUndoStack	Does not discard the undo stack.

Member Function Documentation

virtual ErrorCode Facade::ILiveEditFacade::CancelCheckOut ( const UIDList &  storyList, bool16  updateStoryLink = kTrue, ICommand::Undoability  undoabilityFlag = ICommand::kRegularUndo, const PMString *  userName = nil, UIFlags  uiFlags = kFullUI  )

pure virtual

Cancels the checked-out state for one or more story page items. Cancelling involves (1) reverting changes to the story applied after the story was last checked out; (2) releasing the story asset lock; (3) preventing further changes to the story page item. This method is undoable.

Parameters

storyList	contains UIDRefs of story page items.
updateStoryLink	updates the story link when kTrue.
undoabilityFlag	applies to all commands that are executed by the implementation of this method.
userName	is the same name specified on the the CheckOut() method.
uiFlags	controls UI that may be displayed to perform the cancel check out.

Returns

a predefined ErrorCode if a failure occurs, a kCancel if the operation was canceled, or kSuccess if the method completed without error.

virtual ErrorCode Facade::ILiveEditFacade::CheckIn ( const UIDList &  storyList, ILiveEditFacade::CheckInOptions  opts = ILiveEditFacade::enUnlockAsset, const PMString *  comment = nil, const PMString *  userName = nil, ICommand::Undoability  undoabilityFlag = ICommand::kAutoUndo, UIFlags  uiFlags = kFullUI  )

pure virtual

Checks in one or more stories by (1) exporting the story page item to disk (optional); (2) releasing the story asset lock (optional); (3) preventing further changes to the story page item. This method is not undoable.

Parameters

storyList	contains UIDRefs of story page items.
opts	are CheckInOptions; multiple options are or'd together. For example: ILiveEditFacade::CheckInOptions( ILiveEditFacade::enUnlockAsset | ILiveEditFacade::enExportStory ).
comment	is a ptr to a PMString containing a user checkin comment; if nil is specified, and depending on whether or not the story assets are in an asset management system, a dialog may be displayed to allow the user to enter a comment (UI is subject to UIFlags).
userName	is the same name specified on the the CheckOut() method.
undoabilityFlag	applies to all commands that are executed by the implementation of this method.
uiFlags	controls UI that may be displayed to perform the check in.

Returns

a predefined ErrorCode if a failure occurs, a kCancel if the operation was canceled, or kSuccess if the method completed without error.

virtual ErrorCode Facade::ILiveEditFacade::CheckOut ( const UIDList &  storyList, ICommand::Undoability  undoabilityFlag = ICommand::kRegularUndo, const PMString *  userName = nil, bool16  displayConflictAlert = kFalse, UIFlags  uiFlags = kFullUI  )

pure virtual

Enables editing for one or more stories by checking out the story asset and unlocking the story text frame. If at least one story is already locked by another user, the operation is cancelled with a kCancel return status. This method has no affect on stories that are already checked out to the current user, or to the userName, if specified. This method is undoable.

Parameters

storyList	contains UIDRefs of story page items.
undoabilityFlag	applies to all commands that are executed by the implementation of this method.
userName	if non-nil, specifies the user name to check the stories out to, and the story text frame is not enabled for editing. If nil, the story is checked out to the current user and the story text frame is enabled for editing.
displayConflictAlert	if kTrue, displays a conflict alert if a story could not be checked out, provided that uiFlags allow UI.
uiFlags	controls UI that may be displayed to perform the check out. Examples of UI are alerts or a dialog requesting a user name if one has not been established.

Returns

a predefined ErrorCode if a failure occurs, a kCancel if the operation was canceled, or kSuccess if the method completed without error.

virtual ErrorCode Facade::ILiveEditFacade::RelockStories ( const UIDList &  storyList, UIFlags  uiFlags = kFullUI  )

pure virtual

Relocks one or more stories. Relocking is used to maintain a lock as in the following situations: (1) In InCopy, a "Save Content As", which changes the file path for a checked-out story. (2) In InDesign, an operation that changes the UID for a locked story.

Parameters

storyList	contains UIDRefs of story page items.
uiFlags	controls UI that may be displayed.

Returns

a predefined ErrorCode if a failure occurs, a kCancel if the operation was canceled, or kSuccess if the method completed without error.

virtual ErrorCode Facade::ILiveEditFacade::SaveStories ( const UIDList &  storyList, UIFlags  uiFlags = kFullUI  )

pure virtual

Saves (exports) content for one or more stories to the respective story files.

Parameters

storyList	contains UIDRefs of story page items.
uiFlags	controls UI that may be displayed.

Returns

a predefined ErrorCode if a failure occurs, a kCancel if the operation was canceled, or kSuccess if the method completed without error.

virtual ErrorCode Facade::ILiveEditFacade::SynchronizeLocks ( const UIDList &  storyList, ICommand::Undoability  undoabilityFlag = ICommand::kRegularUndo, TaskProgressBar *  progressBar = nil, UIFlags  uiFlags = kFullUI  )

pure virtual

Synchronizes the story model lock with the story asset lock so that the two lock states agree. That is, if the story asset is checked out, the story model is assured to be unlocked for editing. Conversely, if the story asset is not checked out and a story lock is available, the story model is locked to prevent editing. This method does not change the story asset lock (the lock on the story file).

Parameters

storyList	contains UIDRefs of story page items.
undoabilityFlag	applies to all commands that are executed by the implementation of this method.
progressBar	is a valid pointer to an optional progress bar.

Returns

a predefined ErrorCode if a failure occurs, kSuccess if the method completed without error, or kCancel if a progressBar was specified and the user cancelled the operation.

virtual ErrorCode Facade::ILiveEditFacade::UpdateStoryLink ( const UIDList &  storyList, ICommand::Undoability  undoabilityFlag = ICommand::kRegularUndo, PMString *  commandName = nil, UIFlags  uiFlags = kFullUI  )

pure virtual

Updates the Link for one or more stories. Updating consists of refreshing the proxy from the content file and updating the Link data.

Parameters

storyList	contains UIDRefs of story page items.
undoabilityFlag	applies to all commands that are executed by the implementation of this method.
commandName	specifies a name for the abortable command sequence used to perform the update link operation. If nil, a default command name is used.
uiFlags	controls UI that may be displayed

Returns

a predefined ErrorCode if a failure occurs, a kCancel if the operation was canceled, or kSuccess if the method completed without error.