Interface IDirectoryObject

public interface IDirectoryObject
{
  // Fields
  public final static int ADSTYPE_BOOLEAN;
  public final static int ADSTYPE_CASE_EXACT_STRING;
  public final static int ADSTYPE_CASE_IGNORE_STRING;
  public final static int ADSTYPE_DN_STRING;
  public final static int ADSTYPE_INTEGER;
  public final static int ADSTYPE_INVALID;
  public final static int ADSTYPE_LARGE_INTEGER;
  public final static int ADSTYPE_NUMERIC_STRING;
  public final static int ADSTYPE_OCTET_STRING;
  public final static int ADSTYPE_PRINTABLE_STRING;
  public final static int ADSTYPE_PROV_SPECIFIC;
  public final static int ADSTYPE_UTC_TIME;

  // Methods
  public void CreateDSObject( String rdn, String className,
        ADsAttrDef[] attributeEntries ) throws IADsException;
  public void DeleteDSObject( String rdn ) throws IADsException;
  public ADsAttrDef[] GetObjectAttributes(
        String[] attributeNames ) throws IADsException;
  public ADsObjectInfo GetObjectInfo() throws IADsException;
  public int SetObjectAttributes(
        ADsAttrDef[] attributeEntries ) throws IADsException;
}

This interface specifies the get and set object attributes, create and delete DS object and get object information interfaces.

Also see Also Active Directory Design Specification Version 2.0

Methods

CreateDSObject 

public void CreateDSObject( String rdn, String className,
        ADsAttrDef[] attributeEntries ) throws IADsException;

This interface creates a DS object for the given relative distinguished name, class name and attribute values for the given attribute names.

Parameter	Description
rdn	The relative distinguished name of an object to be created in the parent container.
className	The class name of an object to be created in the parent container.
attributeEntries	A list of attribute definition entries for which data is set. Each attribute definition contains the name of the attribute to be set and a list of values to be set. All mandatory attributes must be specified.

Exceptions

IADsException This exception gets thrown when the operation fails to be performed.

DeleteDSObject 

public void DeleteDSObject( String rdn ) throws IADsException;

This interface deletes a DS object with the given relative distinguished name.

Parameter	Description
rdn	The relative distinguished name of an object to be deleted in the parent container.

Exceptions

IADsException This exception gets thrown when the operation fails to be performed.

GetObjectAttributes 

public ADsAttrDef[] GetObjectAttributes(
        String[] attributeNames ) throws IADsException;

This interface gets a list attribute values for the given attribute names.

Return Value

Returns A list of ADsAttrDef interfaces. Each interface corresponds to each attribute name in the attributeNames.

Parameter	Description
attributeNames	A list of attribute names.

Exceptions

IADsException This exception gets thrown when the operation fails to be performed.

GetObjectInfo 

public ADsObjectInfo GetObjectInfo() throws IADsException;

This interface retrieves object information.

Return Value

Returns The ADsObjectInfo which contains information for the specified object.

Exceptions

IADsException Thrown when failed to retrieve information.

SetObjectAttributes 

public int SetObjectAttributes(
        ADsAttrDef[] attributeEntries ) throws IADsException;

This interface sets a list of object attributes as specified in the parameters.

Return Value

Returns The number of attributes are modified after the operaton has been performed. A value of zero implies no attributes were modified on the server.

Parameter	Description
attributeEntries	A list of attribute definition entries for which data is set. Each attribute definition contains the name of the attribute to be set and a list of values to be set.

Exceptions

IADsException This exception gets thrown when the operation fails to be performed.

Fields 

ADSTYPE_BOOLEAN

ADSTYPE_CASE_EXACT_STRING

ADSTYPE_CASE_IGNORE_STRING

ADSTYPE_DN_STRING

ADSTYPE_INTEGER

ADSTYPE_INVALID

These constants defines the ADsType of the attribute value.

ADSTYPE_LARGE_INTEGER

ADSTYPE_NUMERIC_STRING

ADSTYPE_OCTET_STRING

ADSTYPE_PRINTABLE_STRING

ADSTYPE_PROV_SPECIFIC

ADSTYPE_UTC_TIME