Simplifies the process of building 'AttributeInfo' objects. More...

Public Member Functions
	ConnectorAttributeInfoBuilder ()
	Creates an builder with all the defaults set. More...

	ConnectorAttributeInfoBuilder (String name)
	Creates an builder with all the defaults set. More...

	ConnectorAttributeInfoBuilder (String name, Type type)
	Creates an builder with all the defaults set. More...

ConnectorAttributeInfo	Build ()
	Builds an ConnectorAttributeInfo object based on the properties set. More...

Static Public Member Functions
static ConnectorAttributeInfo	Build (String name, Type type, ConnectorAttributeInfo.Flags flags)
	Convenience method to create an AttributeInfo. More...

static ConnectorAttributeInfo	Build (String name, Type type)
	Convenience method to create an AttributeInfo. More...

static ConnectorAttributeInfo	Build (String name)
	Convenience method to create an AttributeInfo. More...

static ConnectorAttributeInfo	BuildCurrentAttributes (String objectClassName)
	Convenience method to create AttributeInfo for CURRENT_ATTRIBUTES operational attribute. More...

Properties
String	Name `[set]`
	Sets the unique name of the ConnectorAttributeInfo object. More...

Type	ValueType `[set]`
	Please see FrameworkUtil.CheckAttributeType(Type) for the definitive list of supported types. More...

string	ObjectClassName `[set]`
	For attributes that hold an embedded object, sets the name of the object class representing that object. More...

bool	Readable `[set]`
	Determines if the attribute is readable. More...

bool	Creatable `[set]`
	Determines if the attribute is writable. More...

bool	Required `[set]`
	Determines if this attribute is required. More...

bool	MultiValued `[set]`
	Determines if this attribute supports multivalue. More...

bool	Updateable `[set]`
	Determines if this attribute writable during update. More...

bool	ReturnedByDefault `[set]`

ConnectorAttributeInfo.Flags	InfoFlags `[set]`
	Sets all of the flags for this builder. More...

Detailed Description

Simplifies the process of building 'AttributeInfo' objects.

This class is responsible for providing a default implementation of ConnectorAttributeInfo.

AttributeInfoBuilder bld = new AttributeInfoBuilder("email");
bld.setRequired(true);
AttributeInfo info = bld.build();

<author>Will Droste</author> <version>

Revision: /main/2

</version> <since>1.0</since>

Constructor & Destructor Documentation

Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.ConnectorAttributeInfoBuilder ( )

Creates an builder with all the defaults set.

The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown.

Name: <not set>
Readable: true
Writeable: true
Required: false
Type: string
MultiValue: false

Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.ConnectorAttributeInfoBuilder ( String name )

Creates an builder with all the defaults set.

The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown.

Name: <not set>
Readable: true
Writeable: true
Required: false
Type: string
MultiValue: false

Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.ConnectorAttributeInfoBuilder	(	String	name,
		Type	type
	)

Creates an builder with all the defaults set.

The name must be set before the 'build' method is called otherwise an IllegalStateException is thrown.

Name: <not set>
Readable: true
Writeable: true
Required: false
Type: string
MultiValue: false

Member Function Documentation

ConnectorAttributeInfo Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Build ( )

Builds an ConnectorAttributeInfo object based on the properties set.

Returns: ConnectorAttributeInfo based on the properties set.

static ConnectorAttributeInfo Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Build	(	String	name,
		Type	type,
		ConnectorAttributeInfo.Flags	flags
	)

static

Convenience method to create an AttributeInfo.

Equivalent to

new AttributeInfoBuilder(name,type).setFlags(flags).build()

Parameters

name	The name of the attribute
type	The type of the attribute
flags	The flags for the attribute. Null means clear all flags

Returns: The attribute info

static ConnectorAttributeInfo Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Build	(	String	name,
		Type	type
	)

static

Convenience method to create an AttributeInfo.

Equivalent to

AttributeInfoBuilder.build(name,type,null)

Parameters

name	The name of the attribute
type	The type of the attribute
flags	The flags for the attribute

Returns: The attribute info

static ConnectorAttributeInfo Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Build ( String name )

static

Convenience method to create an AttributeInfo.

Equivalent to

AttributeInfoBuilder.build(name,type)

Parameters

name	The name of the attribute

Returns: The attribute info

static ConnectorAttributeInfo Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.BuildCurrentAttributes ( String objectClassName )

static

Convenience method to create AttributeInfo for CURRENT_ATTRIBUTES operational attribute.

Parameters

objectClassName Object class name

Returns: The attribute info

Property Documentation

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Creatable

set

Determines if the attribute is writable.

ConnectorAttributeInfo.Flags Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.InfoFlags

set

Sets all of the flags for this builder.

Parameters

flags The set of attribute info flags. Null means clear all flags.

NOTE: EnumSet.noneOf(AttributeInfo.Flags.class) results in an attribute with the default behavior:

updateable
creatable
returned by default
readable
single-valued
optional

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.MultiValued

set

Determines if this attribute supports multivalue.

String Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Name

set

Sets the unique name of the ConnectorAttributeInfo object.

Parameters

name	unique name of the ConnectorAttributeInfo object.

string Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.ObjectClassName

set

For attributes that hold an embedded object, sets the name of the object class representing that object.

Parameters

objectClassName the name of the object class.

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Readable

set

Determines if the attribute is readable.

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Required

set

Determines if this attribute is required.

bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.Updateable

set

Determines if this attribute writable during update.

Type Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfoBuilder.ValueType

set

Please see FrameworkUtil.CheckAttributeType(Type) for the definitive list of supported types.

Parameters

value type for an ConnectorAttribute's value.

Exceptions

ArgumentException if the Class is not a supported type.

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

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation