com.sssw.cm.api
Interface EbiDocQueryConverter

public interface EbiDocQueryConverter

Objects that implement this interface perform conversions of XML query definitions for content management, into the Document Metadata Query objects.

See Also:

EbiContentMgmtDelegate.getQueryConverter(), EbiDocQuery

Method Summary

void	clearErrors() Clears out the cache of accumulated errors.
boolean	foundErrors() Checks to see if any errors were found during the execution of queryDefToObjectWithValidation
Collection	getErrors() Gets the errors, if any were detected during the execution of queryDefToObjectWithValidation.
Collection	getFatalErrors() Gets the fatal errors, if any were detected during the execution of queryDefToObjectWithValidation.
Collection	getWarnings() Gets the warnings, if any were generated during the execution of queryDefToObjectWithValidation.
EbiDocQuery	queryDefToObject(EbiContext context, String queryDef) Converts Query definition XML into a Document Metadata Query object.
EbiDocQuery	queryDefToObjectWithValidation(EbiContext context, String queryDef, boolean continueAfterFatalError) Converts Query definition XML into a Document Metadata Query object.

Method Detail

queryDefToObject

public EbiDocQuery queryDefToObject(EbiContext context,
                                    String queryDef)
                             throws EboUnrecoverableSystemException

Converts Query definition XML into a Document Metadata Query object. See contentmgmt-docmeta-search_4_0.dtd for the details on the format of the XML. Note: no semantic validation of the XML is performed by this method.

Parameters:

context - the context

queryDef - the XML of the Query definition

Returns:

the Document Metadata Query object

queryDefToObjectWithValidation

public EbiDocQuery queryDefToObjectWithValidation(EbiContext context,
                                                  String queryDef,
                                                  boolean continueAfterFatalError)
                                           throws EboUnrecoverableSystemException

Converts Query definition XML into a Document Metadata Query object. Semantic validation of the XML is performed by this method; contentmgmt-docmeta-search_4_0.dtd is used. Any errors or warnings are accumulated and may be accessed via the getFatalErrors, getErrors, and getWarnings methods.

Parameters:

context - the context

queryDef - the XML of the query definition

continueAfterFatalError - if true, the conversion will continue even if a fatal error is encountered

Returns:

the Document Metadata Query object

foundErrors

public boolean foundErrors()

Checks to see if any errors were found during the execution of queryDefToObjectWithValidation

Returns:

true if any errors were found or warnings generated as queryDefToObjectWithValidation was executing

getFatalErrors

public Collection getFatalErrors()

Gets the fatal errors, if any were detected during the execution of queryDefToObjectWithValidation.

Returns:

a Collection of exceptions

getErrors

public Collection getErrors()

Gets the errors, if any were detected during the execution of queryDefToObjectWithValidation.

Returns:

a Collection of exceptions

getWarnings

public Collection getWarnings()

Gets the warnings, if any were generated during the execution of queryDefToObjectWithValidation.

Returns:

a Collection of exceptions

clearErrors

public void clearErrors()

Clears out the cache of accumulated errors.