Determines the objects supported by a Org.IdentityConnectors.Framework.Spi.Connector. More...

Public Member Functions
	Schema (ICollection< ObjectClassInfo > info, ICollection< OperationOptionInfo > options, IDictionary< SafeType< APIOperation >, ICollection< ObjectClassInfo >> supportedObjectClassesByOperation, IDictionary< SafeType< APIOperation >, ICollection< OperationOptionInfo >> supportedOptionsByOperation)
	Public only for serialization; please use SchemaBuilder instead. More...

ObjectClassInfo	FindObjectClassInfo (String type)
	Returns the ObjectClassInfo for the given type. More...

OperationOptionInfo	FindOperationOptionInfo (String name)
	Returns the OperationOptionInfo for the given name. More...

ICollection< ObjectClassInfo >	GetSupportedObjectClassesByOperation (SafeType< APIOperation > apiop)
	Returns the supported object classes for the given operation. More...

ICollection< OperationOptionInfo >	GetSupportedOptionsByOperation (SafeType< APIOperation > apiop)
	Returns the supported options for the given operation. More...

override int	GetHashCode ()

override bool	Equals (object o)

override string	ToString ()

Properties
ICollection< ObjectClassInfo >	ObjectClassInfo `[get]`
	Returns the set of object classes that are defined in the schema, regardless of which operations support them. More...

ICollection< OperationOptionInfo >	OperationOptionInfo `[get]`
	Returns the set of operation options that are defined in the schema, regardless of which operations support them. More...

IDictionary< SafeType < APIOperation >, ICollection < ObjectClassInfo > >	SupportedObjectClassesByOperation `[get]`
	Returns the set of object classes that apply to a particular operation. More...

IDictionary< SafeType < APIOperation >, ICollection < OperationOptionInfo > >	SupportedOptionsByOperation `[get]`
	Returns the set of operation options that apply to a particular operation. More...

Detailed Description

Determines the objects supported by a Org.IdentityConnectors.Framework.Spi.Connector.

The Schema object is used to represent the basic objects that a connector supports. This does not prevent a connector from supporting more. Rather, this is informational for the caller of the connector to understand a minimum support level. The schema defines 4 primary data structures

Declared ObjectClasses (ObjectClassInfo).
Declared OperationOptionInfo (OperationOptionInfo).
Supported ObjectClasses by operation (SupportedObjectClassesByOperation).
Supported OperationOptionInfo by operation(SupportedOptionsByOperation).

TODO: add more to describe and what is expected from this call and how it is used.. based on OperationalAttribute etc..

Constructor & Destructor Documentation

Org.IdentityConnectors.Framework.Common.Objects.Schema.Schema	(	ICollection< ObjectClassInfo >	info,
		ICollection< OperationOptionInfo >	options,
		IDictionary< SafeType< APIOperation >, ICollection< ObjectClassInfo >>	supportedObjectClassesByOperation,
		IDictionary< SafeType< APIOperation >, ICollection< OperationOptionInfo >>	supportedOptionsByOperation
	)

Public only for serialization; please use SchemaBuilder instead.

Parameters

info
supportedObjectClassesByOperation

Member Function Documentation

ObjectClassInfo Org.IdentityConnectors.Framework.Common.Objects.Schema.FindObjectClassInfo ( String type )

Returns the ObjectClassInfo for the given type.

Parameters

type	The type to find.

Returns: the ObjectClassInfo for the given type or null if not found.

OperationOptionInfo Org.IdentityConnectors.Framework.Common.Objects.Schema.FindOperationOptionInfo ( String name )

Returns the OperationOptionInfo for the given name.

Parameters

name	The name to find.

Returns: the OperationOptionInfo for the given name or null if not found.

ICollection<ObjectClassInfo> Org.IdentityConnectors.Framework.Common.Objects.Schema.GetSupportedObjectClassesByOperation ( SafeType< APIOperation > apiop )

Returns the supported object classes for the given operation.

Parameters

apiop The operation.

Returns: the supported object classes for the given operation.

ICollection<OperationOptionInfo> Org.IdentityConnectors.Framework.Common.Objects.Schema.GetSupportedOptionsByOperation ( SafeType< APIOperation > apiop )

Returns the supported options for the given operation.

Parameters

apiop The operation.

Returns: the supported options for the given operation.

Property Documentation

ICollection<ObjectClassInfo> Org.IdentityConnectors.Framework.Common.Objects.Schema.ObjectClassInfo

get

Returns the set of object classes that are defined in the schema, regardless of which operations support them.

ICollection<OperationOptionInfo> Org.IdentityConnectors.Framework.Common.Objects.Schema.OperationOptionInfo

get

Returns the set of operation options that are defined in the schema, regardless of which operations support them.

Returns: The options defined in this schema.

IDictionary<SafeType<APIOperation>, ICollection<ObjectClassInfo> > Org.IdentityConnectors.Framework.Common.Objects.Schema.SupportedObjectClassesByOperation

get

Returns the set of object classes that apply to a particular operation.

Returns: the set of object classes that apply to a particular operation.

IDictionary<SafeType<APIOperation>, ICollection<OperationOptionInfo> > Org.IdentityConnectors.Framework.Common.Objects.Schema.SupportedOptionsByOperation

get

Returns the set of operation options that apply to a particular operation.

Returns: the set of operation options that apply to a particular operation.

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

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation