IFMEServerWorkspace Class Reference

IFMEServerWorkspace interface. More...

#include <ifmeserverworkspace.h>

List of all members.

Public Member Functions
virtual void	getDescription (IFMEServerString &description) const =0
virtual IFMEServerDatasetVector *	getDestinationDatasets () const =0
virtual IFMEServerFeatureTypeVector *	getDestinationFeatureTypes () const =0
virtual FME_UInt32	getFileSize () const =0
virtual FME_Boolean	getIsEnabled () const =0
virtual void	getName (IFMEServerString &name) const =0
virtual IFMEServerParameterVector *	getParameters () const =0
virtual IFMEServerPropertyAccessor *	getPropertyAccessor () const =0
virtual IFMEServerResourceVector *	getResources () const =0
virtual IFMEServerDatasetVector *	getSourceDatasets () const =0
virtual IFMEServerFeatureTypeVector *	getSourceFeatureTypes () const =0
virtual void	getTitle (IFMEServerString &title) const =0
virtual IFMEServerStatus *	updatePropertyAccessor (IFMEServerPropertyAccessor &propertyAccessor) const =0
Protected Member Functions
	IFMEServerWorkspace ()
virtual	~IFMEServerWorkspace ()
Private Member Functions
	IFMEServerWorkspace (const IFMEServerWorkspace &other)
IFMEServerWorkspace &	operator= (const IFMEServerWorkspace &other)

---

Detailed Description

IFMEServerWorkspace 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

IFMEServerWorkspace::IFMEServerWorkspace

(

)

[inline, protected]

virtual IFMEServerWorkspace::~IFMEServerWorkspace

(

)

[inline, protected, virtual]

IFMEServerWorkspace::IFMEServerWorkspace

(

const IFMEServerWorkspace &

other

)

[private]

---

Member Function Documentation

virtual void IFMEServerWorkspace::getDescription

(

IFMEServerString &

description

)

const [pure virtual]

Gets a description of the workspace.

Parameters:

description

returns a description of the workspace

virtual IFMEServerDatasetVector* IFMEServerWorkspace::getDestinationDatasets

(

)

const [pure virtual]

Gets the workspace's destination datasets.

Returns:

a list of all of the workspace's destination datasets

virtual IFMEServerFeatureTypeVector* IFMEServerWorkspace::getDestinationFeatureTypes

(

)

const [pure virtual]

Gets all the feature types belonging to the destination datasets of this workspace. This information is also available by calling getDestinationDatasets() and then calling getFeatureTypes() on each destination dataset.

Returns:

a list of all the feature types belonging to the destination datasets of this workspace

See also:

getDestinationDatasets()

virtual FME_UInt32 IFMEServerWorkspace::getFileSize

(

)

const [pure virtual]

Gets the file size of the workspace.

Returns:

the file size of the workspace

virtual FME_Boolean IFMEServerWorkspace::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 IFMEServerWorkspace::getName

(

IFMEServerString &

name

)

const [pure virtual]

Gets the name of the workspace.

Parameters:

name	returns the name of the workspace

virtual IFMEServerParameterVector* IFMEServerWorkspace::getParameters

(

)

const [pure virtual]

Gets all the published parameters of the workspace.

Returns:

a list of all the workspace's published parameters

virtual IFMEServerPropertyAccessor* IFMEServerWorkspace::getPropertyAccessor

(

)

const [pure virtual]

Gets a property manager to manage workspace properties.

Returns:

a property manager

virtual IFMEServerResourceVector* IFMEServerWorkspace::getResources

(

)

const [pure virtual]

Gets all the resources of the workspace.

Returns:

a list of all of the workspace's resources

virtual IFMEServerDatasetVector* IFMEServerWorkspace::getSourceDatasets

(

)

const [pure virtual]

Gets the workspace's source datasets.

Returns:

a list of all of the workspace's source datasets

virtual IFMEServerFeatureTypeVector* IFMEServerWorkspace::getSourceFeatureTypes

(

)

const [pure virtual]

Gets all the feature types belonging to the source datasets of this workspace. This information is also available by calling getSourceDatasets() and then calling getFeatureTypes() on each source dataset.

Returns:

a list of all the feature types belonging to the source datasets of this workspace

See also:

getSourceDatasets()

virtual void IFMEServerWorkspace::getTitle

(

IFMEServerString &

title

)

const [pure virtual]

Gets the title of the workspace.

Parameters:

name	returns the title of the workspace

IFMEServerWorkspace& IFMEServerWorkspace::operator=

(

const IFMEServerWorkspace &

other

)

[private]

virtual IFMEServerStatus* IFMEServerWorkspace::updatePropertyAccessor

(

IFMEServerPropertyAccessor &

propertyAccessor

)

const [pure virtual]

Updates the property accessor.

Parameters:

propertyAccessor

the property accessor.

Returns:

IFMEServerStatus or NULL if nothing wrong happened.

---

The documentation for this class was generated from the following file:

• ifmeserverworkspace.h