Org.IdentityConnectors.Framework.Api.ConfigurationProperty Interface Reference

Translation from Org.IdentityConnectors.Framework.Spi.Configuration at the SPI layer to the API. More...

Public Member Functions
string	GetHelpMessage (string def)
	Get the help message from the message catalog. More...
string	GetDisplayName (string def)
	Get the display name for the is configuration More...

Properties
int	Order [get]
string	Name [get]
	Get the unique name of the configuration property. More...
object	Value [get, set]
	Get the value from the property. More...
Type	ValueType [get]
	Get the type of the property. More...
bool	IsConfidential [get]
	Is this a confidential property whose value should be encrypted by the application when persisted? More...
bool	IsRequired [get]
	Is this a required property More...
ICollection< SafeType < APIOperation > >	Operations [get]
	Set of operations for which this property must be specified. More...

Detailed Description

Translation from Org.IdentityConnectors.Framework.Spi.Configuration at the SPI layer to the API.

Member Function Documentation

string Org.IdentityConnectors.Framework.Api.ConfigurationProperty.GetDisplayName

(

string

def

)

Get the display name for the is configuration

string Org.IdentityConnectors.Framework.Api.ConfigurationProperty.GetHelpMessage

(

string

def

)

Get the help message from the message catalog.

Property Documentation

bool Org.IdentityConnectors.Framework.Api.ConfigurationProperty.IsConfidential

get

Is this a confidential property whose value should be encrypted by the application when persisted?

bool Org.IdentityConnectors.Framework.Api.ConfigurationProperty.IsRequired

get

Is this a required property

Returns

True if the property is required

string Org.IdentityConnectors.Framework.Api.ConfigurationProperty.Name

get

Get the unique name of the configuration property.

ICollection<SafeType<APIOperation> > Org.IdentityConnectors.Framework.Api.ConfigurationProperty.Operations

get

Set of operations for which this property must be specified.

This is used for the case where a connector may or may not implement certain operations depending in the configuration. The default value of "empty array" is special in that it means that this property is applicable to all operations.

object Org.IdentityConnectors.Framework.Api.ConfigurationProperty.Value

getset

Get the value from the property.

This should be the default value.

Type Org.IdentityConnectors.Framework.Api.ConfigurationProperty.ValueType

get

Get the type of the property.

---

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

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