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

Simple builder class to help facilitate creating a Schema object.
Datei anzeigen Open project: Tirasa/ConnId Class Usage Examples

Public Methods

Method Description
AddSupportedObjectClass ( SafeType op, ObjectClassInfo def ) : void

Adds the given ObjectClassInfo as a supported ObjectClass for the given operation.
AddSupportedOperationOption ( SafeType op, OperationOptionInfo def ) : void

Adds the given OperationOptionInfo as a supported option for the given operation.
Build ( ) : Schema

Builds the Schema object based on the ObjectClassInfos added so far.
ClearSupportedObjectClassesByOperation ( ) : void

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).

ClearSupportedOptionsByOperation ( ) : void

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).

DefineObjectClass ( ObjectClassInfo info ) : void

Adds another ObjectClassInfo to the schema.

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

DefineObjectClass ( String type, ICollection attrInfo ) : void

Adds another ObjectClassInfo to the schema.

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

DefineOperationOption ( OperationOptionInfo info ) : void

Adds another OperationOptionInfo to the schema.

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

DefineOperationOption ( String optionName, Type type ) : void

Adds another OperationOptionInfo to the schema.

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

RemoveSupportedObjectClass ( SafeType op, ObjectClassInfo def ) : void

Removes the given ObjectClassInfo as a supported ObjectClass for the given operation.
RemoveSupportedOperationOption ( SafeType op, OperationOptionInfo def ) : void

Removes the given OperationOptionInfo as a supported option for the given operation.
SchemaBuilder ( SafeType connectorClass ) : System

Private Methods

Method Description
ObjectClassOperation ( SafeType op ) : bool
OperationOptionOperation ( SafeType op ) : bool

Method Details

AddSupportedObjectClass() public method

Adds the given ObjectClassInfo as a supported ObjectClass for the given operation.
If the given ObjectClassInfo was /// not already defined using .
public AddSupportedObjectClass ( SafeType op, ObjectClassInfo def ) : void
op SafeType The SPI operation
def ObjectClassInfo The ObjectClassInfo
return void

AddSupportedOperationOption() public method

Adds the given OperationOptionInfo as a supported option for the given operation.
If the given OperationOptionInfo was /// not already defined using .
public AddSupportedOperationOption ( SafeType op, OperationOptionInfo def ) : void
op SafeType The SPI operation
def OperationOptionInfo The OperationOptionInfo
return void

Build() public method

Builds the Schema object based on the ObjectClassInfos added so far.
public Build ( ) : Schema
return Schema

ClearSupportedObjectClassesByOperation() public method

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).
public ClearSupportedObjectClassesByOperation ( ) : void
return void

ClearSupportedOptionsByOperation() public method

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).
public ClearSupportedOptionsByOperation ( ) : void
return void

DefineObjectClass() public method

Adds another ObjectClassInfo to the schema.
Also, adds this to the set of supported classes for every operation defined by the Connector.
If already defined
public DefineObjectClass ( ObjectClassInfo info ) : void
info ObjectClassInfo
return void

DefineObjectClass() public method

Adds another ObjectClassInfo to the schema.
Also, adds this to the set of supported classes for every operation defined by the Connector.
If already defined
public DefineObjectClass ( String type, ICollection attrInfo ) : void
type String
attrInfo ICollection
return void

DefineOperationOption() public method

Adds another OperationOptionInfo to the schema.
Also, adds this to the set of supported options for every operation defined by the Connector.
public DefineOperationOption ( OperationOptionInfo info ) : void
info OperationOptionInfo
return void

DefineOperationOption() public method

Adds another OperationOptionInfo to the schema.
Also, adds this to the set of supported options for every operation defined by the Connector.
If already defined
public DefineOperationOption ( String optionName, Type type ) : void
optionName String
type System.Type
return void

RemoveSupportedObjectClass() public method

Removes the given ObjectClassInfo as a supported ObjectClass for the given operation.
If the given ObjectClassInfo was /// not already defined using .
public RemoveSupportedObjectClass ( SafeType op, ObjectClassInfo def ) : void
op SafeType The SPI operation
def ObjectClassInfo The ObjectClassInfo
return void

RemoveSupportedOperationOption() public method

Removes the given OperationOptionInfo as a supported option for the given operation.
If the given OperationOptionInfo was /// not already defined using .
public RemoveSupportedOperationOption ( SafeType op, OperationOptionInfo def ) : void
op SafeType The SPI operation
def OperationOptionInfo The OperationOptionInfo
return void

SchemaBuilder() public method

public SchemaBuilder ( SafeType connectorClass ) : System
connectorClass SafeType
return System