com.adobe.idp.um.spi.directoryservices
Class DSPrincipalCollection

java.lang.Object
  com.adobe.idp.um.spi.directoryservices.DSPrincipalCollection

All Implemented Interfaces:

java.io.Serializable

public class DSPrincipalCollection
extends java.lang.Object
implements java.io.Serializable

The DSPrincipalCollection class provides a container for storing sets of user records. User providers use the container for returning user records and state information to User Management. User Management can retrieve the user records from the container.

See Also:

Serialized Form

Constructor Summary

DSPrincipalCollection()
Creates a new DSPrincipalCollection object.

Method Summary

void	addDSPrincipalRecord(DSPrincipalRecord record) Adds a user record to this object.
java.util.Set	getPrincipalRecords() Retrieves the user records that this object contains.
java.lang.Object	getState() Retrieves the state information that the directory service provider specified.
void	setState(java.lang.Object object) Sets the state information to indicate that all principal records have been retrieved or to provide information that user providers require for the subsequent call.
java.lang.String	toString() Retrieves the java.lang.String representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DSPrincipalCollection

public DSPrincipalCollection()

Creates a new DSPrincipalCollection object.

Method Detail

toString

public java.lang.String toString()

Retrieves the java.lang.String representation of this object.

Overrides:

toString in class java.lang.Object

getPrincipalRecords

public java.util.Set getPrincipalRecords()

Retrieves the user records that this object contains.

Returns:

A java.util.Set that contains the DSPrincipalRecord objects representing the retrieved user records.

addDSPrincipalRecord

public void addDSPrincipalRecord(DSPrincipalRecord record)

Adds a user record to this object.

Parameters:

record - A DSPrincipalRecord object that contains the user record to be added.

getState

public java.lang.Object getState()

Retrieves the state information that the directory service provider specified. State information is useful for persisting information that the directory service provider requires for subsequent calls, and for indicating whether subsequent calls are necessary.

The information that adequately describes the state depends on the directory service provider.

Returns:

An Object instance that contains the state information.

See Also:

DirectoryPrincipalProvider

setState

public void setState(java.lang.Object object)

Sets the state information to indicate that all principal records have been retrieved or to provide information that user providers require for the subsequent call.

Parameters:

object - An Object instance that contains null if all records are retrieved, or contains information for the subsequent call.