oracle.collabsuite.addressbook
Class SchemaObject

java.lang.Object
  |
  +--oracle.collabsuite.addressbook.SchemaObject

public class SchemaObject

extends java.lang.Object

This class contains information about schema representation of an address book entry in LDAP, ie. the ldap schema information for a list object. From the schema object, various information like the list of mandatory and optional attributes for the entry can be obtained. It also contains information about all these attributes, for example the syntax, multiplicity of the attributes etc.

Method Summary

int	getAttributeLength(java.lang.String attr) Returns the maximum length defined in the LDAP schema for this attribute.
java.lang.String	getAttributeSyntax(java.lang.String attr) Returns the LDAP syntax of the attribute.
java.lang.String	getAttributeType(java.lang.String attr) Returns the syntax type of the attribute.
java.lang.String[]	getMandatoryAttributes() Returns the names of mandatory attributes
java.lang.String[]	getOptionalAttributes() Returns the names of optional attributes
boolean	ifBinary(java.lang.String attr) Returns if the given attribute definition is binary.
boolean	ifSingleValued(java.lang.String attr) Returns the multiplicity of the given attribute.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMandatoryAttributes

public java.lang.String[] getMandatoryAttributes()

Returns the names of mandatory attributes

Parameters:

void -

Returns:

String[] containing the mandatory attribute names

getOptionalAttributes

public java.lang.String[] getOptionalAttributes()
                                         throws AddressBookException

Returns the names of optional attributes

Parameters:

void -

Returns:

String[] containing the optional attribute names

getAttributeSyntax

public java.lang.String getAttributeSyntax(java.lang.String attr)
                                    throws AddressBookException

Returns the LDAP syntax of the attribute.

Parameters:

attr - Name of the attribute

Returns:

String, the attribute type

getAttributeType

public java.lang.String getAttributeType(java.lang.String attr)
                                  throws AddressBookException

Returns the syntax type of the attribute.

Parameters:

attr - Name of the attribute

Returns:

String, the attribute type (for example, String or int or binary)

getAttributeLength

public int getAttributeLength(java.lang.String attr)
                       throws AddressBookException

Returns the maximum length defined in the LDAP schema for this attribute. Since max length for the attributes is optional in LDAP, it will return -1 if no value is defined for max length.

Parameters:

attr - Name of the attribute

Returns:

int the attribute length, -1 if not defined in LDAP.

ifSingleValued

public boolean ifSingleValued(java.lang.String attr)
                       throws AddressBookException

Returns the multiplicity of the given attribute.

Parameters:

attr - Name of the attribute

Returns:

boolean true means attribute is single valued, else is multivalued

ifBinary

public boolean ifBinary(java.lang.String attr)
                 throws AddressBookException

Returns if the given attribute definition is binary.

Parameters:

attr - Name of the attribute

Returns:

boolean true means attribute is binary