Oracle® Fusion Middleware .NET API Reference for Identity Connector Framework  E57662-01
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Package Functions | Properties | List of all members
Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo Class Reference

Public Types

enum  Flags {
  NONE = 0, REQUIRED = 1, MULTIVALUED = 2, NOT_CREATABLE = 4,
  NOT_UPDATEABLE = 8, NOT_READABLE = 16, NOT_RETURNED_BY_DEFAULT = 32
}
 Enum of modifier flags to use for attributes. More...
 

Public Member Functions

bool Is (string name)
 
override bool Equals (Object o)
 
override int GetHashCode ()
 
override string ToString ()
 

Package Functions

 ConnectorAttributeInfo (string name, Type type, string objectClassName, Flags flags)
 

Properties

string Name [get]
 The native name of the attribute. More...
 
Type ValueType [get]
 The basic type associated with this attribute. More...
 
string ObjectClassName [get]
 For attributes that hold an embedded object, returns the name of the object class representing that object. More...
 
Flags InfoFlags [get]
 Returns the set of flags associated with the attribute. More...
 
bool IsReadable [get]
 Determines if the attribute is readable. More...
 
bool IsCreatable [get]
 Determines if the attribute is writable on create. More...
 
bool IsUpdateable [get]
 Determines if the attribute is writable on update. More...
 
bool IsRequired [get]
 Determines whether this attribute is required for creates. More...
 
bool IsMultiValued [get]
 Determines if this attribute can handle multiple values. More...
 
bool IsReturnedByDefault [get]
 Determines if the attribute is returned by default. More...
 

Member Enumeration Documentation

Enum of modifier flags to use for attributes.

Note that this enum is designed for configuration by exception such that an empty set of flags are the defaults:

  • updateable
  • creatable
  • returned by default
  • readable
  • single-valued
  • optional

Property Documentation

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

Returns the set of flags associated with the attribute.

Returns
the set of flags associated with the attribute
bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.IsCreatable
get

Determines if the attribute is writable on create.

Returns
true if the attribute is writable on create else false.
bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.IsMultiValued
get

Determines if this attribute can handle multiple values.

There is a special case with byte[] since in most instances this denotes a single object.

Returns
true if the attribute is multi-value otherwise false.
bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.IsReadable
get

Determines if the attribute is readable.

Returns
true if the attribute is readable else false.
bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.IsRequired
get

Determines whether this attribute is required for creates.

Returns
true if the attribute is required for an object else false.
bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.IsReturnedByDefault
get

Determines if the attribute is returned by default.

Indicates if an ConnectorAttribute will be returned during SearchApiOp or GetApiOp inside a ConnectorObject by default. The default value is

true

.

Returns
false iff the attribute should not be returned by default.
bool Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.IsUpdateable
get

Determines if the attribute is writable on update.

Returns
true if the attribute is writable on update else false.
string Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.Name
get

The native name of the attribute.

Returns
the native name of the attribute its describing.
string Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.ObjectClassName
get

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

Returns
the name of the object class or null.
Type Org.IdentityConnectors.Framework.Common.Objects.ConnectorAttributeInfo.ValueType
get

The basic type associated with this attribute.

All primitives are supported.

Returns
the native type if uses.

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