Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder Class Reference

Builds an ScriptContext. More...

Public Member Functions
	ScriptContextBuilder ()
	Creates an empty builder. More...
	ScriptContextBuilder (String scriptLanguage, String scriptText)
	Creates a builder with the required parameters specified. More...
ScriptContextBuilder	AddScriptArgument (String name, Object value)
	Adds or sets an argument to pass to the script. More...
ScriptContextBuilder	RemoveScriptArgument (String name)
	Removes the given script argument. More...
ScriptContext	Build ()
	Creates a More...

Properties
String	ScriptLanguage [get, set]
	Identifies the language in which the script is written (e.g., More...
String	ScriptText [get, set]
	Returns the actual characters of the script. More...
IDictionary< String, Object >	ScriptArguments [get]
	Returns a mutable reference of the script arguments map. More...

Detailed Description

Builds an ScriptContext.

Constructor & Destructor Documentation

Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.ScriptContextBuilder

(

)

Creates an empty builder.

Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.ScriptContextBuilder	(	String	scriptLanguage,
		String	scriptText
	)

Creates a builder with the required parameters specified.

Parameters

scriptLanguage	a string that identifies the language in which the script is written (e.g., bash, csh, Perl4 or Python).
scriptText	The text (i.e., actual characters) of the script.

Member Function Documentation

ScriptContextBuilder Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.AddScriptArgument	(	String	name,
		Object	value
	)

Adds or sets an argument to pass to the script.

Parameters

name	The name of the argument. Must not be null.
value	The value of the argument. Must be one of type types that the framework can serialize.

See also

Org.IdentityConnectors.Framework.Common.Serializer.ObjectSerializerFactory

ScriptContext Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.Build

(

)

Creates a

ScriptContext.

The

scriptLanguage

and

scriptText

must be set prior to calling this.

Returns

The

ScriptContext

.

ScriptContextBuilder Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.RemoveScriptArgument

(

String

name

)

Removes the given script argument.

Parameters

name	The name of the argument. Must not be null.

Property Documentation

IDictionary<String, Object> Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.ScriptArguments

get

Returns a mutable reference of the script arguments map.

Returns

A mutable reference of the script arguments map.

String Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.ScriptLanguage

getset

Identifies the language in which the script is written (e.g.,

bash, csh, Perl4 or Python).

Returns

The script language.

String Org.IdentityConnectors.Framework.Common.Objects.ScriptContextBuilder.ScriptText

getset

Returns the actual characters of the script.

Returns

the actual characters of the script.

---

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

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