FME Server C++ API 3.0

ifmeserveritem.h

Go to the documentation of this file.
00001 #ifndef _IFMESERVERITEM_H
00002 #define _IFMESERVERITEM_H
00003 
00056 #include <fmeservertypes.h>
00057 #include <ifmeserverstatus.h>
00058 
00059 class IFMEServerString ;
00060 
00061 //===========================================================================
00062 // Abstract Interface Class -- all methods are virtual and it has no data
00063 class IFMEServerItem
00064 {
00065 public:
00066 
00067    // -----------------------------------------------------------------------
00078    virtual void getName( IFMEServerString& name ) const = 0 ;
00079 
00080    // -----------------------------------------------------------------------
00084    virtual void getRepositoryName( IFMEServerString& repositoryName ) const = 0 ;
00085 
00086    // -----------------------------------------------------------------------
00090    virtual FMEServerItemType getType() const = 0 ;
00091 
00092    // -----------------------------------------------------------------------
00096    virtual void getTitle( IFMEServerString& title ) const = 0 ;
00097 
00098    // -----------------------------------------------------------------------
00102    virtual void getDescription( IFMEServerString& description ) const = 0 ;
00103 
00104    // -----------------------------------------------------------------------
00108    virtual FME_UInt32 getFileSize() const = 0 ;
00109 
00110    // -----------------------------------------------------------------------
00114    virtual void getCategory( IFMEServerString& category ) const = 0 ;
00115 
00116    // -----------------------------------------------------------------------
00120    virtual void getRequirements( IFMEServerString& requirements ) const = 0 ;
00121 
00122    // -----------------------------------------------------------------------
00126    virtual void getRequirementsKeyword( IFMEServerString& requirementsKeyword ) const = 0 ;
00127 
00128    // -----------------------------------------------------------------------
00132    virtual void getUsage( IFMEServerString& usage ) const = 0 ;
00133 
00134    // -----------------------------------------------------------------------
00138    virtual void getHistory( IFMEServerString& history ) const = 0 ;
00139 
00140    // -----------------------------------------------------------------------
00144    virtual void getLastSaveDate( IFMEServerString& lastSaveDate ) const = 0 ;
00145 
00146    // -----------------------------------------------------------------------
00150    virtual void getLastSaveBuild( IFMEServerString& lastSaveBuild ) const = 0 ;
00151 
00152    // -----------------------------------------------------------------------
00156    virtual FME_UInt32 getBuildNumber() const = 0 ;
00157 
00158    // -----------------------------------------------------------------------
00162    virtual void getLegalTermsConditions( IFMEServerString& legalTermsConditions ) const = 0 ;
00163 
00164 protected:
00165 
00166    // -----------------------------------------------------------------------
00167    // No one should be creating an instance of this directly, so we make the
00168    // constructor protected.
00169    IFMEServerItem() {}
00170 
00171    // -----------------------------------------------------------------------
00172    // No one should be destroying an instance of this directly, so we make the
00173    // destructor protected.
00174    virtual ~IFMEServerItem() {}
00175 
00176 private:
00177 
00178    // -----------------------------------------------------------------------
00179    // The copy constructor is not implemented.
00180    IFMEServerItem( const IFMEServerItem& other ) ;
00181 
00182    // -----------------------------------------------------------------------
00183    // The assignment operator is not implemented. 
00184    IFMEServerItem& operator=( const IFMEServerItem& other ) ;
00185 
00186 } ;
00187 
00188 #endif
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines