IFMEServerTransformationManager Class Reference

IFMEServerTransformationManager interface. More...

#include <ifmeservertransformationmanager.h>

List of all members.

Public Member Functions
virtual IFMEServerStatus *	abortJob (const FME_Int32 jobID)=0
virtual IFMEServerStatus *	getJobResult (const FME_Int32 jobID, FME_Boolean &jobResultAvailable, IFMEServerString &fmeServerResponse)=0
virtual IFMEServerStatus *	getJobResult (const FME_Int32 jobID, FME_Boolean &jobResultAvailable, IFMEServerTransformationResult &result)=0
virtual IFMEServerStatus *	getLogFile (const FME_Int32 jobID, const IFMEServerString &logFilePath, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	getLogFileInfo (const FME_Int32 jobID, IFMEServerLogFileInfo &logFileInfo, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	logFileExists (const FME_Int32 jobID, FME_Boolean &exists) const =0
virtual IFMEServerStatus *	scheduleJob (IFMEServerTransformationRequest &request, const FME_UInt32 secondsFromNow, FME_Int32 &jobID)=0
virtual IFMEServerStatus *	scheduleJob (const IFMEServerString &subsectionName, const IFMEServerString &request, const FME_UInt32 secondsFromNow, const IFMEServerStringArray &directives, FME_Int32 &jobID)=0
virtual IFMEServerStatus *	submitJob (const IFMEServerString &subsectionName, const IFMEServerString &request, const IFMEServerStringArray &directives, FME_Int32 &jobID)=0
virtual IFMEServerStatus *	submitJob (IFMEServerTransformationRequest &request, FME_Int32 &jobID)=0
virtual IFMEServerStatus *	transactJob (IFMEServerTransformationRequest &request, IFMEServerTransformationResult &result)=0
virtual IFMEServerStatus *	transactJob (const IFMEServerString &subsectionName, const IFMEServerString &request, const IFMEServerStringArray &directives, IFMEServerString &fmeServerResponse)=0
Protected Member Functions
	IFMEServerTransformationManager ()
virtual	~IFMEServerTransformationManager ()
Private Member Functions
	IFMEServerTransformationManager (const IFMEServerTransformationManager &other)
IFMEServerTransformationManager &	operator= (const IFMEServerTransformationManager &other)

---

Detailed Description

IFMEServerTransformationManager interface.

Package Overview:

Defines the interface for the "rich" FME Server.

NOTE: FME Server clients using the IFMEServerTransformationManager interface will only work with FME Servers running in RICH mode.

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

IFMEServerTransformationManager::IFMEServerTransformationManager

(

)

[inline, protected]

virtual IFMEServerTransformationManager::~IFMEServerTransformationManager

(

)

[inline, protected, virtual]

IFMEServerTransformationManager::IFMEServerTransformationManager

(

const IFMEServerTransformationManager &

other

)

[private]

---

Member Function Documentation

virtual IFMEServerStatus* IFMEServerTransformationManager::abortJob

(

const FME_Int32

jobID

)

[pure virtual]

Abort a job request. This will either remove the job from the queue or cancel its processing if it is currently running on an FME.

Parameters:

jobID

The job ID of the job to abort.

virtual IFMEServerStatus* IFMEServerTransformationManager::getJobResult	(	const FME_Int32	jobID,
		FME_Boolean &	jobResultAvailable,
		IFMEServerString &	fmeServerResponse
	)		[pure virtual]

Get the job result for the specified job.

Parameters:

jobID	The job ID of the job result to get.
jobResultAvailable	FME_TRUE if results are ready, otherwise FME_FALSE.
fmeServerResponse	FME Server result as a string.

Deprecated:

Replaced by getJobResult(const FME_Int32, FME_Boolean&, IFMEServerTransformationResult&)

virtual IFMEServerStatus* IFMEServerTransformationManager::getJobResult	(	const FME_Int32	jobID,
		FME_Boolean &	jobResultAvailable,
		IFMEServerTransformationResult &	result
	)		[pure virtual]

Get the job result for the specified job.

Parameters:

jobID	The job ID of the job result to get.
jobResultAvailable	FME_TRUE if results are ready, otherwise FME_FALSE.
result	The FME Server result as an IFMEServerTransformationResult object.

virtual IFMEServerStatus* IFMEServerTransformationManager::getLogFile	(	const FME_Int32	jobID,
		const IFMEServerString &	logFilePath,
		FME_Boolean &	exists
	)		const [pure virtual]

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

Checks if the specified log file exists.

Parameters:

jobID	the ID of the job whose log file is to be fetched.
logFilePath	the local file path of the log file.
exists	FME_TRUE if the log file exists, otherwise FME_FALSE.

Returns:

IFMEServerStatus if a FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerTransformationManager::getLogFileInfo	(	const FME_Int32	jobID,
		IFMEServerLogFileInfo &	logFileInfo,
		FME_Boolean &	exists
	)		const [pure virtual]

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

Checks if the specified log file exists.

Parameters:

jobID	the ID of the job whose log file is to be fetched.
logFileInfo
exists	FME_TRUE if log file exists, otherwise FME_FALSE.

Returns:

IFMEServerStatus if a FME Server exception occurred.

virtual IFMEServerStatus* IFMEServerTransformationManager::logFileExists	(	const FME_Int32	jobID,
		FME_Boolean &	exists
	)		const [pure virtual]

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

Checks if the specified log file exists.

Parameters:

jobID	the ID of the job whose log file is to be fetched.
exists	FME_TRUE if the log file exists, otherwise FME_FALSE.

Returns:

IFMEServerStatus if a FME Server exception occurred.

IFMEServerTransformationManager& IFMEServerTransformationManager::operator=

(

const IFMEServerTransformationManager &

other

)

[private]

virtual IFMEServerStatus* IFMEServerTransformationManager::scheduleJob	(	const IFMEServerString &	subsectionName,
		const IFMEServerString &	request,
		const FME_UInt32	secondsFromNow,
		const IFMEServerStringArray &	directives,
		FME_Int32 &	jobID
	)		[pure virtual]

Schedule a job to be run at the specified time.

Parameters:

subsection	name to be used for this request.
request	A valid FME request with mapping file or workspace.
secondsFromNow	Number of seconds from the current time that the job should be scheduled to run.
directives	Name and value pairs used to specify additional request directives such as priority.
jobID	The job ID of the scheduled job.

Deprecated:

Replaced by scheduleJob(IFMEServerTransformationRequest&,const FME_UInt32, FME_Int32&)

virtual IFMEServerStatus* IFMEServerTransformationManager::scheduleJob	(	IFMEServerTransformationRequest &	request,
		const FME_UInt32	secondsFromNow,
		FME_Int32 &	jobID
	)		[pure virtual]

Schedule a job to be run at the specified time.

Parameters:

request	A valid IFMEServerTransformationRequest containing the details of the requested transformation.
jobID	The job ID of the scheduled job.

virtual IFMEServerStatus* IFMEServerTransformationManager::submitJob	(	IFMEServerTransformationRequest &	request,
		FME_Int32 &	jobID
	)		[pure virtual]

Asynchronously submit a transformation request. The request is added to the queue and a job id is returned. This job can then be accessed on the FME Server via the job ID.

Parameters:

request	A valid IFMEServerTransformationRequest containing the details of the requested transformation.
jobID	The job ID of the submitted job.

virtual IFMEServerStatus* IFMEServerTransformationManager::submitJob	(	const IFMEServerString &	subsectionName,
		const IFMEServerString &	request,
		const IFMEServerStringArray &	directives,
		FME_Int32 &	jobID
	)		[pure virtual]

Asynchronously submit a transformation request. The request is added to the queue and a job id is returned. This job can then be accessed on the FME Server via the job ID.

Parameters:

subsection	name to be used for this request.
request	IFMEServerString& A valid FME request with mapping file or workspace.
directives	Name and value pairs used to specify additional request directives such as priority.
jobID	The job ID of the submitted job.

Deprecated:

Replaced by submitJob(IFMEServerTransformationRequest&, FME_Int32&)

virtual IFMEServerStatus* IFMEServerTransformationManager::transactJob	(	const IFMEServerString &	subsectionName,
		const IFMEServerString &	request,
		const IFMEServerStringArray &	directives,
		IFMEServerString &	fmeServerResponse
	)		[pure virtual]

Perform a synchronous transformation transaction with the connected FME Server. This method will block until results are delivered. A free port will be dynamically determined for result delivery. If you need to specify a particular port to be bound, specify requesterResultPort in parms.

Parameters:

subsection	name for this request.
request	a valid FME request with a mapping file or workspace.
directives	Name and value pairs used to specify additional request directives such as priority.
fmeServerResponse	The FME Server response as a string.

Deprecated:

Replaced by transactJob(IFMEServerTransformationRequest&, IFMEServerTransformationResult&)

virtual IFMEServerStatus* IFMEServerTransformationManager::transactJob	(	IFMEServerTransformationRequest &	request,
		IFMEServerTransformationResult &	result
	)		[pure virtual]

Perform a synchronous transformation transaction with the connected FME Server. This method will block until results are delivered. A free port will be dynamically determined for result delivery. If you need to specify a particular port to be bound, specify requesterResultPort in parms.

Parameters:

request	A valid IFMEServerTransformationRequest containing the details of the requested transformation.
result	An IFMEServerTransformationResult object to hold the FME Server response.

---

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

• ifmeservertransformationmanager.h