Novell Doc: NDK: LDAP Libraries for C

6.11 Schema Element Types

This chapter contains values used with the ldap_schema functions. The following list contains the types of schema elements that can be used:

Each section contains a table listing the field names valid in a specific type of a schema element. Addition fields to those defined in these sections may be used.

6.11.1 LDAP_SCHEMA_ATTRIBUTE_TYPE

Table 6-10 Details of the LDAP_SCHEMA_ATTRIBUTE_TYPE Schema Elements

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_SUPERIOR	SUP	Defines the name of the attribute from which this attribute is derived.
LDAP_SCHEMA_EQUALITY	EQUALITY	Defines the Object identifier of the Matching rule used for an equality comparison of this attribute.
LDAP_SCHEMA_SUPERIOR	SUP	Defines the name of the attribute from which this attribute is derived.
LDAP_SCHEMA_ORDERING	ORDERING	Defines the Object identifier of the Matching rule used for an ordering-collating comparison of this attribute.
LDAP_SCHEMA_SUBSTRING	SUBSTR	Defines the Object identifier of the Matching rule used for a substring comparison of this attribute.
LDAP_SCHEMA_SYNTAX_OID	SYNTAX	Defines the Object identifier of the syntax that will be used for this attribute.
LDAP_SCHEMA_SINGLE_VALUED	SINGLE-VALUE	Defines whether or not this attribute is multi-valued or not. This field has no value. If the field name is present the attribute is single valued, otherwise it is multi-valued.
LDAP_SCHEMA_COLLECTIVE	COLLECTIVE	Defines whether or not this attribute is collective, meaning all instances of an object with this attribute will have the same value for this attribute. This field has no value. If the field name is present the attribute is collective, otherwise it is not.
LDAP_SCHEMA_NO_USER_MOD	NO-USER-MODIFICATION	Defines whether or not a user can modify this attribute. This field has no value. If the field name is present the attribute is not modifiable, otherwise it is modifiable.
LDAP_SCHEMA_USAGE	USAGE	Defines whether this attribute is used by a user application, a directory operation, a distributed operation or a per-DSA (Directory Service Agent) operation. The following define strings for the value of this field: LDAP_SCHEMA_USER_APP userApplications If the LDAP_SCHEMA_USAGE field name has this value then the attribute is used by an application independent of the directory server. LDAP_SCHEMA_DIRECTORY_OP directoryOperation If the LDAP_SCHEMA_USAGE field name has this value then the directory uses the defined attribute. LDAP_SCHEMA_DISTRIBUTED_OP distributedOperation If the LDAP_SCHEMA_USAGE field name has this value then the attribute is share between DSAs, Directory Server Agents.
LDAP_SCHEMA_DSA_OP	dSAOperation	If the LDAP_SCHEMA_USAGE field name has this value then the attribute can be unique for each DSA, Directory Server Agent.

6.11.2 LDAP_SCHEMA_OBJECT_CLASS

Table 6-11 Details of the LDAP_SCHEMA_OBJECT_CLASS Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_SUPERIOR	SUP	Defines all attributes that must be defined in an instance of this object.
LDAP_SCHEMA_MUST_ATTRIBUTES	MUST	Defines the Object identifier of the Matching rule used for an equality comparison of this attribute.
LDAP_SCHEMA_MAY_ATTRIBUTES	MAY	Defines all attributes that may be defined in an instance of this object.
LDAP_SCHEMA_TYPE_ABSTRACT	ABSTRACT	Defines that this object is abstract. An abstract object can be derived from but not instantiated. This field name does not have a value. This field name cannot be present if LDAP_SCHEMA_TYPE_STRUCTURAL or LDAP_SCHEMA_TYPE_AUXILIARY is present.
LDAP_SCHEMA_TYPE_STRUCTURAL	STRUCTURAL	Defines that this object is structural. A structural object can be derived from and instantiated. This field name does not have a value. This field name cannot be present if LDAP_SCHEMA_TYPE_ABSTRACT or LDAP_SCHEMA_TYPE_AUXILIARY is present.
LDAP_SCHEMA_TYPE_AUXILIARY	AUXILIARY	Defines that this object is auxiliary. An auxiliary object can be associated with any instantiated object. This field name does not have a value. This field name cannot be present if LDAP_SCHEMA_TYPE_ABSTRACT or LDAP_SCHEMA_TYPE_STRUCTURAL is present.

6.11.3 LDAP_SCHEMA_MATCHING_RULE

Table 6-12 Details of the LDAP_SCHEMA_MATCHING_RULE Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_SYNTAX_OID	SYNTAX	Defines the syntax of the Matching Rule. Only one value can exist for this field name.

6.11.4 LDAP_SCHEMA_MATCHING_RULE_USE

Table 6-13 Details of the LDAP_SCHEMA_MATCHING_RULE Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_APPLIES	APPLIES	Defines the attributes that the Matching Rule applies to. This field is required for Matching Rule Use definitions.

6.11.5 LDAP_SCHEMA_NAME_FORM

Table 6-14 Details of the LDAP_SCHEMA_NAME_FORM Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_NAME_FORM_OBJECTS	OC	Defines the Object Classes to which this Name Form applies. This field is required for name forms..
LDAP_SCHEMA_MUST_ATTRIBUTES	MUST	Defines the mandatory attributes to which this name form applies. This field is required for name forms.
LDAP_SCHEMA_MAY_ATTRIBUTES	MAY	Defines the optional attributes to which this name form applies.

6.11.6 LDAP_SCHEMA_SYNTAX

Table 6-15 Details of the LDAP_SCHEMA_SYNTAX Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.

6.11.7 LDAP_SCHEMA_DIT_CONTENT_RULE

Table 6-16 Details of the LDAP_SCHEMA_DIT_CONTENT_RULE Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_OID	OID	Object identifier of the schema element. This field has only one value.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_AUX_CLASSES	AUX	Defines the auxiliary classes that can be applied to a structural object Class.
LDAP_SCHEMA_MUST_ATTRIBUTES	MUST	Defines the mandatory attributes to which this name form applies. This field is required for name forms.
LDAP_SCHEMA_MAY_ATTRIBUTES	MAY	Defines the optional attributes to which this name form applies.
LDAP_SCHEMA_NOT_ATTRIBUTES	NOT	Defines the attributes that a structural object class cannot obtain from an auxiliary class.

6.11.8 LDAP_SCHEMA_DIT_STRUCTURE_RULE

Table 6-17 Details of the LDAP_SCHEMA_DIT_STRUCTURE_RULE Schema Element

Flag Name	C Value	Description
LDAP_SCHEMA_RULE_ID	RULEID	Defines the integer identifier for this rule.
LDAP_SCHEMA_DESCRIPTION	DESC	This field is a string definition of the schema element. This field has only one value.
LDAP_SCHEMA_NAMES	NAME	Defines all names used to identify the schema element.
LDAP_SCHEMA_OBSOLETE	OBSOLETE	Defines whether this schema definition is still in use. This field has no value. If the field name is present, the definition is obsolete; otherwise the definition is still valid.
LDAP_SCHEMA_NAME_FORM_OID	FORM	Defines the Name Form that applies to this structure rule.
LDAP_SCHEMA_SUPERIOR	SUP	Defines all structure rules that this rule derives from.