Arbitrary options to be passed into various operations. More...

Public Member Functions
	OperationOptions (IDictionary< String, Object > operationOptions)
	Public only for serialization; please use OperationOptionsBuilder. More...

override string	ToString ()

Public Attributes
const String	OP_SCOPE = "SCOPE"
	An option to use with SearchApiOp that specified the scope under which to perform the search. More...

const String	SCOPE_OBJECT = "object"

const String	SCOPE_ONE_LEVEL = "onelevel"

const String	SCOPE_SUBTREE = "subtree"

const String	OP_CONTAINER = "CONTAINER"
	An option to use with SearchApiOp that specified the container under which to perform the search. More...

Static Public Attributes
static readonly string	OP_RUN_AS_USER = "RUN_AS_USER"
	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. More...

static readonly string	OP_RUN_WITH_PASSWORD = "RUN_WITH_PASSWORD"
	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. More...

static readonly string	OP_ATTRIBUTES_TO_GET = "ATTRS_TO_GET"
	Determines the attributes to retrieve during SearchApiOp and Org.IdentityConnectors.Framework.Api.Operations.SyncApiOp. More...

Properties
IDictionary< String, Object >	Options `[get]`
	Returns a map of options. More...

String	Scope `[get]`
	Convenience method that returns OP_SCOPE. More...

QualifiedUid	getContainer `[get]`
	Convenience method that returns OP_CONTAINER. More...

string[]	AttributesToGet `[get]`
	Get the string array of attribute names to return in the object. More...

string	RunAsUser `[get]`
	Get the account to run the operation as.. More...

GuardedString	RunWithPassword `[get]`
	Get the password to run the operation as.. More...

Detailed Description

Arbitrary options to be passed into various operations.

This serves as a catch-all for extra options.

Constructor & Destructor Documentation

Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.OperationOptions ( IDictionary< String, Object > operationOptions )

Public only for serialization; please use OperationOptionsBuilder.

Parameters

operationOptions The options.

Member Data Documentation

readonly string Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.OP_ATTRIBUTES_TO_GET = "ATTRS_TO_GET"

static

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

const String Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.OP_CONTAINER = "CONTAINER"

An option to use with SearchApiOp that specified 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.

readonly string Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.OP_RUN_AS_USER = "RUN_AS_USER"

static

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.

readonly string Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.OP_RUN_WITH_PASSWORD = "RUN_WITH_PASSWORD"

static

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.

const String Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.OP_SCOPE = "SCOPE"

An option to use with SearchApiOp that specified the scope under which to perform the search.

To be used in conjunction with OP_CONTAINER. Must be one of the following values

SCOPE_OBJECT
SCOPE_ONE_LEVEL
SCOPE_SUBTREE

Property Documentation

string [] Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.AttributesToGet

get

Get the string array of attribute names to return in the object.

QualifiedUid Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.getContainer

get

Convenience method that returns OP_CONTAINER.

Returns: The value for OP_CONTAINER.

IDictionary<String, Object> Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.Options

get

Returns a map of options.

Each value in the map must be of a type that the framework can serialize. See Org.IdentityConnectors.Framework.Common.Serializer.ObjectSerializerFactory for a list of supported types.

Returns: A map of options.

string Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.RunAsUser

get

Get the account to run the operation as..

GuardedString Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.RunWithPassword

get

Get the password to run the operation as..

String Org.IdentityConnectors.Framework.Common.Objects.OperationOptions.Scope

get

Convenience method that returns OP_SCOPE.

Returns: The value for OP_SCOPE.

The documentation for this class was generated from the following file:

C:/ADE/icfbuild_docgen/icf/framework/.ade_path/dotnet/Framework/CommonObjects.cs

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation

Property Documentation