Class IterateQueryOptions
- java.lang.Object
-
- com.identityworksllc.iiq.common.query.IterateQueryOptions
-
public final class IterateQueryOptions extends Object
The input VO forQueryUtil.iterateQuery(IterateQueryOptions)
, mainly to encapsulate the variety of inputs in one place.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IterateQueryOptions.IterateQueryOptionsBuilder
A builder for IterateQueryInputs objects.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IterateQueryOptions.IterateQueryOptionsBuilder
builder()
Returns a new builder object for creating anIterateQueryOptions
void
doCallback(Map<String,Object> row)
Invoked byQueryUtil.iterateQuery(IterateQueryOptions)
once per row in the result setvoid
doParallelCallback(sailpoint.api.SailPointContext threadContext, Map<String,Object> row)
Invoked byQueryUtil.iterateQuery(IterateQueryOptions)
once per row in the result set.bsh.This
getBshThis()
String
getCallback()
String
getQuery()
Map<String,Object>
getQueryParams()
Connection
openConnection()
IterateQueryOptions
withNewQueryParams(Map<String,Object> newParams)
Returns a newIterateQueryOptions
with a different set of query parameters.
-
-
-
Method Detail
-
builder
public static IterateQueryOptions.IterateQueryOptionsBuilder builder()
Returns a new builder object for creating anIterateQueryOptions
- Returns:
- The new builder object
-
doCallback
public void doCallback(Map<String,Object> row) throws sailpoint.tools.GeneralException
Invoked byQueryUtil.iterateQuery(IterateQueryOptions)
once per row in the result set- Parameters:
row
- a Map representing the current row from the result set- Throws:
sailpoint.tools.GeneralException
- if anything goes wrong during the callback
-
doParallelCallback
public void doParallelCallback(sailpoint.api.SailPointContext threadContext, Map<String,Object> row) throws sailpoint.tools.GeneralException
Invoked byQueryUtil.iterateQuery(IterateQueryOptions)
once per row in the result set.- Parameters:
row
- a Map representing the current row from the result set- Throws:
sailpoint.tools.GeneralException
- if anything goes wrong during the callback
-
getBshThis
public bsh.This getBshThis()
-
getCallback
public String getCallback()
-
getQueryParams
public Map<String,Object> getQueryParams()
-
openConnection
public Connection openConnection() throws sailpoint.tools.GeneralException
- Throws:
sailpoint.tools.GeneralException
-
withNewQueryParams
public IterateQueryOptions withNewQueryParams(Map<String,Object> newParams)
Returns a newIterateQueryOptions
with a different set of query parameters.This can be used to run the same query for various inputs without having to rebuild the entire object.
- Parameters:
newParams
- The new query params- Returns:
- The new object, identical to this one than swapping out the query params
-
-