FME Server C++ API 3.0

IFMEServerWorkspaceSummary Class Reference

IFMEServerWorkspaceSummary interface. More...

#include <ifmeserverworkspacesummary.h>

List of all members.

Public Member Functions

virtual void getDescription (IFMEServerString &description) const =0
virtual FME_Boolean getIsEnabled () const =0
virtual void getName (IFMEServerString &name) const =0
virtual void getTitle (IFMEServerString &title) const =0

Protected Member Functions

 IFMEServerWorkspaceSummary ()
virtual ~IFMEServerWorkspaceSummary ()

Private Member Functions

 IFMEServerWorkspaceSummary (const IFMEServerWorkspaceSummary &other)
IFMEServerWorkspaceSummaryoperator= (const IFMEServerWorkspaceSummary &other)

Detailed Description

IFMEServerWorkspaceSummary interface.

Package Overview:

This file defines the interface that subclasses of this class MUST follow.

Developers MUST NOT implement their own subclasses of this, instead, the FME will ALWAYS provide them with the subclass instance they should be using.


Constructor & Destructor Documentation

IFMEServerWorkspaceSummary::IFMEServerWorkspaceSummary ( ) [inline, protected]
virtual IFMEServerWorkspaceSummary::~IFMEServerWorkspaceSummary ( ) [inline, protected, virtual]
IFMEServerWorkspaceSummary::IFMEServerWorkspaceSummary ( const IFMEServerWorkspaceSummary other) [private]

Member Function Documentation

virtual void IFMEServerWorkspaceSummary::getDescription ( IFMEServerString description) const [pure virtual]

Gets a description of the workspace.

Parameters:
returnsa description of the workspace
virtual FME_Boolean IFMEServerWorkspaceSummary::getIsEnabled ( ) const [pure virtual]

Gets a boolean representing whether or not this workspace is currently enabled

Returns:
a boolean representing whether or not this workspace is currently enabled
virtual void IFMEServerWorkspaceSummary::getName ( IFMEServerString name) const [pure virtual]

Gets the name of the workspace.

Parameters:
namereturns the name of the workspace
virtual void IFMEServerWorkspaceSummary::getTitle ( IFMEServerString title) const [pure virtual]

Gets the title of the workspace.

Parameters:
titlereturns the title of the workspace
IFMEServerWorkspaceSummary& IFMEServerWorkspaceSummary::operator= ( const IFMEServerWorkspaceSummary other) [private]

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines