#include <ILinkResourceStateUpdateCmdData.h>

Inheritance diagram for ILinkResourceStateUpdateCmdData:

Public Types
enum	{ kDefaultIID = IID_ILINKRESOURCESTATEUPDATECMDDATA }

enum	UpdateAction { kUpdateURI = 1, kUpdateState, kUpdateStamp, kUpdateModTime, kUpdateSize }

Public Member Functions
virtual void	SetUpdateAction (UpdateAction action)=0

virtual UpdateAction	GetUpdateAction () const =0

virtual void	SetDatabase (IDataBase *db)=0

virtual IDataBase *	GetDatabase () const =0

virtual void	SetResource (const UID &uid)=0

virtual const UID &	GetResource () const =0

virtual void	SetURI (const URI &uri)=0

virtual const URI &	GetURI () const =0

virtual void	SetState (ILinkResource::ResourceState state)=0

virtual ILinkResource::ResourceState	GetState () const =0

virtual void	SetStamp (const WideString &stamp)=0

virtual const WideString &	GetStamp () const =0

virtual void	SetModTime (const IDTime &modTime)=0

virtual const IDTime &	GetModTime () const =0

virtual void	SetSize (uint64 size)=0

virtual uint64	GetSize () const =0

virtual void	SetMarkLinksModified (bool bMarkLinksModified)=0

virtual bool	GetMarkLinksModified () const =0

virtual void	SetDatabaseModified (bool16 bDbModified=kFalse)=0

virtual bool16	GetDatabaseModified () const =0

virtual void	SetNotify (bool bNotify)=0

virtual bool	GetNotify () 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

Data interface used by the LinkResourceStateUpdateCmd which is used to update a link resource's URI, stamp and state.

Member Enumeration Documentation

enum ILinkResourceStateUpdateCmdData::UpdateAction

Identifiers that denote the type of update action to be performed by the LinkResourceStateUpdateCmd on the link resource with the given UID.
Enumerator
kUpdateURI
Update the resource's URI.
kUpdateState
Update the resource's state, stamp, modification time and size.
kUpdateStamp
Update the resource's stamp, modification time and size.
kUpdateModTime
Update the resource's modification time only.
kUpdateSize
Update the resource's size only.

Member Function Documentation

virtual IDataBase* ILinkResourceStateUpdateCmdData::GetDatabase ( ) const

pure virtual

Returns the database to be targeted by the state update command.

Returns: Database target.

virtual bool16 ILinkResourceStateUpdateCmdData::GetDatabaseModified ( ) const

pure virtual

Returns true if the document is to be set to dirty after the command executes

virtual bool ILinkResourceStateUpdateCmdData::GetMarkLinksModified ( ) const

pure virtual

Returns whether links referencing the resource are allowed to be marked modified. \ Normally any changes to the resource that might result in links being out-of-date will cause the links referencing the resource to be marked modified. \ Setting the MarkLinksModified flag to false has the following implications:\

Prevents the modification state of any link referencing the resource from being changed. \
If a link is not already marked modified and the resource's stamp is different than the the link's import stamp, then the link's import stamp and import modification time will be updated to match the resource's stamp and modification date/time. \ By default, the MarkLinksModified flag is set to true, which allows referencing links to be set as modified. This flag should only be marked false for exceptional/unusual circumstances.
Returns
True if links referencing the resource can be marked modified, else false.

virtual const IDTime& ILinkResourceStateUpdateCmdData::GetModTime ( ) const

pure virtual

Returns the new modification time of the resource.

Returns: Resource's new modification time.

virtual bool ILinkResourceStateUpdateCmdData::GetNotify ( ) const

pure virtual

DEPRECATED - there is no way to prevent notification. Returns whether to notify about the changed resource.

Returns: True to notify, else false.

virtual const UID& ILinkResourceStateUpdateCmdData::GetResource ( ) const

pure virtual

Returns the UID of the link resource to update.

Returns: Resource UID.

virtual uint64 ILinkResourceStateUpdateCmdData::GetSize ( ) const

pure virtual

Returns the new data size of the resource.

Returns: Resource's new data size.

virtual const WideString& ILinkResourceStateUpdateCmdData::GetStamp ( ) const

pure virtual

Returns the new stamp of the resource.

Returns: Resource's new stamp.

virtual ILinkResource::ResourceState ILinkResourceStateUpdateCmdData::GetState ( ) const

pure virtual

Returns the new state of the resource.

Returns: Resource's new state.

virtual UpdateAction ILinkResourceStateUpdateCmdData::GetUpdateAction ( ) const

pure virtual

Returns the UpdateAction to be performed by the state update command.

Returns: UpdateAction to be performed.

virtual const URI& ILinkResourceStateUpdateCmdData::GetURI ( ) const

pure virtual

Returns the new URI of the resource.

Returns: Resource's new URI.

virtual void ILinkResourceStateUpdateCmdData::SetDatabase ( IDataBase * db )

pure virtual

Sets the database to be targeted by the state update command.

Parameters

db	[IN] Database target.

virtual void ILinkResourceStateUpdateCmdData::SetDatabaseModified ( bool16 bDbModified = kFalse )

pure virtual

Sets the document state to dirty if set true

Parameters

bDbModified[IN] set to kTrue to make doc dirty

virtual void ILinkResourceStateUpdateCmdData::SetMarkLinksModified ( bool bMarkLinksModified )

pure virtual

Sets whether links referencing the resource are allowed to be marked modified. \ Normally any changes to the resource that might result in links being out-of-date will cause the links referencing the resource to be marked modified. \ Setting the MarkLinksModified flag to false has the following implications:\

Prevents the modification state of any link referencing the resource from being changed. \
If a link is not already marked modified and the resource's stamp is different than the the link's import stamp, then the link's import stamp and import modification time will be updated to match the resource's stamp and modification date/time. \ By default, the MarkLinksModified flag is set to true, which allows referencing links to be set as modified. This flag should only be marked false for exceptional/unusual circumstances.
Parameters
bMarkLinksModified [IN] Boolean denoting whether the links referencing the resource are allowed to be marked modified.

virtual void ILinkResourceStateUpdateCmdData::SetModTime ( const IDTime & modTime )

pure virtual

Sets the new modification time of the resource.

Parameters

modTime [IN] Resource's new modification time.

virtual void ILinkResourceStateUpdateCmdData::SetNotify ( bool bNotify )

pure virtual

DEPRECATED - there is no way to prevent notification. Sets whether to notify about the changed resource.

Parameters

bNotify [IN] True to notify, else false.

virtual void ILinkResourceStateUpdateCmdData::SetResource ( const UID & uid )

pure virtual

Sets the UID of the link resource to update.

Parameters

uid	[IN] Resource UID.

virtual void ILinkResourceStateUpdateCmdData::SetSize ( uint64 size )

pure virtual

Sets the new data size of the resource.

Parameters

size	[IN] Resource's new data size.

virtual void ILinkResourceStateUpdateCmdData::SetStamp ( const WideString & stamp )

pure virtual

Sets the new stamp of the resource.

Parameters

stamp [IN] Resource's new stamp.

virtual void ILinkResourceStateUpdateCmdData::SetState ( ILinkResource::ResourceState state )

pure virtual

Sets the new state of the resource.

Parameters

state [IN] Resource's new state.

virtual void ILinkResourceStateUpdateCmdData::SetUpdateAction ( UpdateAction action )

pure virtual

Sets the UpdateAction to be performed by the state update command.

Parameters

action [IN] UpdateAction to be performed.

virtual void ILinkResourceStateUpdateCmdData::SetURI ( const URI & uri )

pure virtual

Sets the new URI of the resource.

Parameters

uri	[IN] Resource's new URI.

Enumerator
kUpdateURI	Update the resource's URI.
kUpdateState	Update the resource's state, stamp, modification time and size.
kUpdateStamp	Update the resource's stamp, modification time and size.
kUpdateModTime	Update the resource's modification time only.
kUpdateSize	Update the resource's size only.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation