Interface IADs

public interface IADs
{
  // Fields
  public static final int ADS_PROPERTY_ADD;
  public static final int ADS_PROPERTY_CLEAR;
  public static final int ADS_PROPERTY_DELETE_VALUE;
  public static final int ADS_PROPERTY_UPDATE;

  // Methods
  public Object Get(String Name) throws IADsException;
  public String get_ADsPath();
  public String get_Class();
  public String get_GUID() throws IADsException;
  public String get_Name();
  public String get_Parent() throws IADsException;
  public String get_Schema() throws IADsException;
  public Vector GetEx(String Name) throws IADsException;
  public void GetInfo() throws IADsException;
  public void GetInfo(String Hints[]) throws IADsException;
  public void Put(String Name, Object Prop) throws IADsException;
  public void PutEx(int ControlCode, String Name,
        Vector Prop) throws IADsException;
  public void SetInfo() throws IADsException;
}

This class provides basic functionality that is required by all Active Directory objects.

Also see Also Active Directory Design Specification Version 1.0

Methods

Get 

public Object Get(String Name) throws IADsException;

Retrieves the value for a named property.

Return Value

Returns property value

Parameter	Description
Name	property intereted

Exceptions

IADsException failed to get

get_ADsPath 

public String get_ADsPath();

Gets the ADsPath string of the object that uniquely identifies the object in a heterogeneous environment.

Return Value

Returns ADsPath string of this object

get_Class 

public String get_Class();

Gets the name of the schema class of this object.

Return Value

Returns schema class

get_GUID 

public String get_GUID() throws IADsException;

Gets the unique identifier for objects of this schema class. Each Active Directory object type is uniquely identified by a GUID. This GUID is the Active Directory abstraction of the globally unique identifier for the schema class, analogous to an ASN.1 OID.

Return Value

Returns unique identifier

get_Name 

public String get_Name();

Gets the relative name of the object as named within the underlying namespace.

Return Value

Returns name

get_Parent 

public String get_Parent() throws IADsException;

Gets the ADsPath string of the parent container.

Return Value

Returns ADsPath string of the parent of this object

get_Schema 

public String get_Schema() throws IADsException;

Gets the ADsPath of the schema class of this object.

Return Value

Returns schema class name

GetEx 

public Vector GetEx(String Name) throws IADsException;

Retrieves the values for a named single or multi-valued property.

Return Value

Returns property value

Parameter	Description
Name	property intereted

Exceptions

IADsException failed to get

GetInfo 

public void GetInfo() throws IADsException;

Reloads the object with the property values that exist within the directory service.

Parameter	Description
Hints	properties (list of Strings) should be loaded, so that provider can attempt to optimize network access.

Exceptions

IADsException failed to refresh

GetInfo 

public void GetInfo(String Hints[]) throws IADsException;

Put 

public void Put(String Name, Object Prop) throws IADsException;

Sets the value for a named property.

Parameter	Description
Name	property interested
Prop	property value

Exceptions

IADsException failed to put

PutEx 

public void PutEx(int ControlCode, String Name,
        Vector Prop) throws IADsException;

Sets the values for a named single or multi-valued property.

Parameter	Description
ControlCode	Indicates either clear or update operation being performed
Name	property interested
Prop	property value

Exceptions

IADsException failed to put

SetInfo 

public void SetInfo() throws IADsException;

Commits changes on the object. If properties have been changed on an object, the SetInfo method will cauase the properties to be changed within the directory service.

Exceptions

IADsException failed to commit

Fields 

ADS_PROPERTY_ADD

Adds a value to the values associated with a multi-valued property.

ADS_PROPERTY_CLEAR

Clears the value of the property

ADS_PROPERTY_DELETE_VALUE

Deletes a value of the values associated with a multi-valued property.

ADS_PROPERTY_UPDATE

Updates the value of the property to the supplied value