IFMEServerService interface. More...

#include <ifmeserverservice.h>

Public Member Functions
virtual IFMEServerStatus *	deregisterItem (const IFMEServerString &repositoryName, const IFMEServerString &itemName, FME_Boolean &existed)=0
virtual void	getDescription (IFMEServerString &description) const =0
virtual void	getDisplayName (IFMEServerString &displayName) const =0
virtual FME_Boolean	getIsEnabled () const =0
virtual FME_Boolean	getIsItemRegistrationAllowed (const FMEServerItemType itemType) const =0
virtual FME_Boolean	getIsWorkspaceRegistrationAllowed () const =0
virtual void	getName (IFMEServerString &name) const =0
virtual IFMEServerPropertyAccessor *	getPropertyAccessor () const =0
virtual IFMEServerStatus *	getRegisteredItems (const IFMEServerStringArray *directives, IFMEServerItemVector &items)=0
virtual void	getURLPattern (IFMEServerString &urlPattern) const =0
virtual IFMEServerStatus *	isItemRegistered (const IFMEServerString &repositoryName, const IFMEServerString &itemName, FME_Boolean &itemRegistered) const =0
virtual IFMEServerStatus *	registerItem (const IFMEServerString &repositoryName, const IFMEServerString &itemName)=0
virtual void	setDescription (const IFMEServerString &description)=0
virtual void	setDisplayName (const IFMEServerString &displayName)=0
virtual void	setIsEnabled (const FME_Boolean isEnabled)=0
virtual void	setIsItemRegistrationAllowed (const FMEServerItemType itemType, const FME_Boolean itemRegistrationAllowed)=0
virtual void	setIsWorkspaceRegistrationAllowed (const FME_Boolean isWorkspaceRegistrationAllowed)=0
virtual void	setName (const IFMEServerString &name)=0
virtual void	setURLPattern (const IFMEServerString &urlPattern)=0
virtual IFMEServerStatus *	updatePropertyAccessor (IFMEServerPropertyAccessor &propertyAccessor) const =0
Protected Member Functions
	IFMEServerService ()
virtual	~IFMEServerService ()
Private Member Functions
	IFMEServerService (const IFMEServerService &other)
IFMEServerService &	operator= (const IFMEServerService &other)

Detailed Description

IFMEServerService 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

IFMEServerService::IFMEServerService ( ) [inline, protected]

virtual IFMEServerService::~IFMEServerService ( ) [inline, protected, virtual]

IFMEServerService::IFMEServerService ( const IFMEServerService & other ) [private]

Member Function Documentation

virtual IFMEServerStatus* IFMEServerService::deregisterItem	(	const IFMEServerString &	repositoryName,
		const IFMEServerString &	itemName,
		FME_Boolean &	existed
	)		`[pure virtual]`

BETA - Preview of the new deregisterItem method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

De-registers an item from this service.

Parameters:

repositoryName	the name of the repository
itemName	the name of the item
existed	true if item existed with this service, otherwise false

Returns:: IFMEServerStatus pointer if error, otherwise NULL

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

Gets the description of this service

Returns:: the description of this service

virtual void IFMEServerService::getDisplayName ( IFMEServerString & displayName ) const [pure virtual]

Gets the display name of this service

Returns:: the display name of this service

virtual FME_Boolean IFMEServerService::getIsEnabled ( ) const [pure virtual]

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

Returns:: a boolean representing whether or not this service is currently enabled

virtual FME_Boolean IFMEServerService::getIsItemRegistrationAllowed ( const FMEServerItemType itemType ) const [pure virtual]

BETA - Preview of the new getIsItemRegistrationAllowed method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Gets a boolean representing whether or not this service allows registration of the specified item type.

Returns:: a boolean representing whether or not this service allows registration of the specified item type

virtual FME_Boolean IFMEServerService::getIsWorkspaceRegistrationAllowed ( ) const [pure virtual]

Gets a boolean representing whether or not this service allows workspace registration

Returns:: a boolean representing whether or not this service allows workspace registration

virtual void IFMEServerService::getName ( IFMEServerString & name ) const [pure virtual]

Gets the name of this service

Returns:: the name of this service

virtual IFMEServerPropertyAccessor* IFMEServerService::getPropertyAccessor ( ) const [pure virtual]

Gets a property manager to manage workspace properties.

Returns:: a property manager

virtual IFMEServerStatus* IFMEServerService::getRegisteredItems	(	const IFMEServerStringArray *	directives,
		IFMEServerItemVector &	items
	)		`[pure virtual]`

BETA - Preview of the new getRegisteredItems method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Gets a list of items registered with this service.

Parameters:

directives	a Map of keyword and values specifying FME item views to return. NULL directives is reserved for future use. If ITEM_TYPE keyword is used, then a possible value is the item type. Only the registered item views for the particular item type are returned.
items	a list of registered item views. An empty list is returned if here are no registered items.

Returns:: IFMEServerStatus point if error, otherwise NULL

virtual void IFMEServerService::getURLPattern ( IFMEServerString & urlPattern ) const [pure virtual]

Gets the URL Pattern at which this service can be accessed

Returns:: the URL Pattern at which this service can be accessed

virtual IFMEServerStatus* IFMEServerService::isItemRegistered	(	const IFMEServerString &	repositoryName,
		const IFMEServerString &	itemName,
		FME_Boolean &	itemRegistered
	)		const `[pure virtual]`

BETA - Preview of the new isItemRegistered method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Checks if specified item is registered with this service.

Parameters:

repositoryName	the name of the repository
itemName	the name of the item
itemRegistered	true if item is registered with this service, otherwise false

Returns:: IFMEServerStatus pointer if error, otherwise NULL

IFMEServerService& IFMEServerService::operator= ( const IFMEServerService & other ) [private]

virtual IFMEServerStatus* IFMEServerService::registerItem	(	const IFMEServerString &	repositoryName,
		const IFMEServerString &	itemName
	)		`[pure virtual]`

BETA - Preview of the new registerItem method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Registers an item with this service.

Parameters:

repositoryName	the name of the repository
itemName	the name of the item

Returns:: IFMEServerStatus pointer if error, otherwise NULL

virtual void IFMEServerService::setDescription ( const IFMEServerString & description ) [pure virtual]

Sets the description of this service.

Parameters:

description the description of this service.

virtual void IFMEServerService::setDisplayName ( const IFMEServerString & displayName ) [pure virtual]

Sets the display name of this service

Parameters:

displayName the new display name of this service.

virtual void IFMEServerService::setIsEnabled ( const FME_Boolean isEnabled ) [pure virtual]

Sets a boolean representing whether or not this service is currently enabled.

Parameters:

isEnabled true to enable the service, otherwise false to disable the service.

virtual void IFMEServerService::setIsItemRegistrationAllowed	(	const FMEServerItemType	itemType,
		const FME_Boolean	itemRegistrationAllowed
	)		`[pure virtual]`

BETA - Preview of the new setIsItemRegistrationAllowed method. Safe Software reserves the right to release subsequent versions that require changes to applications that use this method.

Sets a boolean representing whether or not this service allows registration of the specified item type.

Parameters:

itemType	the type of item
itemRegistrationAllowed	true if specified item type is allowed registration with this services, otherwise false

virtual void IFMEServerService::setIsWorkspaceRegistrationAllowed ( const FME_Boolean isWorkspaceRegistrationAllowed ) [pure virtual]

Sets a boolean representing whether or not this service allows workspace registration.

Parameters:

isWorkspaceRegistrationAllowed true to allow workspace registration, otherwise false to indicate that this service does not allow workspace registration.

virtual void IFMEServerService::setName ( const IFMEServerString & name ) [pure virtual]

Sets the name of this service.

Parameters:

name	the name of this service.

virtual void IFMEServerService::setURLPattern ( const IFMEServerString & urlPattern ) [pure virtual]

Sets the URL Pattern at which this service can be accessed.

Parameters:

urlPattern the URL Pattern at which this service can be accessed.

virtual IFMEServerStatus* IFMEServerService::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:

ifmeserverservice.h

IFMEServerService Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation