public interface IDfQueryManager
Modifier and Type | Method and Description |
---|---|
IDfSmartListDefinition |
convertSmartListDefinition(IDfSysObject oldSmartList)
Converts smart list definition using a legacy dm_smartlist object.
|
IDfQueryDefinition |
loadQueryDefinition(java.io.InputStream in)
Loads a query definition from a stream.
|
IDfSmartListDefinition |
loadSmartListDefinition(org.w3c.dom.Document doc,
org.w3c.dom.Node parentNode)
Loads a smart list definition from an XML document node.
|
IDfSmartListDefinition |
loadSmartListDefinition(java.io.InputStream in)
Loads a smart list definition from a stream.
|
IDfPassThroughQuery |
newPassThroughQuery(java.lang.String queryString)
Creates a new pass-through query using the specified parameters.
|
IDfPassThroughQuery |
newPassThroughQuery(java.lang.String queryString,
java.lang.String customQueryData,
int maxResultCount)
Creates a new pass-through using the specified parameters.
|
IDfQueryBuilder |
newQueryBuilder()
Creates a new query builder.
|
IDfQueryBuilder |
newQueryBuilder(java.lang.String objectType)
Creates a new query builder using the specified object type.
|
IDfQueryBuilder |
newQueryBuilder(java.lang.String objectType,
int maxResultCount,
boolean isDatabaseSearchRequested)
Creates a new query builder using the specified parameters.
|
IDfSmartListDefinition |
newSmartListDefinition()
Creates a new smart list definition.
|
void |
saveQueryDefinition(IDfQueryDefinition queryDefinition,
java.io.OutputStream out)
Saves a query definition in an output stream.
|
void |
saveSmartListDefinition(IDfSmartListDefinition smartList,
org.w3c.dom.Document doc,
org.w3c.dom.Node parentNode)
Saves a smart list definition in an output stream.
|
void |
saveSmartListDefinition(IDfSmartListDefinition smartList,
java.io.OutputStream out)
Saves a smart list definition in an output stream.
|
IDfQueryBuilder newQueryBuilder() throws DfException
DfException
- If an error occurs in the server.IDfQueryBuilder newQueryBuilder(java.lang.String objectType) throws DfException
objectType
- The object type name such as dm_document
.DfException
- If an exception occurs during the construction.IDfQueryBuilder newQueryBuilder(java.lang.String objectType, int maxResultCount, boolean isDatabaseSearchRequested) throws DfException
objectType
- The object type name such as dm_document
.maxResultCount
- The maximum number of results to return.isDatabaseSearchRequested
- true
, to force query to use RDBMS semantics as opposed to
fulltext semantics. It is only relevant if full-text clauses are used.DfException
- If an exception occurs during the construction.IDfPassThroughQuery newPassThroughQuery(java.lang.String queryString) throws DfException
queryString
- An opaque query string to be passed to the source's query engine.DfException
- If an exception occurs during the construction.IDfPassThroughQuery newPassThroughQuery(java.lang.String queryString, java.lang.String customQueryData, int maxResultCount) throws DfException
queryString
- An opaque query string to be passed to the source's query engine.customQueryData
- An opaque custom data to be stored with the query. Can be used to support custom query
building for example.maxResultCount
- The maximum number of entries to return.DfException
- If an exception occurs during the construction.IDfSmartListDefinition newSmartListDefinition() throws DfException
dm_smartlist
objects in the repository.DfException
- If an exception occurs during the construction.IDfSmartList
IDfQueryDefinition loadQueryDefinition(java.io.InputStream in) throws DfException, java.io.IOException
in
- The input stream to read.DfException
- If the stream is not a well-formed XML stream, or if the query format is invalid.java.io.IOException
- If an I/O error occurs while reading the stream.void saveQueryDefinition(IDfQueryDefinition queryDefinition, java.io.OutputStream out) throws DfException, java.io.IOException
queryDefinition
- The query definition to save.out
- The output stream to write in.DfException
- If an XML configuration error occurs.java.io.IOException
- If an I/O error occurs while writing the output stream.IDfSmartListDefinition loadSmartListDefinition(java.io.InputStream in) throws DfException, java.io.IOException
in
- The input stream to read.DfException
- If the stream is not a well-formed XML stream, or if the smart list format is invalid.java.io.IOException
- If an I/O error occurs while reading the stream.IDfSmartListDefinition loadSmartListDefinition(org.w3c.dom.Document doc, org.w3c.dom.Node parentNode) throws DfException, java.io.IOException
doc
- a DOMparentNode
- The node under which the smartlist definition xml representation can be found.DfException
- If the stream is not a well-formed XML stream, or if the smart list format is invalid.java.io.IOException
- If an I/O error occurs while reading the stream.void saveSmartListDefinition(IDfSmartListDefinition smartList, java.io.OutputStream out) throws DfException, java.io.IOException
smartList
- The smart list definition to save.out
- The output stream to write in.DfException
- If an XML configuration error occurs.java.io.IOException
- If an I/O error occurs while writing the output stream.void saveSmartListDefinition(IDfSmartListDefinition smartList, org.w3c.dom.Document doc, org.w3c.dom.Node parentNode) throws DfException, java.io.IOException
smartList
- The smart list definition to save.doc
- a DOMparentNode
- The node under which the smartlist definition xml representation can be found.DfException
- If an XML configuration error occurs.java.io.IOException
- If an I/O error occurs while writing the output stream.IDfSmartListDefinition convertSmartListDefinition(IDfSysObject oldSmartList) throws DfException, java.io.IOException
oldSmartList
- A dm_smartlist object (as an IDfSysObject).DfException
- If a conversion exception occurs.java.io.IOException
- If an I/O error occurs while reading the stream (contents of the oldSmartList).Copyright 1994-2023 OpenText Corporation. All rights reserved.