C# Class Org.IdentityConnectors.Framework.Common.Objects.OperationOptions

Arbitrary options to be passed into various operations.
This serves as a catch-all for extra options.
Mostra file Open project: Tirasa/ConnId Class Usage Examples

Public Properties

Property Type Description
OP_ATTRIBUTES_TO_GET string
OP_PAGED_RESULTS_COOKIE string
OP_PAGED_RESULTS_OFFSET string
OP_PAGE_SIZE string
OP_RUN_AS_USER string
OP_RUN_WITH_PASSWORD string
OP_SORT_KEYS string

Public Methods

Method Description
OperationOptions ( Object>.IDictionary operationOptions ) : System

Public only for serialization; please use OperationOptionsBuilder.
ToString ( ) : string

Method Details

OperationOptions() public method

Public only for serialization; please use OperationOptionsBuilder.
public OperationOptions ( Object>.IDictionary operationOptions ) : System
operationOptions Object>.IDictionary The options.
return System

ToString() public method

public ToString ( ) : string
return string

Property Details

OP_ATTRIBUTES_TO_GET public_oe static_oe property

Determines the attributes to retrieve during SearchApiOp and Org.IdentityConnectors.Framework.Api.Operations.SyncApiOp.

This option overrides the default behavior, which is for the connector to return exactly the set of attributes that are identified as AttributeInfo#isReturnedByDefault() 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.

public static string OP_ATTRIBUTES_TO_GET
return string

OP_PAGED_RESULTS_COOKIE public_oe static_oe property

An option to use with SearchApiOp that specifies an opaque cookie which is used by the connector to track its position in the set of query results.
public static string OP_PAGED_RESULTS_COOKIE
return string

OP_PAGED_RESULTS_OFFSET public_oe static_oe property

An option to use with SearchApiOp that specifies the index within the result set of the first result which should be returned.
public static string OP_PAGED_RESULTS_OFFSET
return string

OP_PAGE_SIZE public_oe static_oe property

An option to use with SearchApiOp that specifies the requested page results page size.
public static string OP_PAGE_SIZE
return string

OP_RUN_AS_USER public_oe static_oe property

An option to use with Org.IdentityConnectors.Framework.Api.Operations.ScriptOnResourceApiOp 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.

Check the javadoc for a particular connector to see whether that connector supports this option.

public static string OP_RUN_AS_USER
return string

OP_RUN_WITH_PASSWORD public_oe static_oe property

An option to use with Org.IdentityConnectors.Framework.Api.Operations.ScriptOnResourceApiOp and possibly others that specifies a password under which to execute the script/operation.
public static string OP_RUN_WITH_PASSWORD
return string

OP_SORT_KEYS public_oe static_oe property

An option to use with SearchApiOp that specifies the sort keys which should be used for ordering the ConnectorObject returned by search request.
public static string OP_SORT_KEYS
return string