Interface IADsContainer

public interface IADsContainer
{
  // Methods
  public IADs CopyHere(String SourceObject, String NewName)
        throws IADsException;
  public IADs Create(String Class, String RelativeName)
        throws IADsException;
  public void Delete(String Class, String RelativeName)
        throws IADsException;
  public Enumeration get__NewEnum() throws IADsException;
  public Long get_Count() throws IADsException;
  public String[] get_Filter() throws IADsException;
  public String[] get_Hints() throws IADsException;
  public IADs GetObject(String Class, String RelativeName)
        throws IADsException;
  public IADs MoveHere(String SourceObject, String NewName)
        throws IADsException;
  public void put_Filter(String Filter[]) throws IADsException;
  public void put_Hints(String Hints[]) throws IADsException;
}

This interface specifies the basic functionality required by all directory service container objects.

Also see Also Active Directory Design Specification Version 1.0

Methods

CopyHere 

public IADs CopyHere(String SourceObject, String NewName)
        throws IADsException;

Creates a new object in this container identical to the specified object and returns a pointer to the new object. The destination container must be in the same namespace as the source. Copying objects across namespaces is not permitted. NewName is an optional parameter that, if present, contains the name inside the container. IADs::SetInfo must be called to commit the changes.

Return Value

Returns copied object

Parameter	Description
SourceObject	source object
NewName	new name

Exceptions

IADsException failed to get copy

Create 

public IADs Create(String Class, String RelativeName)
        throws IADsException;

Creates an object of the class specified by Class, of name RelativeName, and returns the newly created object. The object is not actually created within the directory service until IADs::SetInfo method is executed on the newly created object.

Return Value

Returns newly created IADs object

Parameter	Description
Class	class name
RelativeName	relative name

Exceptions

IADsException failed to get create

Delete 

public void Delete(String Class, String RelativeName)
        throws IADsException;

Deletes the object identified by the provided class and relative name.

Parameter	Description
Class	class name
RelativeName	relative name

Exceptions

IADsException failed to get delete

get__NewEnum 

public Enumeration get__NewEnum() throws IADsException;

Gets an enumerator dependent object. If there is a filter set, only the classes named in the filter will be enumerated.

Return Value

Returns enumeration

Exceptions

IADsException, when the enumeration cannot be created.

get_Count 

public Long get_Count() throws IADsException;

Gets the number of Active Directory objects within the container. If there is a filter set, only a count of the classes named in the filter will be returned.

Return Value

Returns number of objects within the container

Exceptions

IADsException, when the count cannot be determined or there is an error determining the count.

get_Filter 

public String[] get_Filter() throws IADsException;

Gets the filter on the object classes that will be returned in a given enumeration. The client can also give hints to the provider about which properties of the objects it will use after the enumeration. If Filter is not set or is set to empty, then all objects of all classes will be returned by the enumerator. Each array entry should be of the following format: ::= | "Provider Specific String" is String value that represents a class.

Return Value

Returns filter

Exceptions

IADsException Thrown when failed to retrieve filter.

get_Hints 

public String[] get_Hints() throws IADsException;

Gets the hint parameters that allows the client to indicate which properties should be loaded, so the provider can attempt to optmize network access. If no hints are specified,Hints is marked as empty. Each array entry should be of the following format: ::= is String value that represents a property found in the schema.

Return Value

Returns hints

Exceptions

IADsException Thrown when failed to retrieve hints.

GetObject 

public IADs GetObject(String Class, String RelativeName)
        throws IADsException;

Returns the IADs interface of the item in the container identified by the object's class and relative name (this is the value of the object's IADs::Name property). If the class name is not provided the provider will return the first item found with the specified name in the current container.

Return Value

Returns IADs object

Parameter	Description
Class	class name
RelativeName	relative name

Exceptions

IADsException failed to get object

MoveHere 

public IADs MoveHere(String SourceObject, String NewName)
        throws IADsException;

Moves the specified object to this container and returns a pointr to the newobject. The destination container must be in the same namespace as the source. Moving obejcts across namespaces i not permitted. NewName is an optional parameter that, if present, contains the name inside the container.

Return Value

Returns moved object

Parameter	Description
SourceObject	source object
NewName	new name

Exceptions

IADsException failed to get move

put_Filter 

public void put_Filter(String Filter[]) throws IADsException;

Sets the filter on the object classes that will be returned in a given enumeration. The client can also give hints to the provider about which properties of the objects it will use after the enumeration. If Filter is not set or is set to empty, then all objects of all classes will be returned by the enumerator. Each array entry should be of the following format: ::= | "Provider Specific String" is String value that represents a class.

Parameter	Description
Filter	filter

Exceptions

IADsException Thrown when failed to put filter.

put_Hints 

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

Sets the hint parameters that allows the client to indicate which properties should be loaded, so the provider can attempt to optmize network access. If no hints are specified,Hints is marked as empty. Each array entry should be of the following format: ::= is String value that represents a property found in the schema.

Parameter	Description
Hints	hints

Exceptions

IADsException Thrown when failed to put hints.