IFMEServerItem Class Reference

IFMEServerItem interface. More...

#include <ifmeserveritem.h>

List of all members.

Public Member Functions
virtual FME_UInt32	getBuildNumber () const =0
virtual void	getCategory (IFMEServerString &category) const =0
virtual void	getDescription (IFMEServerString &description) const =0
virtual FME_UInt32	getFileSize () const =0
virtual void	getHistory (IFMEServerString &history) const =0
virtual void	getLastSaveBuild (IFMEServerString &lastSaveBuild) const =0
virtual void	getLastSaveDate (IFMEServerString &lastSaveDate) const =0
virtual void	getLegalTermsConditions (IFMEServerString &legalTermsConditions) const =0
virtual void	getName (IFMEServerString &name) const =0
virtual void	getRepositoryName (IFMEServerString &repositoryName) const =0
virtual void	getRequirements (IFMEServerString &requirements) const =0
virtual void	getRequirementsKeyword (IFMEServerString &requirementsKeyword) const =0
virtual void	getTitle (IFMEServerString &title) const =0
virtual FMEServerItemType	getType () const =0
virtual void	getUsage (IFMEServerString &usage) const =0
Protected Member Functions
	IFMEServerItem ()
virtual	~IFMEServerItem ()
Private Member Functions
	IFMEServerItem (const IFMEServerItem &other)
IFMEServerItem &	operator= (const IFMEServerItem &other)

---

Detailed Description

IFMEServerItem 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

IFMEServerItem::IFMEServerItem

(

)

[inline, protected]

virtual IFMEServerItem::~IFMEServerItem

(

)

[inline, protected, virtual]

IFMEServerItem::IFMEServerItem

(

const IFMEServerItem &

other

)

[private]

---

Member Function Documentation

virtual FME_UInt32 IFMEServerItem::getBuildNumber

(

)

const [pure virtual]

Gets the build number of the item.

Returns:

the build number of the item

virtual void IFMEServerItem::getCategory

(

IFMEServerString &

category

)

const [pure virtual]

Gets the category of the item.

Parameters:

category

the category of the item

virtual void IFMEServerItem::getDescription

(

IFMEServerString &

description

)

const [pure virtual]

Gets the description of the item.

Parameters:

description

the description of the item

virtual FME_UInt32 IFMEServerItem::getFileSize

(

)

const [pure virtual]

Gets the file size of the item.

Returns:

the file size of the item

virtual void IFMEServerItem::getHistory

(

IFMEServerString &

history

)

const [pure virtual]

Gets the history of the item.

Parameters:

history

the history of the item

virtual void IFMEServerItem::getLastSaveBuild

(

IFMEServerString &

lastSaveBuild

)

const [pure virtual]

Gets the last save build of the item.

Parameters:

lastSaveBuild

the last save build of the item

virtual void IFMEServerItem::getLastSaveDate

(

IFMEServerString &

lastSaveDate

)

const [pure virtual]

Gets the last save date of the item.

Parameters:

lastSaveDate

the last save date of the item

virtual void IFMEServerItem::getLegalTermsConditions

(

IFMEServerString &

legalTermsConditions

)

const [pure virtual]

Gets the legal terms and conditions of the item.

Parameters:

the	legal terms and conditions of the item

virtual void IFMEServerItem::getName

(

IFMEServerString &

name

)

const [pure virtual]

Gets the name of the workspace.

The types of repository items supported are:

Workspace - Specified with an "fmw" extension. ie. foo.fmw Custom Format - Specified with a "fds" extension. ie. foo.fds Custom Transformer - Specified with a "fmx" extension. ie. foo.fmx Template - Specified with a "fmwt" extension. ie. foo.fmwt

Parameters:

name	returns the name of the item

virtual void IFMEServerItem::getRepositoryName

(

IFMEServerString &

repositoryName

)

const [pure virtual]

Gets the repository name of the item.

Parameters:

repositoryName

returns the repository name of the item

virtual void IFMEServerItem::getRequirements

(

IFMEServerString &

requirements

)

const [pure virtual]

Gets the requirements of the item.

Parameters:

requirements

the requirement of the item

virtual void IFMEServerItem::getRequirementsKeyword

(

IFMEServerString &

requirementsKeyword

)

const [pure virtual]

Gets the requirements keyword of the item.

Parameters:

requirementsKeyword

the requirement keyword of the item

virtual void IFMEServerItem::getTitle

(

IFMEServerString &

title

)

const [pure virtual]

Gets the title of the item.

Parameters:

title

the title of the item

virtual FMEServerItemType IFMEServerItem::getType

(

)

const [pure virtual]

Gets the type of the item.

Returns:

the type of the item

virtual void IFMEServerItem::getUsage

(

IFMEServerString &

usage

)

const [pure virtual]

Gets the usage of the item.

Parameters:

usage

the usage of the item

IFMEServerItem& IFMEServerItem::operator=

(

const IFMEServerItem &

other

)

[private]

---

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

• ifmeserveritem.h