IManagedStatus.h

//========================================================================================
// 
// $File$
// 
// Owner: Bill Tislar
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IMANAGEDSTATUS__
#define __IMANAGEDSTATUS__

#include "IPMUnknown.h"
#include "workgroupid.h"

#include <map>
#include <vector>

class IAMStatusListener;
class IManageableAsset;

class IManagedStatus : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMANAGEDSTATUS };
 
 typedef std::vector<UIDRef> UIDRefList;
 typedef std::map<int32, PMString> StatusStringTable;
 typedef std::map<int32, PMRsrcID> StatusIconTable;
 typedef std::vector<IAMStatusListener*> ListenerList;
 
 enum EditingState
 {
 enUnknownEditingState = 0,
 enNotEditing = 1,
 enEditingLocally = 2,
 enEditingRemotely = 3,
 enEditingConflict = 4
 };

 enum VersionState
 {
 enUnknownVersionState = 0,
 enUpToDate = 1,
 enLocalIsNewer = 2,
 enLocalIsOutOfDate = 3,
 enVersionConflict = 4
 };

 enum WGStatusType
 {
 enInvalidWGStatus = 0,
 enGeneralStatus = kWorkgroupPrefix + 1,
 enContent = kWorkgroupPrefix + 2,
 enEditing = kWorkgroupPrefix + 3,
 enToolTip = kWorkgroupPrefix + 4,
 
 //NOT USED = kWorkgroupPrefix + 5,
 
 enLockOwner = kWorkgroupPrefix + 6,
 enCurrentUser = kWorkgroupPrefix + 7,
 enLockClient = kWorkgroupPrefix + 8,
 enCurrentClient = kWorkgroupPrefix + 9,
 enCheckedOutBy = kWorkgroupPrefix + 10,
 enCheckedOutApp = kWorkgroupPrefix + 11,
 enCheckedOutDoc = kWorkgroupPrefix + 12
 };

 
 virtual void AddListener( UIDRef listenerRef ) = 0;

 virtual void AddNonPersistentListener( IAMStatusListener * listener ) = 0;
 
 virtual UIDRef GetAsset() = 0;
 
 virtual IManagedStatus::EditingState GetEditingState() = 0;
 
 virtual RsrcID GetIconID( int32 iconType ) = 0;

 virtual int32 GetListeners( IManagedStatus::UIDRefList & listeners ) = 0;

 virtual int32 GetNonPersistentListeners( IManagedStatus::ListenerList & listeners ) = 0;
 
 virtual bool16 GetStatusString( int32 stringType, PMString & outString ) = 0;
 
 virtual IManagedStatus::VersionState GetVersionState() = 0;
 
 virtual void ImportListeners( IManagedStatus * sourceStatus ) = 0;
 
 virtual bool16 IsOnline() = 0;
 
 virtual void RemoveListener( UIDRef listenerRef ) = 0;

 virtual void RemoveNonPersistentListener( IAMStatusListener * listener ) = 0;
 
 virtual void SetAsset( UIDRef assetRef ) = 0;
 
 virtual bool16 Update( bool16 isOnline,
 IManagedStatus::EditingState editingState, 
 IManagedStatus::VersionState versionState,
 const IManagedStatus::StatusStringTable & inStatusStrings,
 const IManagedStatus::StatusIconTable & inStatusIcons
 ) = 0;
 
 virtual void GetDisplayStatusData( IManagedStatus::StatusStringTable & outStatusStrings, IManagedStatus::StatusIconTable & outStatusIcons ) = 0;
 
 virtual bool16 Update( const IManagedStatus::StatusStringTable & inStatusStrings, const IManagedStatus::StatusIconTable & inStatusIcons ) = 0; 

 virtual PMRsrcID GetIconPMRsrcID( int32 iconType ) = 0;

protected: 

 virtual void NotifyListeners() = 0;
 
}; // end IManagedStatus interface

#endif // __IMANAGEDSTATUS__