Simple builder class to help facilitate creating a Schema object. More...

Public Member Functions
	SchemaBuilder (SafeType< Connector > connectorClass)

void	DefineObjectClass (ObjectClassInfo info)
	Adds another ObjectClassInfo to the schema. More...

void	DefineOperationOption (OperationOptionInfo info)
	Adds another OperationOptionInfo to the schema. More...

void	DefineObjectClass (String type, ICollection< ConnectorAttributeInfo > attrInfo)
	Adds another ObjectClassInfo to the schema. More...

void	DefineOperationOption (String optionName, Type type)
	Adds another OperationOptionInfo to the schema. More...

void	AddSupportedObjectClass (SafeType< SPIOperation > op, ObjectClassInfo def)
	Adds the given ObjectClassInfo as a supported ObjectClass for the given operation. More...

void	RemoveSupportedObjectClass (SafeType< SPIOperation > op, ObjectClassInfo def)
	Removes the given ObjectClassInfo as a supported ObjectClass for the given operation. More...

void	AddSupportedOperationOption (SafeType< SPIOperation > op, OperationOptionInfo def)
	Adds the given OperationOptionInfo as a supported option for the given operation. More...

void	RemoveSupportedOperationOption (SafeType< SPIOperation > op, OperationOptionInfo def)
	Removes the given OperationOptionInfo as a supported option for the given operation. More...

void	ClearSupportedObjectClassesByOperation ()
	Clears the operation-specific supported classes. More...

void	ClearSupportedOptionsByOperation ()
	Clears the operation-specific supported options. More...

Schema	Build ()
	Builds the Schema object based on the ObjectClassInfos added so far. More...

Detailed Description

Simple builder class to help facilitate creating a Schema object.

Constructor & Destructor Documentation

Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.SchemaBuilder ( SafeType< Connector > connectorClass )

Member Function Documentation

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.AddSupportedObjectClass	(	SafeType< SPIOperation >	op,
		ObjectClassInfo	def
	)

Adds the given ObjectClassInfo as a supported ObjectClass for the given operation.

Parameters

op	The SPI operation
def	The ObjectClassInfo

Exceptions

ArgumentException If the given ObjectClassInfo was not already defined using DefineObjectClass(ObjectClassInfo).

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.AddSupportedOperationOption	(	SafeType< SPIOperation >	op,
		OperationOptionInfo	def
	)

Adds the given OperationOptionInfo as a supported option for the given operation.

Parameters

op	The SPI operation
def	The OperationOptionInfo

Exceptions

ArgumentException If the given OperationOptionInfo was not already defined using DefineOperationOption(OperationOptionInfo).

Schema Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.Build ( )

Builds the Schema object based on the ObjectClassInfos added so far.

Returns: new Schema object based on the info provided.

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.ClearSupportedObjectClassesByOperation ( )

Clears the operation-specific supported classes.

Normally, when you add an ObjectClass, using DefineObjectClass(ObjectClassInfo), it is added to all operations. You may then remove those that you need using RemoveSupportedObjectClass(SafeType{SPIOperation}, ObjectClassInfo). You may wish, as an alternative to clear everything out and instead add using AddSupportedObjectClass(SafeType{SPIOperation}, ObjectClassInfo).

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.ClearSupportedOptionsByOperation ( )

Clears the operation-specific supported options.

Normally, when you add an OperationOptionInfo, using DefineOperationOption(OperationOptionInfo), it is added to all operations. You may then remove those that you need using RemoveSupportedOperationOption(SafeType{SPIOperation}, OperationOptionInfo). You may wish, as an alternative to clear everything out and instead add using AddSupportedOperationOption(SafeType{SPIOperation}, OperationOptionInfo).

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.DefineObjectClass ( ObjectClassInfo info )

Adds another ObjectClassInfo to the schema.

Also, adds this to the set of supported classes for every operation defined by the Connector.

Parameters

info

Exceptions

IllegalStateException If already defined

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.DefineObjectClass	(	String	type,
		ICollection< ConnectorAttributeInfo >	attrInfo
	)

Adds another ObjectClassInfo to the schema.

Also, adds this to the set of supported classes for every operation defined by the Connector.

Exceptions

IllegalStateException If already defined

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.DefineOperationOption ( OperationOptionInfo info )

Adds another OperationOptionInfo to the schema.

Also, adds this to the set of supported options for every operation defined by the Connector.

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.DefineOperationOption	(	String	optionName,
		Type	type
	)

Adds another OperationOptionInfo to the schema.

Also, adds this to the set of supported options for every operation defined by the Connector.

Exceptions

IllegalStateException If already defined

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.RemoveSupportedObjectClass	(	SafeType< SPIOperation >	op,
		ObjectClassInfo	def
	)

Removes the given ObjectClassInfo as a supported ObjectClass for the given operation.

Parameters

op	The SPI operation
def	The ObjectClassInfo

Exceptions

ArgumentException If the given ObjectClassInfo was not already defined using DefineObjectClass(ObjectClassInfo).

void Org.IdentityConnectors.Framework.Common.Objects.SchemaBuilder.RemoveSupportedOperationOption	(	SafeType< SPIOperation >	op,
		OperationOptionInfo	def
	)

Removes the given OperationOptionInfo as a supported option for the given operation.

Parameters

op	The SPI operation
def	The OperationOptionInfo

Exceptions

ArgumentException If the given OperationOptionInfo was not already defined using DefineOperationOption(OperationOptionInfo).

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation