PreparedSelectorSpecification (ecmsdk-api 3.7.0 API)

java.lang.Object
- oracle.ifs.common.PreparedSelectorSpecification

```
public class PreparedSelectorSpecification
extends Object
```
A PreparedSelectorSpecification is used to hold all settable and derived search options for a PreparedSelector search,

Author:

Dave Long

(Unpublished)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`OPTIONS_FOLDERINDEX_PARTITIONS_ENABLED` The name of the advanced PreparedSelector option that indicates whether FolderIndex partitions are to be used.
`static String`	`OPTIONS_SMART_VIEWS_ENABLED` The name of the advanced PreparedSelector option that indicates whether Smart Views are to be used.
`static String`	`STATEMENTKEY_ADMIN_MODE_SUFFIX` The suffix to apply to statement keys when the select occurs in admin discover mode.

Constructor Summary

Constructors
Constructor and Description

PreparedSelectorSpecification()
Constructs a PreparedSelectorSpecification.

Constructors
Constructor and Description
`PreparedSelectorSpecification()` Constructs a PreparedSelectorSpecification.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`forceResolve(LibrarySessionInterface sess)` Force a Resolve of this instance.
`void`	`forceResolveForCountQuery(LibrarySessionInterface sess)` Force a Resolve of this instance for a getItemCount() call.
`AttributeValue[]`	`getAuxiliarySearchTargets()` Returns the auxiliary search targets.
`AttributeValue[]`	`getBindValues()` Gets the bind values to use in the select statement.
`String[]`	`getBypassSecurityAliases()` Returns the bypass security aliases that were set using setBypassSecurityAliases().
`ColumnDescriptor[]`	`getColumnDescriptors()` Gets the column descriptors to use in the select statement.
`AttributeValue[]`	`getGeneratedCompleteBindValues()` Gets the generated complete set of Bind Values used in this query, including the bind values used for security.
`String[]`	`getGeneratedCompleteSqlFragments()` Gets the generated complete SQL fragments.
`String`	`getGeneratedCompleteSqlString()` Gets the generated complete SQL string.
`SearchTarget[]`	`getGeneratedSearchTargets()` Gets the generated Statement Key.
`String`	`getGeneratedStatementKey()` Gets the generated Statement Key.
`String`	`getHint()` Gets the SQL hint to use for the main select.
`String`	`getJoinCondition()` Returns the join condition that was set using setJoinCondition().
`int`	`getMaxItemCount()` Returns the maximum number of items that will be returned by `getItems`.
`AttributeValueTable`	`getPreparedSelectorOptions()` Gets the advanced PreparedSelector options.
`AttributeValue`	`getPrimarySearchTarget()` Returns the primary search target.
`String`	`getSearchLanguage()` Returns the search language in effect.
`String`	`getSearchSelection()` Returns the search selection that was set using setSearchSelection()
`AttributeValueTable`	`getSearchTargetsTable()` Gets the SearchTargets table, which holds info used to generate the SearchTarget objects.
`SortSpecification`	`getSortSpecification()` Returns the Sort Specification.
`int`	`getStartingRowNumber()` Returns the starting row number.
`String`	`getStatementKey()` Returns the statement key.
`boolean`	`isDistinct()` Returns true if distinct searching is enabled with respect to classes.
`boolean`	`isFolderIndexPartitionsEnabled()` Gets the search target option for determining whether to use FolderIndex partitions for generating the FRQ clause.
`boolean`	`isRecursiveSearch()` Returns true if recursive searching is enabled with respect to classes.
`boolean`	`isSmartViewsEnabled()` Gets the search target option for determining whether to use "Smart views" for generating the FROM clause to use explicit table joins instead of the odmv_ views.
`void`	`resolve(LibrarySessionInterface sess)` Resolve this instance.
`void`	`setAuxiliarySearchTargets(AttributeValue[] targets)` Sets the auxiliary search targets.
`void`	`setBindValues(AttributeValue[] bindValues)` Sets the bind values to use in the select statement.
`void`	`setBypassSecurityAliases(String[] bypassSecAliases)` Sets the aliases that indicates which PO classes should not have the security clause applied.
`void`	`setColumnDescriptors(ColumnDescriptor[] colDescs)` Sets the column descriptors to use in the select statement.
`void`	`setDistinct(boolean distinct)` Sets the indication as to whether a "select distinct" will be used.
`void`	`setGeneratedCompleteBindValues(AttributeValue[] values)` Sets the generated complete set of Bind Values used in this query, including the bind values used for security.
`void`	`setGeneratedCompleteSqlFragments(String[] fragments)` Sets the generated SQL fragments.
`void`	`setGeneratedCompleteSqlString(String sqlString)` Sets the generated complete SQL string.
`void`	`setGeneratedSearchTargets(SearchTarget[] targets)` Sets the generated search targets.
`void`	`setHint(String hint)` Sets the SQL hint to use for the main select.
`void`	`setJoinCondition(String joinCondition)` Sets the join condition.
`void`	`setMaxItemCount(int maxItemCount)` Sets the maximum number of items that will be returned by `getItems`.
`void`	`setPreparedSelectorOptions(AttributeValueTable options)` Sets the advanced PreparedSelector options.
`void`	`setPrimarySearchTarget(AttributeValue target)` Sets the primary search target.
`void`	`setRecursiveSearch(boolean recursive)` Enables/disables recursive searching with respect to the primary search target.
`void`	`setSearchLanguage(String language)` Sets the search language.
`void`	`setSearchSelection(String searchSelection)` Sets the search selection.
`void`	`setSearchTargetsTable(AttributeValueTable targetsTable)` Sets the SearchTargets table, which holds info used to generate the SearchTarget objects.
`void`	`setSortSpecification(SortSpecification sort)` Sets the Sort Specification.
`void`	`setSortSpecification(String sortCondition)` Sets the Sort Specification for the specified string.
`void`	`setStartingRowNumber(int rowNumber)` Sets the starting row number.
`void`	`setStatementKey(String key)` Sets the statement key.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPTIONS_SMART_VIEWS_ENABLED
```
public static final String OPTIONS_SMART_VIEWS_ENABLED
```
    The name of the advanced PreparedSelector option that indicates whether Smart Views are to be used.
    
    See Also:
    
    Constant Field Values
  - OPTIONS_FOLDERINDEX_PARTITIONS_ENABLED
```
public static final String OPTIONS_FOLDERINDEX_PARTITIONS_ENABLED
```
    The name of the advanced PreparedSelector option that indicates whether FolderIndex partitions are to be used.
    
    See Also:
    
    Constant Field Values
  - STATEMENTKEY_ADMIN_MODE_SUFFIX
```
public static final String STATEMENTKEY_ADMIN_MODE_SUFFIX
```
    The suffix to apply to statement keys when the select occurs in admin discover mode.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PreparedSelectorSpecification
```
public PreparedSelectorSpecification()
```
    Constructs a PreparedSelectorSpecification.
- Method Detail
  - getStatementKey
```
public String getStatementKey()
```
    Returns the statement key.
    
    Returns:
    
    the statement key
  - getSortSpecification
```
public SortSpecification getSortSpecification()
```
    Returns the Sort Specification.
    
    Returns:
    
    the search item sort specificaion
  - getPrimarySearchTarget
```
public AttributeValue getPrimarySearchTarget()
```
    Returns the primary search target.
    The AttributeValue returned encapulates the class name (as the AttributeValue's name) and the alias (as the AttributeValue's value).
    
    Returns:
    
    the primary search target
  - getAuxiliarySearchTargets
```
public AttributeValue[] getAuxiliarySearchTargets()
```
    Returns the auxiliary search targets.
    The AttributeValues returned encapulate the class name (as the AttributeValue's name) and the alias (as the AttributeValue's value).
    
    Returns:
    
    the auxiliary search targets
  - getColumnDescriptors
```
public ColumnDescriptor[] getColumnDescriptors()
```
    Gets the column descriptors to use in the select statement.
    
    Returns:
    
    the column descriptors
  - getBypassSecurityAliases
```
public String[] getBypassSecurityAliases()
```
    Returns the bypass security aliases that were set using setBypassSecurityAliases().
    
    Returns:
    
    the bypass security aliases
  - getJoinCondition
```
public String getJoinCondition()
```
    Returns the join condition that was set using setJoinCondition().
    
    Returns:
    
    the join condition
  - getSearchSelection
```
public String getSearchSelection()
```
    Returns the search selection that was set using setSearchSelection()
    
    Returns:
    
    the search selection
  - isDistinct
```
public boolean isDistinct()
```
    Returns true if distinct searching is enabled with respect to classes.
    
    Returns:
    
    true if distinct enabled
  - isRecursiveSearch
```
public boolean isRecursiveSearch()
```
    Returns true if recursive searching is enabled with respect to classes.
    
    Returns:
    
    true if recursive enabled
  - getSearchLanguage
```
public String getSearchLanguage()
```
    Returns the search language in effect.
    A value of null indicates that the default language should be used.
    
    Returns:
    
    the search language in effect
  - getMaxItemCount
```
public int getMaxItemCount()
```
    Returns the maximum number of items that will be returned by getItems.
    A value of zero indicates that there is no limit on the desired number of items.
    
    Returns:
    
    maximum number of items that will be returned
  - getStartingRowNumber
```
public int getStartingRowNumber()
```
    Returns the starting row number.
    The value is 1-based, meaning that if the value is set to 101, the first 100 rows will be skipped. A value of zero or less is treated the same same as a setting of 1, indicating that no rows are skipped.
    
    Returns:
    
    the starting row number
  - getHint
```
public String getHint()
```
    Gets the SQL hint to use for the main select.
    
    Returns:
    
    the SQL hint
  - getBindValues
```
public AttributeValue[] getBindValues()
```
    Gets the bind values to use in the select statement.
    
    Returns:
    
    the bind values
  - getPreparedSelectorOptions
```
public AttributeValueTable getPreparedSelectorOptions()
```
    Gets the advanced PreparedSelector options.
    
    Returns:
    
    the advanced PreparedSelector options
  - isSmartViewsEnabled
```
public boolean isSmartViewsEnabled()
                            throws IfsException
```
    Gets the search target option for determining whether to use "Smart views" for generating the FROM clause to use explicit table joins instead of the odmv_ views.
    
    Returns:
    
    the indication of whether to use smart views
    
    Throws:
    
    IfsException - if the operation fails
  - isFolderIndexPartitionsEnabled
```
public boolean isFolderIndexPartitionsEnabled()
                                       throws IfsException
```
    Gets the search target option for determining whether to use FolderIndex partitions for generating the FRQ clause.
    
    Returns:
    
    indication of whether to use FolderIndex partitions
    
    Throws:
    
    IfsException - if the operation fails
  - getSearchTargetsTable
```
public AttributeValueTable getSearchTargetsTable()
```
    Gets the SearchTargets table, which holds info used to generate the SearchTarget objects.
    
    Parameters:
    
    targetsTable - the SearchTargets table
  - getGeneratedStatementKey
```
public String getGeneratedStatementKey()
```
    Gets the generated Statement Key.
    
    Returns:
    
    the generated Statement Key
  - getGeneratedSearchTargets
```
public SearchTarget[] getGeneratedSearchTargets()
```
    Gets the generated Statement Key.
    
    Returns:
    
    the generated search targets
  - getGeneratedCompleteSqlString
```
public String getGeneratedCompleteSqlString()
```
    Gets the generated complete SQL string.
    
    Returns:
    
    the generated complete SQL string
  - getGeneratedCompleteSqlFragments
```
public String[] getGeneratedCompleteSqlFragments()
```
    Gets the generated complete SQL fragments.
    
    Returns:
    
    the generated SQL fragments.
  - getGeneratedCompleteBindValues
```
public AttributeValue[] getGeneratedCompleteBindValues()
```
    Gets the generated complete set of Bind Values used in this query, including the bind values used for security.
    
    Returns:
    
    the generated complete set of Bind Values.
  - setStatementKey
```
public void setStatementKey(String key)
```
    Sets the statement key.
    
    Parameters:
    
    key - the statement key
  - setDistinct
```
public void setDistinct(boolean distinct)
```
    Sets the indication as to whether a "select distinct" will be used.
    
    Parameters:
    
    distinct - true if distinct is used; false otherwise
  - setPrimarySearchTarget
```
public void setPrimarySearchTarget(AttributeValue target)
```
    Sets the primary search target.
    
    Parameters:
    
    target - the primary search target
  - setAuxiliarySearchTargets
```
public void setAuxiliarySearchTargets(AttributeValue[] targets)
```
    Sets the auxiliary search targets.
    
    Parameters:
    
    targets - the auxiliary search targets
  - setSortSpecification
```
public void setSortSpecification(String sortCondition)
```
    Sets the Sort Specification for the specified string.
    
    Parameters:
    
    sortCondition - the sort condition
  - setSortSpecification
```
public void setSortSpecification(SortSpecification sort)
```
    Sets the Sort Specification.
    
    Parameters:
    
    sort - the sort specificaion
  - setColumnDescriptors
```
public void setColumnDescriptors(ColumnDescriptor[] colDescs)
```
    Sets the column descriptors to use in the select statement.
    
    Parameters:
    
    colDescs - the column descriptors
  - setBypassSecurityAliases
```
public void setBypassSecurityAliases(String[] bypassSecAliases)
```
    Sets the aliases that indicates which PO classes should not have the security clause applied.
    
    Parameters:
    
    bypassSecAliases - the bypass security aliases
  - setJoinCondition
```
public void setJoinCondition(String joinCondition)
```
    Sets the join condition.
    
    Parameters:
    
    joinCondition - the join condition
  - setSearchSelection
```
public void setSearchSelection(String searchSelection)
```
    Sets the search selection.
    
    Parameters:
    
    searchSelection - the search selection
  - setRecursiveSearch
```
public void setRecursiveSearch(boolean recursive)
```
    Enables/disables recursive searching with respect to the primary search target.
    A setting of true is the default - meaning that the search results can include objects of the specific class indicated or one of its subclasses. A setting of false indicates that only instances of the exact class specified for the primary search target are returned.
    This legacy setting only applies to the primary search target, and not any auxiliary search targets. Use the PreparedSelectorGenerator Macro EXACT_TYPE to specify this behavior for any search target. this more generally.
    
    Parameters:
    
    recursive - true for enabled.
    
    Throws:
    
    IfsException - if the operation fails.
  - setSearchLanguage
```
public void setSearchLanguage(String language)
```
    Sets the search language.
    A value of null indicates that the default language should be used.
    
    Parameters:
    
    language - the search language
  - setMaxItemCount
```
public void setMaxItemCount(int maxItemCount)
```
    Sets the maximum number of items that will be returned by getItems.
    A value of zero indicates that there is no limit on the desired number of items.
    
    Parameters:
    
    maxItemCount - maximum number of items that will be returned
  - setStartingRowNumber
```
public void setStartingRowNumber(int rowNumber)
```
    Sets the starting row number.
    The value is 1-based, meaning that if the value is set to 101, the first 100 rows will be skipped. A value of zero or less is treated the same same as a setting of 1, indicating that no rows are skipped.
    
    Parameters:
    
    rowNumber - the starting row number
  - setHint
```
public void setHint(String hint)
```
    Sets the SQL hint to use for the main select.
    
    Parameters:
    
    hint - the SQL hint
  - setBindValues
```
public void setBindValues(AttributeValue[] bindValues)
```
    Sets the bind values to use in the select statement.
    
    Parameters:
    
    bindValues - the bind values
  - setPreparedSelectorOptions
```
public void setPreparedSelectorOptions(AttributeValueTable options)
```
    Sets the advanced PreparedSelector options.
    
    Parameters:
    
    options - the advanced PreparedSelector options
  - setSearchTargetsTable
```
public void setSearchTargetsTable(AttributeValueTable targetsTable)
```
    Sets the SearchTargets table, which holds info used to generate the SearchTarget objects.
    
    Parameters:
    
    targetsTable - the SearchTargets table
  - setGeneratedSearchTargets
```
public void setGeneratedSearchTargets(SearchTarget[] targets)
```
    Sets the generated search targets.
    
    Parameters:
    
    targets - the generated search targets
  - setGeneratedCompleteSqlString
```
public void setGeneratedCompleteSqlString(String sqlString)
```
    Sets the generated complete SQL string.
    
    Parameters:
    
    sqlString - the generated complete SQL string
  - setGeneratedCompleteSqlFragments
```
public void setGeneratedCompleteSqlFragments(String[] fragments)
```
    Sets the generated SQL fragments.
    
    Parameters:
    
    fragments - the generated SQL fragments.
  - setGeneratedCompleteBindValues
```
public void setGeneratedCompleteBindValues(AttributeValue[] values)
```
    Sets the generated complete set of Bind Values used in this query, including the bind values used for security.
    
    Parameters:
    
    values - the generated complete set of Bind Values.
  - resolve
```
public void resolve(LibrarySessionInterface sess)
             throws IfsException
```
    Resolve this instance.
    The normal resolve assumes that either getItems() or getSearchResults() will be invoked on the PreparedSelector. If getItemCount() is invoked instead, this instance will get re-resolved using forceResolveForCountQuery().
    
    Parameters:
    
    sess - the session context
    
    Throws:
    
    IfsException - if operation fails.
  - forceResolve
```
public void forceResolve(LibrarySessionInterface sess)
                  throws IfsException
```
    Force a Resolve of this instance.
    
    Parameters:
    
    sess - the session context
    
    Throws:
    
    IfsException - if operation fails.
  - forceResolveForCountQuery
```
public void forceResolveForCountQuery(LibrarySessionInterface sess)
                               throws IfsException
```
    Force a Resolve of this instance for a getItemCount() call.
    
    Parameters:
    
    sess - the session context
    
    Throws:
    
    IfsException - if operation fails.

Class PreparedSelectorSpecification

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPTIONS_SMART_VIEWS_ENABLED

OPTIONS_FOLDERINDEX_PARTITIONS_ENABLED

STATEMENTKEY_ADMIN_MODE_SUFFIX

Constructor Detail

PreparedSelectorSpecification

Method Detail

getStatementKey

getSortSpecification

getPrimarySearchTarget

getAuxiliarySearchTargets

getColumnDescriptors

getBypassSecurityAliases

getJoinCondition

getSearchSelection

isDistinct

isRecursiveSearch

getSearchLanguage

getMaxItemCount

getStartingRowNumber

getHint

getBindValues

getPreparedSelectorOptions

isSmartViewsEnabled

isFolderIndexPartitionsEnabled

getSearchTargetsTable

getGeneratedStatementKey

getGeneratedSearchTargets

getGeneratedCompleteSqlString

getGeneratedCompleteSqlFragments

getGeneratedCompleteBindValues

setStatementKey

setDistinct

setPrimarySearchTarget

setAuxiliarySearchTargets

setSortSpecification

setSortSpecification

setColumnDescriptors

setBypassSecurityAliases

setJoinCondition

setSearchSelection

setRecursiveSearch

setSearchLanguage

setMaxItemCount

setStartingRowNumber

setHint

setBindValues

setPreparedSelectorOptions

setSearchTargetsTable

setGeneratedSearchTargets

setGeneratedCompleteSqlString

setGeneratedCompleteSqlFragments

setGeneratedCompleteBindValues

resolve

forceResolve

forceResolveForCountQuery