#include <LinkResourceStatePacket.h>

Inheritance diagram for LinkResourceStatePacket:

Public Member Functions
	LinkResourceStatePacket (ILinkManager::OperationType opType, bool bNotify, IDataBase *db, const UID &uid, const URI &uri, ILinkResource::ResourceState state, const WideString &stamp, const IDTime &modTime, uint64 size)

virtual	~LinkResourceStatePacket ()

bool	operator== (const LinkResourceStatePacket &rhs) const

ILinkManager::OperationType	GetOperationType () const

bool	GetNotify () const

IDataBase *	GetDatabase () const

UID	GetResource () const

URI	GetURI () const

void	SetURI (const URI &uri)

bool	URIChanged ()

ILinkResource::ResourceState	GetState () const

void	SetState (ILinkResource::ResourceState state)

bool	StateChanged ()

WideString	GetStamp () const

void	SetStamp (const WideString &stamp)

bool	StampChanged ()

IDTime	GetModTime () const

void	SetModTime (const IDTime &modTime)

bool	ModTimeChanged ()

uint64	GetSize () const

void	SetSize (uint64 size)

bool	SizeChanged ()

bool	LinkResourceChanged ()

Public Member Functions inherited from AsyncWorkPacket
virtual	~AsyncWorkPacket ()

Additional Inherited Members
Public Types inherited from AsyncWorkPacket
enum	Priority { kLowestPriority = 0, kLowPriority = 0, kNormalPriority = 1, kHighPriority = 2, kHighestPriority = 2, kReservedForceCompletionPriority = 3 }

Detailed Description

InDesign class used to contain information about a link resource that is used while updating the state of the resource and/or automatically resolveing a missing resource's new location.

See Also: ILinkResource; URI

Constructor & Destructor Documentation

LinkResourceStatePacket::LinkResourceStatePacket	(	ILinkManager::OperationType	opType,
		bool	bNotify,
		IDataBase *	db,
		const UID &	uid,
		const URI &	uri,
		ILinkResource::ResourceState	state,
		const WideString &	stamp,
		const IDTime &	modTime,
		uint64	size
	)

Default constructor. Constructs a LinkResourceStatePacket object.

Parameters

opType	[IN] Type of state update operation performed.
bNotify	[IN] Denotes whether the state update should notify if the model is changed in the callback.
db	[IN] Database that contains the link resource.
uid	[IN] UID of a link resource.
uri	[IN] URI of a link resource.
state	[IN] State of a link resource.
stamp	[IN] Stamp of the link resource.
modTime	[IN] Modification time of the link resource.
size	[IN] Size of the link resource in bytes.

virtual LinkResourceStatePacket::~LinkResourceStatePacket ( )

virtual

Destructor. Destroys the LinkResourceStatePacket object.

Member Function Documentation

IDataBase* LinkResourceStatePacket::GetDatabase ( ) const

inline

Returns the database that contains the link resource this packet pertains to. \ NOTE: Never access the database from a link resource state processor that is executing on a thread. Access is OK if the processor is executing in the idle task.

Returns: Database that contains the link resource this packet pertains to.

IDTime LinkResourceStatePacket::GetModTime ( ) const

inline

Returns the modification time of the link resource.

Returns: Stamp of the link resource.

bool LinkResourceStatePacket::GetNotify ( ) const

inline

Returns whether the state update should notify if the model is changed in the callback.

Returns: True if the state update should notify, else false.

ILinkManager::OperationType LinkResourceStatePacket::GetOperationType ( ) const

inline

Returns the type type of state update operation performed; asynchronous or synchronous.

Returns: Type of state update operation performed.

UID LinkResourceStatePacket::GetResource ( ) const

inline

Returns the UID of the link resource.

Returns: UID of the link resource.

uint64 LinkResourceStatePacket::GetSize ( void ) const

inline

Returns the byte size of the link resource.

Returns: Byte size of the link resource.

WideString LinkResourceStatePacket::GetStamp ( ) const

inline

Returns the stamp of the link resource.

Returns: Stamp of the link resource.

ILinkResource::ResourceState LinkResourceStatePacket::GetState ( void ) const

inline

Returns the state of the link resource.

Returns: State of the link resource.

URI LinkResourceStatePacket::GetURI ( ) const

inline

Returns the URI of the link resource.

Returns: URI of the link resource.

bool LinkResourceStatePacket::LinkResourceChanged ( )

inline

Determines whether the link resource has changed.

Returns: True if link resource has changed, else false.

bool LinkResourceStatePacket::ModTimeChanged ( )

inline

Determines whether the link resource's modification time has changed.

Returns: True if link resource's modification time has changed, else false.

bool LinkResourceStatePacket::operator== ( const LinkResourceStatePacket & rhs ) const

Equality operator. Test whether this LinkResourceStatePacket is equal to the given LinkResourceStatePacket.

Parameters

rhs	[IN] LinkResourceStatePacket to test for equality against this LinkResourceStatePacket.

Returns: True if this LinkResourceStatePacket is equal to the given LinkResourceStatePacket, else false.

void LinkResourceStatePacket::SetModTime ( const IDTime & modTime )

Sets the new modification time of the link resource.

Parameters

stamp [IN] New stamp of the link resource.

void LinkResourceStatePacket::SetSize ( uint64 size )

Sets the new byte size of the link resource.

Parameters

stamp [IN] New byte size of the link resource.

void LinkResourceStatePacket::SetStamp ( const WideString & stamp )

Sets the new stamp of the link resource.

Parameters

stamp [IN] New stamp of the link resource.

void LinkResourceStatePacket::SetState ( ILinkResource::ResourceState state )

Sets the new state of a link resource.

Parameters

state [IN] New state of a link resource.

void LinkResourceStatePacket::SetURI ( const URI & uri )

Sets the new URI of the link resource.

Parameters

uri	[IN] New URI of a link resource.

bool LinkResourceStatePacket::SizeChanged ( )

inline

Determines whether the link resource's byte size has changed.

Returns: True if link resource's byte size has changed, else false.

bool LinkResourceStatePacket::StampChanged ( )

inline

Determines whether the link resource's stamp has changed.

Returns: True if link resource's stamp has changed, else false.

bool LinkResourceStatePacket::StateChanged ( )

inline

Determines whether the link resource's state has changed.

Returns: True if link resource's state has changed, else false.

bool LinkResourceStatePacket::URIChanged ( )

inline

Determines whether the link resource's URI has changed.

Returns: True if link resource's URI has changed, else false.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation