public class CoreSearchManager extends SearchManagerImpl
Modifier and Type | Field and Description |
---|---|
protected static AttributeRequest[] |
ATTRIBUTE_DETAILS_REQ |
Constructor and Description |
---|
CoreSearchManager()
Constructor required for web services.
|
CoreSearchManager(FdkSession session)
Constructor required for in-process clients.
|
Modifier and Type | Method and Description |
---|---|
NamedValue[] |
executeSelect(NamedValue priTarget,
NamedValue[] auxTargets,
String searchCondition,
String sortCondition,
NamedValue[] bindVals,
NamedValue[] options,
AttributeRequest[] attrReqs)
Executes a search using a prepared selector.
|
int |
executeSelectCount(NamedValue priTarget,
NamedValue[] auxTargets,
String searchCondition,
NamedValue[] bindVals,
NamedValue[] options)
Executes a search to obtain the result count using a prepared selector.
|
protected FdkSessionImpl |
getConnectedSession()
Return the web service session.
|
NamedValueSet[] |
getProperties()
Returns the property information for the seach properties.
|
protected boolean |
isWebServiceCall()
Returns
true if the current call was made from a web services
client. |
protected NamedValue[] |
login(FdkCredential c,
NamedValue[] options,
AttributeRequest[] userAttributes)
Internal login method used by web services login managers.
|
void |
referenceTypes(TypeReference ref)
Dummy web service method to create a reference to data types used
in the web services to insure that they are defined in the WSDL.
|
NamedValue[] |
search(SearchExpression expr,
NamedValue[] options,
AttributeRequest[] attrReqs)
Performs a search.
|
protected static final AttributeRequest[] ATTRIBUTE_DETAILS_REQ
public CoreSearchManager()
public CoreSearchManager(FdkSession session)
public NamedValueSet[] getProperties() throws FdkException
SearchManager
FdkException
- if the operation failspublic NamedValue[] search(SearchExpression expr, NamedValue[] options, AttributeRequest[] attrReqs) throws FdkException
SearchManager
expr
- the query expression for the search represented as
a SearchExpressionoptions
- the options for the search:
attrReqs
- the requested attributes for each item, or null.FdkException
- if the operation failsSearchExpression
public NamedValue[] executeSelect(NamedValue priTarget, NamedValue[] auxTargets, String searchCondition, String sortCondition, NamedValue[] bindVals, NamedValue[] options, AttributeRequest[] attrReqs) throws FdkException
SearchManager
priTarget
- the primary search targetauxTargets
- the auxiliary search targets (can be null)searchCondition
- the search condition (may include functions)sortCondition
- the sort condition (may include functions)bindVals
- the statement bind valuesoptions
- the search optionsattrReqs
- the requested attributes for each search result
item returned (can be null).Note: Bind Variables must be leveraged at every opportunity to minimize possibility of a SQL injection attack (should unprocessed end-user supplied data be provided to the query).
FdkException
- if the operation fails;public int executeSelectCount(NamedValue priTarget, NamedValue[] auxTargets, String searchCondition, NamedValue[] bindVals, NamedValue[] options) throws FdkException
SearchManager
priTarget
- the primary search targetauxTargets
- the auxiliary search targets (can be null)searchCondition
- the search condition (may include functions)bindVals
- the statement bind valuesoptions
- the search optionsNote: Bind Variables must be leveraged at every opportunity to minimize possibility of a SQL injection attack (should unprocessed end-user supplied data be provided to the query).
FdkException
- if the operation fails;protected final boolean isWebServiceCall()
true
if the current call was made from a web services
client. This check can be made by any subclasses in order to determine
functionality and restrictions based on the originating call. This
feature should be used lightly and only where really necessary as
this is not an idea way of implementing business logic.public void referenceTypes(TypeReference ref)
protected final NamedValue[] login(FdkCredential c, NamedValue[] options, AttributeRequest[] userAttributes) throws FdkException
FdkException
protected final FdkSessionImpl getConnectedSession() throws FdkException
FdkException
Copyright © 2023. All rights reserved.