IFMETransformationResult Members
Public Instance Properties
| Description |
The description of this request, if one was specified.
|
| FMEEngineResponse |
The unparsed response string returned by the FME Server, as defined
by the SUCCESS_RESPONSE or FAILURE_RESPONSE directive in its subsection
configuration. This is a substring of FMEServerResponse.
|
| FMEServerResponse |
The complete, unparsed response string received from the FME Server.
|
| ID |
The ID assigned to this transformation.
|
| JobStatus |
The status of this transformation job.
|
| Priority |
The priority of this request.
|
| Request |
The original request string from the client that produced this result.
|
| RequesterHost |
The host name of the client to which the result is to be sent.
|
| RequesterResultPort |
The local port on the client to which the result is to be sent. The
client is listening on this port for the result.
|
| RequestKeyword |
The request keyword from the client that accompanied the request.
|
| ResultSuccess |
The success value reported by the FME Server.
|
| ServiceMsg |
The status of the FME Engine operation. This indicates if the
FME Engine succeeded in taking a request from the FME Server and
returning a result, or if the FME Engine itself failed for
some reason.
|
| ServiceSuccess |
The success or failure of the FME Server operation. The state
indicated by this boolean is described by ServiceMsg.
|
| StatusMessage |
A descriptive representation of the transformation status. For example,
this would be "Translation successful" when StatusNumber == 0.
|
| StatusNumber |
The status number, as reported by the FME Engine. A non-zero
value indicates failure.
|
| TimeFinished |
The date and time when the transformation result was received from an
FME Engine and placed in the FME Server job result queue.
|
| TimeRequested |
The date and time when the transformation request was received by the
FME Server.
|
| TimeStarted |
The date and time when the transformation request was pulled from the
FME Server job queue and sent to an FME Engine for processing.
|
| TransformationSuccess |
The success of this transformation request: true if
JobStatus == SUCCESS, false otherwise.
|
Public Instance Methods
| GetAllProperties |
Gets all the properties that were parsed from the FME Server and
FME Server responses.
|
| GetAllPropertyNames |
Gets all the available property names that were parsed from the FME Server
and FME Server responses. These keys can be passed as arguments to the
get*Property(...) family of methods to retrieve their values.
|
| GetBooleanProperty |
Gets a boolean value from the FME Engine or FME Server response.
|
| GetDateProperty |
Gets a date value from the FME Engine or FME Server response.
Properties defined in the FME Engine response will shadow any properties
by the same name in the FME Server response. For example, if both the FME Server
and FME Engine response define a property called "currentTime", then
getBooleanProperty("currentTime") will return the corresponding value
from the FME Engine response, not the FME Server response. If a property is
defined multiple times in the FME Engine response, the last value in the
response string will be used.
The following date properties should be present in the FME Server response:
timeRequested
timeStarted
timeFinished
The following boolean properties are included in the default
SUCCESS_RESPONSE and FAILURE_RESPONSE directives that ship with the
FME Server:
(none)
|
| GetDoubleProperty |
Gets a double value from the FME Engine or FME Server response.
|
| GetIntProperty |
Gets an integer value from the FME Server or FME Server response.
|
| GetLongProperty |
Gets a long value from the FME Engine or FME Server response.
|
| GetStringProperty |
Gets a string value from the FME Server or FME Server response.
|
See Also
IFMETransformationResult Interface | Safe.FMEServer.API Namespace