SnpRunnable.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 _SnpRunnable_
#define _SnpRunnable_

// General includes:
#include "BaseType.h"

// Project includes:
#include "SnipRunID.h"
#include "IActiveContext.h"
#include "ISnpRunnableContext.h"
#include "SnpReferenceMacros.h"
#include "ISnipRunSuite.h"

class SnpRunnable
{
 public:
 SnpRunnable(ConstCString name);

 virtual ~SnpRunnable();

 virtual ConstCString GetName() const {return fName;}

 virtual ConstCString GetDescription() const {return fDescription;}

 virtual ConstCString GetPreconditions() const {return fPreconditions;};

 virtual ConstCString GetCategories() const {return fCategories;}

 virtual bool16 CanRun(ISnpRunnableContext* runnableContext) = 0;

 virtual ErrorCode Run(ISnpRunnableContext* runnableContext) = 0;

 virtual ErrorCode RunUnitTest(ISnpRunnableContext* runnableContext);

 virtual bool16 CanLoad() const {return kTrue;}

 virtual ErrorCode SetupContext(ISnpRunnableContext* runnableContext);

 virtual ISnipRunSuite::eSnpRunContextType GetContext(void) = 0;

 protected:
 // The protected methods in this section must be called
 // by the derived class's constructor. The strings a snippet 
 // author provides will be made available via ISnipRunSuite
 // and displayed in the UI.

 virtual void SetDescription(ConstCString description) {fDescription = description;}
 virtual void SetPreconditions(ConstCString preconditions) {fPreconditions = preconditions;}
 virtual void SetCategories(ConstCString categories) {fCategories = categories;}

 private:
 ConstCString fName;
 ConstCString fDescription;
 ConstCString fPreconditions;
 ConstCString fCategories;
};

#endif // SnpRunnable

// End, SnpRunnable.h