OpenICF Operation Options
This chapter describes all of the predefined operation options by the OpenICF framework, along with notes about their use. Specific connectors may support only a subset of these options.
An option to use with Search (in conjunction with Container) that specifies how far beneath the specified container to search. Must be one of the following values:
- SCOPE_OBJECT
- SCOPE_ONE_LEVEL
- SCOPE_SUBTREE
An option to use with Search that specifies the container under which to perform the search. Must be of type QualifiedUid. Should be implemented for those object classes whose ObjectClassInfo.isContainer() returns true.
An option to use with Script on Resource and possibly others that specifies an account under which to execute the script/operation. The specified account will appear to have performed any action that the script/operation performs.
An option to use with Script on Resource and possibly others that specifies a password under which to execute the script/operation.
Determines which attributes to retrieve during Search and Sync. This option overrides the default behavior, which is for the connector to return exactly the set of attributes that are identified as returned by default in the schema for that connector. This option allows a client application to request additional attributes that would not otherwise not be returned (generally because such attributes are more expensive for a connector to fetch and to format) and/or to request only a subset of the attributes that would normally be returned.
An option to use with Search that specifies an opaque cookie which is used by the connector to track its position in the set of query results.
An option to use with Search that specifies the index within the result set of the first result which should be returned.
An option to use with Search that specifies the requested page results page size.
An option to use with Search that specifies the sort keys which should be used for ordering the ConnectorObject returned by search request.
This option is used with the Batch operation, to specify whether the batch process should be aborted when the first error is encountered. The default behavior is to continue processing regardless of errors.
This option instructs the connector to execute batched requests in a serial manner if possible. The default behavior of the Batch operation is to execute requests in parallel, for speed and efficiency. In either case the task ID must be reflected in the response for each task, so that tasks can be correctly reordered.
