IAMLockable.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 __IAMLOCKABLE__
#define __IAMLOCKABLE__

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

#include <map>

class IAMLockable : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IAMLOCKABLE };
 

 enum LockState
 {
 enUndefined = 0, 
 enUnavailable, 
 enAvailable, 
 enLocked, 
 enCheckedOut
 };

 virtual bool16 IsLocked() = 0;
 
 virtual bool16 HasLock( UID objectUID = kInvalidUID ) = 0;
 
 virtual IAMLockable::LockState GetLockState( UID objectUID = kInvalidUID ) = 0;
 
 virtual UID GetLockObjectUID() = 0;
 
 virtual void GetLockStatusStrings( std::map<int32, PMString> & stringTable ) = 0;
 
 virtual bool16 Lock( UIFlags uiFlags = kFullUI, bool16 allowOverride = kFalse, const PMString *userName = nil, UID objectUID = kInvalidUID ) = 0;
 
 virtual bool16 Relock( UIFlags uiFlags = kFullUI, bool16 allowOverride = kFalse, UID objectUID = kInvalidUID ) = 0;
 
 virtual bool16 Unlock( UIFlags uiFlags = kFullUI, bool16 allowOverride = kFalse, UID objectUID = kInvalidUID ) = 0;
 
 virtual IAMLockable::LockState VerifyState( UIFlags uiFlags = kFullUI, UID objectUID = kInvalidUID ) = 0;

 virtual bool16 IsLocked( const PMString & userName ) = 0;
}; // end IAMLockable interface

#endif // __IAMLOCKABLE__