org.teiid.modeshape.sequencer

Interface Result

All Superinterfaces:

Iterable<String>

All Known Implementing Classes:

AbstractExporter.ResultImpl

public interface Result
extends Iterable<String>

The result of an export operation. A result object can be iterated over its data keys.

Method Summary

Modifier and Type	Method and Description
Object	getData(String key)
Exception	getError() An unsuccessful export may not have a caught exception.
String	getErrorMessage() If the export was not successful the error message will always have a value.
Options	getOptions()
Object	getOutcome()
Class<?>	getType()
boolean	wasSuccessful()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getData

Object getData(String key)

Parameters:

key - the type of data being requested (cannot be null)

Returns:

the information, with the specified type, relating to the operation results (never null)

getError

Exception getError()

An unsuccessful export may not have a caught exception.

Returns:

the error caught during the export operation (can be null)

See Also:

getErrorMessage(), wasSuccessful()

getErrorMessage

String getErrorMessage()

If the export was not successful the error message will always have a value.

Returns:

the error message (null when export was successful )

See Also:

wasSuccessful()

getOptions

Options getOptions()

Returns:

the options used during the export (never null but can be empty if all default values were used)

getOutcome

Object getOutcome()

Returns:

the results returned by the operation (can be null)

getType

Class<?> getType()

Returns:

the type returned by the getOutcome() method (will be null until outcome is set)

wasSuccessful

boolean wasSuccessful()

Returns:

true if there is no error and no error message