IFMEServerRepository Class Reference

IFMEServerRepository interface. More...

#include <ifmeserverrepository.h>

List of all members.

Public Member Functions
virtual IFMEServerStatus *	addItem (const IFMEServerString &itemName, const IFMEServerString &itemFilePath)=0
virtual IFMEServerStatus *	addItem (const IFMEServerString &itemName, const IFMEServerString &itemFilePath, IFMEServerTransferCallback *callback)=0
virtual IFMEServerStatus *	addResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, const IFMEServerString &resourceFilePath)=0
virtual IFMEServerStatus *	addResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, const IFMEServerString &resourceFilePath, IFMEServerTransferCallback *callback)=0
virtual IFMEServerStatus *	deregisterWorkspaceService (const IFMEServerString &workspaceName, const IFMEServerString &serviceName, FME_Boolean &existed)=0
virtual IFMEServerStatus *	getCustomFormat (const IFMEServerString &customFormatName, IFMEServerCustomFormat &customFormat, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getCustomFormats (const IFMEServerStringArray *directives, IFMEServerCustomFormatVector &customFormats) const =0
virtual IFMEServerStatus *	getCustomTransformer (const IFMEServerString &customTransformerName, IFMEServerCustomTransformer &customTransformer, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getCustomTransformers (const IFMEServerStringArray *directives, IFMEServerCustomTransformerVector &customTransformer) const =0
virtual void	getDescription (IFMEServerString &description) const =0
virtual IFMEServerStatus *	getItem (const IFMEServerString &itemName, const IFMEServerString &itemFilePath, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getItem (const IFMEServerString &itemName, const IFMEServerString &itemFilePath, FME_Boolean &exists, IFMEServerTransferCallback *callback) const =0
virtual void	getName (IFMEServerString &name) const =0
virtual IFMEServerStatus *	getResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, const IFMEServerString &resourceFilePath, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, IFMEServerResource &resource, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, const IFMEServerString &resourceFilePath, FME_Boolean &exists, IFMEServerTransferCallback *callback) const =0
virtual IFMEServerStatus *	getResources (const IFMEServerString &itemName, const IFMEServerStringArray *directives, IFMEServerResourceVector &resources) const =0
virtual IFMEServerStatus *	getTemplate (const IFMEServerString &templateName, IFMEServerTemplate &serverTemplate, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getTemplates (const IFMEServerStringArray *directives, IFMEServerTemplateVector &serverTemplates) const =0
virtual IFMEServerStatus *	getWorkspace (const IFMEServerString &workspaceName, IFMEServerWorkspace &workspace, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getWorkspaces (const IFMEServerStringArray *directives, IFMEServerWorkspaceVector &workspaces) const =0
virtual IFMEServerStatus *	getWorkspaceServices (const IFMEServerStringArray *directives, IFMEServerWorkspaceServiceVector &workspaceServices) const =0
virtual IFMEServerStatus *	getWorkspaceSummaries (const IFMEServerStringArray *directives, IFMEServerWorkspaceSummaryVector &summaries) const =0
virtual IFMEServerStatus *	itemExists (const IFMEServerString &itemName, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	registerWorkspaceService (const IFMEServerString &workspaceName, const IFMEServerString &serviceName)=0
virtual IFMEServerStatus *	removeItem (const IFMEServerString &itemName, FME_Boolean &existed)=0
virtual IFMEServerStatus *	removeResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, FME_Boolean &existed)=0
virtual IFMEServerStatus *	resourceExists (const IFMEServerString &itemName, const IFMEServerString &resourceName, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	updateItem (const IFMEServerString &itemName, const IFMEServerString &itemFilePath, IFMEServerTransferCallback *callback)=0
virtual IFMEServerStatus *	updateItem (const IFMEServerString &itemName, const IFMEServerString &itemFilePath)=0
virtual IFMEServerStatus *	updateResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, const IFMEServerString &resourceFilePath)=0
virtual IFMEServerStatus *	updateResource (const IFMEServerString &itemName, const IFMEServerString &resourceName, const IFMEServerString &resourceFilePath, IFMEServerTransferCallback *callback)=0
virtual IFMEServerStatus *	workspaceServiceExists (const IFMEServerString &workspaceName, const IFMEServerString &serviceName, FME_Boolean &exists) const =0
Protected Member Functions
	IFMEServerRepository ()
virtual	~IFMEServerRepository ()
Private Member Functions
	IFMEServerRepository (const IFMEServerRepository &other)
IFMEServerRepository &	operator= (const IFMEServerRepository &other)

---

Detailed Description

IFMEServerRepository 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

IFMEServerRepository::IFMEServerRepository

(

)

[inline, protected]

virtual IFMEServerRepository::~IFMEServerRepository

(

)

[inline, protected, virtual]

IFMEServerRepository::IFMEServerRepository

(

const IFMEServerRepository &

other

)

[private]

---

Member Function Documentation

virtual IFMEServerStatus* IFMEServerRepository::addItem	(	const IFMEServerString &	itemName,
		const IFMEServerString &	itemFilePath
	)		[pure virtual]

Adds a new repository item identified by the item name with the item specified at the local item file path. The item name must not contain the following characters: \/:*?"<>|&='+%

Parameters:

itemFilePath	the local file path of the item. For example, "C:\My Workspaces\foo.fmw"
itemName	the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Returns:

IFMEServerStatus if an FME Server exception occurred. An error will also occur if the item to add already exists.

virtual IFMEServerStatus* IFMEServerRepository::addItem	(	const IFMEServerString &	itemName,
		const IFMEServerString &	itemFilePath,
		IFMEServerTransferCallback *	callback
	)		[pure virtual]

Adds a new repository item identified by the item name with the item specified at the local item file path. The item name must not contain the following characters: \/:*?"<>|&='+%

Parameters:

itemFilePath	the local file path of the item. For example, "C:\My Workspaces\foo.fmw"
itemName	the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

callback

a callback function to update transfer progress.

Returns:

IFMEServerStatus if an FME Server exception occurred. An error will also occur if the item to add already exists.

virtual IFMEServerStatus* IFMEServerRepository::addResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		const IFMEServerString &	resourceFilePath
	)		[pure virtual]

Adds a new repository resource identified by the resource name with the resource specified at the local resource file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceFilePath

the local file path of the resource.

For example, "C:\My Workspaces\foo.fmx", "C:\My Workspaces\mycoords.csv", etc

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Returns:

IFMEServerStatus if a FME Server exception occurred. An exception will also occur if the resource to add already exists.

virtual IFMEServerStatus* IFMEServerRepository::addResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		const IFMEServerString &	resourceFilePath,
		IFMEServerTransferCallback *	callback
	)		[pure virtual]

Adds a new repository resource identified by the resource name with the resource specified at the local resource file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceFilePath

the local file path of the resource.

For example, "C:\My Workspaces\foo.fmx", "C:\My Workspaces\mycoords.csv", etc

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Parameters:

callback

a callback function to update transfer progress.

Returns:

IFMEServerStatus if a FME Server exception occurred. An exception will also occur if the resource to add already exists.

virtual IFMEServerStatus* IFMEServerRepository::deregisterWorkspaceService	(	const IFMEServerString &	workspaceName,
		const IFMEServerString &	serviceName,
		FME_Boolean &	existed
	)		[pure virtual]

De-registers an FME workspace from an FME service.

Parameters:

workspaceName	the name of the FME workspace
serviceName	the unique name that identifies the FME service
existed	true if workspace service existed and was removed, otherwise false if workspace service did not exist

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getCustomFormat	(	const IFMEServerString &	customFormatName,
		IFMEServerCustomFormat &	customFormat,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified custom format view.

Parameters:

customFormatName

the unique name of the custom format item.

For example, "foo.fds"

Parameters:

the	specified custom format view.
exists	Returns true if the specified custom format exists, otherwise false if the custom format does not exists.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getCustomFormats	(	const IFMEServerStringArray *	directives,
		IFMEServerCustomFormatVector &	customFormats
	)		const [pure virtual]

Gets a list of custom format views.

Parameters:

directives

a Map of keyword and values specifying FME custom format views to return

If null then ALL custom format views are returned.

If ENABLE_FILTER keyword used, then possible value is ALL. If ALL value used, then all custom format views returned.

Parameters:

customFormats

a list of FME custom format views. An empty list is returned if there are no custom format views.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getCustomTransformer	(	const IFMEServerString &	customTransformerName,
		IFMEServerCustomTransformer &	customTransformer,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified custom transformer view.

Parameters:

customTransformerName

the unique name of the custom transformer item.

For example, "foo.fmx"

Parameters:

customTransformer	the specified custom transformer view.
exists	Returns true if the specified custom transformer exists, otherwise false if the custom transformer does not exists.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getCustomTransformers	(	const IFMEServerStringArray *	directives,
		IFMEServerCustomTransformerVector &	customTransformer
	)		const [pure virtual]

Gets a list of custom transformer views.

Parameters:

directives

a Map of keyword and values specifying FME custom transformer views to return

If null then ALL custom transformer views are returned.

If ENABLE_FILTER keyword used, then possible value is ALL. If ALL value used, then all custom transformer views returned.

Parameters:

customTransformers

a list of FME custom transformer views. An empty list is returned if there are no custom transformer views.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual void IFMEServerRepository::getDescription

(

IFMEServerString &

description

)

const [pure virtual]

Gets the description of the repository.

Parameters:

description

an IFMEserverString to store the description of the repository.

virtual IFMEServerStatus* IFMEServerRepository::getItem	(	const IFMEServerString &	itemName,
		const IFMEServerString &	itemFilePath,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified repository item and copies it to the local item file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

itemFilePath	the local file path of the item. For example, "C:\My Workspaces\foo.fmw"
exists	returns true if item exists, otherwise false if item does not exist

Returns:

IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerRepository::getItem	(	const IFMEServerString &	itemName,
		const IFMEServerString &	itemFilePath,
		FME_Boolean &	exists,
		IFMEServerTransferCallback *	callback
	)		const [pure virtual]

Gets the specified repository item and copies it to the local item file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

itemFilePath	the local file path of the item. For example, "C:\My Workspaces\foo.fmw"
exists	returns true if item exists, otherwise false if item does not exist
callback	a callback function to update transfer progress.

Returns:

IFMEServerStatus if an FME Server exception occurred.

virtual void IFMEServerRepository::getName

(

IFMEServerString &

name

)

const [pure virtual]

Gets the unique name of the repository.

Parameters:

name	an IFMEServerString to store the unique name of the repository

virtual IFMEServerStatus* IFMEServerRepository::getResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		const IFMEServerString &	resourceFilePath,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified repository resource of a repository item and copies it to the local resource file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceName

resourceName the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Parameters:

resourceFilePath	String
exists	returns true if resource exists, otherwise false if resource does not exist

Returns:

IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerRepository::getResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		IFMEServerResource &	resource,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified resource view for a specified item.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

Workspaces - Specified with an "fmw" extension. ie. foo.fmw
Templates - Specified with a "fmwt" extension. ie. foo.fmwt
Custom Formats - Specified with a "fds" extension. ie. foo.fds
Custom Transformers - Specified with a "fmx" extension. ie. foo.fmx<p>

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Parameters:

resource	specified resource view.
exists	Returns true if the specified resource exists, otherwise false if the resource does not exists.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		const IFMEServerString &	resourceFilePath,
		FME_Boolean &	exists,
		IFMEServerTransferCallback *	callback
	)		const [pure virtual]

Gets the specified repository resource of a repository item and copies it to the local resource file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceName

resourceName the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Parameters:

resourceFilePath	String
exists	returns true if resource exists, otherwise false if resource does not exist
callback	a callback function to update transfer progress.

Returns:

IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerRepository::getResources	(	const IFMEServerString &	itemName,
		const IFMEServerStringArray *	directives,
		IFMEServerResourceVector &	resources
	)		const [pure virtual]

Gets a list of resource views for the specified item.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

Workspaces - Specified with an "fmw" extension. ie. foo.fmw
Template - Specified with a "fmwt" extension. ie. foo.fmwt
Custom Formats - Specified with a "fds" extension. ie. foo.fds
Custom Transformers - Specified with a "fmx" extension. ie. foo.fmx<p>

Parameters:

directives

a Map of keyword and values specifying FME resource views to return

If null then ALL resource views are returned.

If ENABLE_FILTER keyword used, then possible value is ALL. If ALL value used, then all resource views returned.

Parameters:

resources

a list of FME resource views. An empty list is returned if there are no resource views.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getTemplate	(	const IFMEServerString &	templateName,
		IFMEServerTemplate &	serverTemplate,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified template view.

Parameters:

templateName

the unique name of the template item.

For example, "foo.fmwt"

Parameters:

serverTemplate	the specified template view.
exists	Returns true if the specified template exists, otherwise false if the template does not exist.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getTemplates	(	const IFMEServerStringArray *	directives,
		IFMEServerTemplateVector &	serverTemplates
	)		const [pure virtual]

Gets a list of template views.

Parameters:

directives

a Map of keyword and values specifying FME template views to return

If null then ALL template views are returned.

If ENABLE_FILTER keyword used, then possible value is ALL. If ALL value used, then all template views returned.

Parameters:

serverTemplates

a list of FME template views. An empty list is returned if there are no template views.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getWorkspace	(	const IFMEServerString &	workspaceName,
		IFMEServerWorkspace &	workspace,
		FME_Boolean &	exists
	)		const [pure virtual]

Gets the specified workspace view.

Parameters:

workspaceName

the unique name of the workspace item.

For example, "foo.fmw"

Parameters:

workspace	the specified workspace view.
exists	returns true if workspaceName exists, false otherwise.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getWorkspaces	(	const IFMEServerStringArray *	directives,
		IFMEServerWorkspaceVector &	workspaces
	)		const [pure virtual]

Gets a list of workspace views.

Parameters:

directives

a Map of keyword and values specifying FME workspace views to return

If null then ALL workspace views are returned.

If ENABLE_FILTER keyword used, then possible values are ALL, ENABLED, and DISABLED. If ALL value used, then all workspace views returned. If ENABLED value used, then only enabled workspace views returned. If DISABLED value used, then only disabled workspace views returned.

Parameters:

workspaces

a list of FME workspace views. An empty list is returned if there are no workspace views.

Returns:

IFMEServerStatus if a FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerRepository::getWorkspaceServices	(	const IFMEServerStringArray *	directives,
		IFMEServerWorkspaceServiceVector &	workspaceServices
	)		const [pure virtual]

Gets a list of workspace service views.

Parameters:

directives

a Map of keyword and values specifying FME workspace service views to return

If null then ALL workspace service views are returned.

If ENABLE_FILTER keyword used, then possible values are ALL, ENABLED, and DISABLED. If ALL value used, then all workspace service views returned. If ENABLED value used, then only enabled workspace service views returned. If DISABLED value used, then only disabled workspace service views returned.

If WORKSPACE_NAME keyword used, then possible value is the workspace name. Only the workspace service views for the particular workspace are returned.

Parameters:

workspaceServices

a list of FME workspace service views. An empty list is returned if there are no workspace service views.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::getWorkspaceSummaries	(	const IFMEServerStringArray *	directives,
		IFMEServerWorkspaceSummaryVector &	summaries
	)		const [pure virtual]

Gets a list of workspace summary views.

Parameters:

directives

a Map of keyword and values specifying FME workspace summary views to return

If null then ALL workspace summary views are returned.

If ENABLE_FILTER keyword used, then possible values are ALL, ENABLED, and DISABLED. If ALL value used, then all workspace summary views returned. If ENABLED value used, then only enabled workspace summary views returned. If DISABLED value used, then only disabled workspace summaries returned.

Parameters:

summaries

a list of FME workspace summary views. An empty list is returned if there are no workspace summary views.

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::itemExists	(	const IFMEServerString &	itemName,
		FME_Boolean &	exists
	)		const [pure virtual]

Checks if specified item exists.

The types of repository items supported are:

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

Parameters:

itemName	The unique name of the repository item. For example, "foo.fmw".
workspaceFilePath	The file path in which the resulting item will reside.
found	Returns true if item exists, otherwise false.

IFMEServerRepository& IFMEServerRepository::operator=

(

const IFMEServerRepository &

other

)

[private]

virtual IFMEServerStatus* IFMEServerRepository::registerWorkspaceService	(	const IFMEServerString &	workspaceName,
		const IFMEServerString &	serviceName
	)		[pure virtual]

Registers an FME workspace with an FME service.

Parameters:

workspaceName	the name of the FME workspace
serviceName	the unique name that identifies the FME service

Returns:

IFMEServerStatus if a FME Server exception occurred. An error will also occur if the specified FME workspace or FME service does not exist.

virtual IFMEServerStatus* IFMEServerRepository::removeItem	(	const IFMEServerString &	itemName,
		FME_Boolean &	existed
	)		[pure virtual]

Removes the repository item identified by the specified item name.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

existed

returns true if item existed and was removed, otherwise false if item did not exist

Returns:

IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerRepository::removeResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		FME_Boolean &	existed
	)		[pure virtual]

Removes the resource item identified by the specified resource name.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Parameters:

existed

returns true if resource existed and was removed, otherwise false if resource did not exist

Returns:

IFMEServerStatus if a FME Server exception occurred

virtual IFMEServerStatus* IFMEServerRepository::resourceExists	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		FME_Boolean &	exists
	)		const [pure virtual]

Checks if specified resource exists for specified item.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Parameters:

exists

return true if resource exists, otherwise false if resource does not exist

Returns:

IFMEServerStatus if an FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerRepository::updateItem	(	const IFMEServerString &	itemName,
		const IFMEServerString &	itemFilePath
	)		[pure virtual]

Updates the repository item identified by the item name with the item specified at the local item file path.

Note: An error will also occur if the item to add does not already exists.

Parameters:

itemFilePath	the local file path of the item. For example, "C:\My Workspaces\foo.fmw"
itemName	the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Returns:

IFMEServerStatus if an FME Server exception occurred. An error will also occur if the item to update does not already exists.

virtual IFMEServerStatus* IFMEServerRepository::updateItem	(	const IFMEServerString &	itemName,
		const IFMEServerString &	itemFilePath,
		IFMEServerTransferCallback *	callback
	)		[pure virtual]

Updates the repository item identified by the item name with the item specified at the local item file path.

Note: An error will also occur if the item to add does not already exists.

Parameters:

itemFilePath	the local file path of the item. For example, "C:\My Workspaces\foo.fmw"
itemName	the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

callback

a callback function to update transfer progress.

Returns:

IFMEServerStatus if an FME Server exception occurred. An error will also occur if the item to update does not already exists.

virtual IFMEServerStatus* IFMEServerRepository::updateResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		const IFMEServerString &	resourceFilePath,
		IFMEServerTransferCallback *	callback
	)		[pure virtual]

Updates the repository resource of a repository item with the resource specified at the local resource file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceFilePath

the local file path of the resource.

For example, "C:\My Workspaces\foo.fmx", "C:\My Workspaces\mycoords.csv", etc

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Returns:

IFMEServerStatus if a FME Server exception occurred. An exception will also occur if the resource to update does not already exist.

virtual IFMEServerStatus* IFMEServerRepository::updateResource	(	const IFMEServerString &	itemName,
		const IFMEServerString &	resourceName,
		const IFMEServerString &	resourceFilePath
	)		[pure virtual]

Updates the repository resource of a repository item with the resource specified at the local resource file path.

Parameters:

itemName

the unique name of the repository item. For example, "foo.fmw".

The types of repository items supported are:

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

Parameters:

resourceFilePath

the local file path of the resource.

For example, "C:\My Workspaces\foo.fmx", "C:\My Workspaces\mycoords.csv", etc

Parameters:

resourceName

the unique name of the reource.

For example, "foo.fmx", "mycoords.csv", etc

Returns:

IFMEServerStatus if a FME Server exception occurred. An exception will also occur if the resource to update does not already exist.

virtual IFMEServerStatus* IFMEServerRepository::workspaceServiceExists	(	const IFMEServerString &	workspaceName,
		const IFMEServerString &	serviceName,
		FME_Boolean &	exists
	)		const [pure virtual]

Checks if specified FME workspace service exists.

Parameters:

workspaceName	the name of the FME workspace
serviceName	the unique name that identifies the FME service
exists	true if specified workspace service exists, otherwise false if workspace service does not exist

Returns:

IFMEServerStatus if a FME Server exception occurred

---

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

• ifmeserverrepository.h