com.ibm.itim.remoteservices.provider
Class SearchResult

java.lang.Object
  com.ibm.itim.remoteservices.provider.SearchResult

All Implemented Interfaces:

java.io.Serializable

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

Encapsulates an entry returned from a search on a remote resource. A search result corresponds to a single entity within TIM. For example, when communicating with a database a SearchResult would correspond to a row of the database, which may then be imported to TIM as an account or a person.

TIM will determine the type of entry to add based the object classes. If the object classes do not include the type expected for this service profile, then the entry will be interpreted as supporting data. For example, when reconciling accounts, each account entry must include the object class for that service and other entries, such as group data, will be added as supporting data.

Only attributes that are meaningful to the user should be added here. Users of this class should not add attributes that are used only for internal management by TIM at this point. For example, attributes like erglobalid. These will be added by the TIM dataservices framework elsewhere.

See Also:

Serialized Form

Constructor Summary

SearchResult(java.lang.String dn, java.util.Collection<?> objectClasses, AttributeValues attributeValues)
Creates new SearchResult

SearchResult(java.lang.String dn, java.lang.String objectClass, AttributeValues attributeValues)
Creates new SearchResult

Method Summary

AttributeValues	getAttributeValues() Gets the model attributes for this search entry
java.lang.String	getDN() Gets the distinguished name for this search result
java.lang.String	getObjectClass() Gets the first object class or null if there isn't one
java.util.Collection<java.lang.String>	getObjectClasses() Gets the object classes for this search entry
long	getResultNumber() used for reconciliation logging
void	setResultNumber(long resultNumber) used for reconciliation logging
java.lang.String	toString() Overrides the method from java.lang.Object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResult

public SearchResult(java.lang.String dn,
                    java.util.Collection<?> objectClasses,
                    AttributeValues attributeValues)

Creates new SearchResult

Parameters:

dn - The distinguished name for this entry. dn cannot be null or an empty string.

objectClasses - One or more object classes for the entry.

attributeValues - The attributes of the search entry. attributeValues cannot be null or empty.

SearchResult

public SearchResult(java.lang.String dn,
                    java.lang.String objectClass,
                    AttributeValues attributeValues)

Creates new SearchResult

Parameters:

dn - The distinguished name for this entry. dn cannot be null or an empty string.

objectClass - Single object class for the entry. objectClass cannot be null or an empty string.

attributeValues - The attributes of the search entry. attributeValues cannot be null or empty.

Method Detail

setResultNumber

public void setResultNumber(long resultNumber)

used for reconciliation logging

getResultNumber

public long getResultNumber()

used for reconciliation logging

getDN

public java.lang.String getDN()

Gets the distinguished name for this search result

Returns:

The distinguished name for this search result and not null.

getAttributeValues

public AttributeValues getAttributeValues()

Gets the model attributes for this search entry

Returns:

model attributes which will not be null.

getObjectClasses

public java.util.Collection<java.lang.String> getObjectClasses()

Gets the object classes for this search entry

Returns:

object classes which will not be null.

getObjectClass

public java.lang.String getObjectClass()

Gets the first object class or null if there isn't one

Returns:

The first object class

toString

public java.lang.String toString()

Overrides the method from java.lang.Object.

Overrides:

toString in class java.lang.Object

Returns:

The name of the class, the dn, and the object classes.