ifmeserverservice.h

Go to the documentation of this file.

#ifndef _IFMESERVERSERVICE_H
#define _IFMESERVERSERVICE_H

#include <fmeservertypes.h>
#include <ifmeservervector.h>

class IFMEServerString;
class IFMEServerStringArray;
class IFMEServerPropertyAccessor;
class IFMEServerProperty;
class IFMEServerStatus;

//===========================================================================
// Abstract Interface Class -- all methods are virtual and it has no data
class IFMEServerService
{
public:

   //-------------------------------------------------------------------
   virtual void getName(IFMEServerString& name) const = 0;

   //-------------------------------------------------------------------
   virtual void setName(const IFMEServerString& name) = 0;

   // -----------------------------------------------------------------------
   virtual void getDisplayName(IFMEServerString& displayName) const = 0;

   // -----------------------------------------------------------------------
   virtual void setDisplayName(const IFMEServerString& displayName) = 0;

   //-------------------------------------------------------------------
   virtual void getDescription(IFMEServerString& description) const = 0;

   //-------------------------------------------------------------------
   virtual void setDescription(const IFMEServerString& description) = 0;

   //-------------------------------------------------------------------
   virtual void getURLPattern(IFMEServerString& urlPattern) const = 0;

   //-------------------------------------------------------------------
   virtual void setURLPattern(const IFMEServerString& urlPattern) = 0;

   //-------------------------------------------------------------------
   virtual FME_Boolean getIsEnabled() const = 0;
   
   //-------------------------------------------------------------------
   virtual void setIsEnabled(const FME_Boolean isEnabled) = 0;
  
   // -----------------------------------------------------------------------
   virtual IFMEServerPropertyAccessor* getPropertyAccessor() const = 0;

   // -----------------------------------------------------------------------
   virtual IFMEServerStatus* updatePropertyAccessor(IFMEServerPropertyAccessor& propertyAccessor) const = 0;

   //-------------------------------------------------------------------
   virtual FME_Boolean getIsWorkspaceRegistrationAllowed() const = 0;

   //-------------------------------------------------------------------
   virtual void setIsWorkspaceRegistrationAllowed(const FME_Boolean isWorkspaceRegistrationAllowed) = 0;

   //-------------------------------------------------------------------
   virtual FME_Boolean getIsItemRegistrationAllowed(const FMEServerItemType itemType) const = 0;
   
   //-------------------------------------------------------------------
   virtual void setIsItemRegistrationAllowed(const FMEServerItemType itemType, 
                                             const FME_Boolean itemRegistrationAllowed) = 0;
   
   //-------------------------------------------------------------------
   virtual IFMEServerStatus* isItemRegistered(const IFMEServerString& repositoryName, 
                                              const IFMEServerString& itemName,
                                              FME_Boolean& itemRegistered) const = 0;

   //-------------------------------------------------------------------
   virtual IFMEServerStatus* registerItem(const IFMEServerString& repositoryName, 
                                          const IFMEServerString& itemName) = 0;

   //-------------------------------------------------------------------
   virtual IFMEServerStatus* deregisterItem(const IFMEServerString& repositoryName, 
                                            const IFMEServerString& itemName,
                                            FME_Boolean& existed) = 0;
  
   //-------------------------------------------------------------------
   virtual IFMEServerStatus* getRegisteredItems( const IFMEServerStringArray* directives,
                                                 IFMEServerItemVector& items ) = 0 ;

protected:

   // -----------------------------------------------------------------------
   // No one should be creating an instance of this directly, so we
   // make the constructor protected.
   IFMEServerService() {}

   // -----------------------------------------------------------------------
   // No one should be destroying an instance of this directly, so we
   // make the destructor protected.
   virtual ~IFMEServerService() {}

private:

   // -----------------------------------------------------------------------
   // The copy constructor is not implemented.
   IFMEServerService(const IFMEServerService &other);

   //---------------------------------------------------------------
   // The assignment operator is not implemented. 
   IFMEServerService &operator=(const IFMEServerService &other);
};


#endif