|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ldap.util.PropertySetCollection
public class PropertySetCollection
This class represents a collection of PropertySets. In other words, it represents a set of search result entries from a given search.
Constructor Summary | |
---|---|
protected |
PropertySetCollection() |
|
PropertySetCollection(int initSize) |
protected |
PropertySetCollection(java.lang.String base, java.lang.Object inResultSet) |
protected |
PropertySetCollection(java.lang.String base, java.lang.Object inResultSet, boolean convert) |
Method Summary | |
---|---|
void |
addPropertySet(PropertySet propSet) |
void |
convert() |
java.lang.String[] |
getDns() Returns an array of String containing the name of all the property sets - the DN's of all the search entries in this search result. |
PropertySet |
getPropertySet(int i) Returns the i-th property set of this property set collection - the i-th search entry of this search result. |
PropertySet |
getPropertySet(java.lang.String dn) Returns the property set identified by dn - the search entry with the given DN |
java.lang.String[] |
getPropertyValues(java.lang.String propName) getPropertyValues This function provides a short cut for caller to retrieve string values of a specific property from the PropertySetCollection. |
java.lang.String |
getUniquePropertyValue(java.lang.String propName) Provides a short cut for caller to retrieve value of a specific property from the PropertySetCollection . |
boolean |
isEmpty() Returns true if the property set collection does not contain any property set; false otherwise |
boolean |
isSizeLimitExceeded() Returns true if sizelimit is exceeded for during the query from which this PropertySetCollection is generated |
int |
size() Returns the size of the property set collection - the number of search entries in the search result |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected PropertySetCollection()
public PropertySetCollection(int initSize)
protected PropertySetCollection(java.lang.String base, java.lang.Object inResultSet)
protected PropertySetCollection(java.lang.String base, java.lang.Object inResultSet, boolean convert)
Method Detail |
---|
public final boolean isEmpty()
public final int size()
public final boolean isSizeLimitExceeded()
public void addPropertySet(PropertySet propSet)
public final java.lang.String[] getDns()
public final PropertySet getPropertySet(int i)
i
- the index of the property set to be retrievedpublic final PropertySet getPropertySet(java.lang.String dn)
dn
- the DN of the property set to be retrievedpublic void convert()
public java.lang.String[] getPropertyValues(java.lang.String propName) throws UtilException
propName
- - Name of the attribute/propertyUtilException
- - when the PropertySetCollection is empty - when the specified property does not have value. CastException - when the property has non-string valuepublic java.lang.String getUniquePropertyValue(java.lang.String propName) throws UtilException
Provides a short cut for caller to retrieve value of a specific property from the PropertySetCollection
. The property must be unique among the collection of PropertySet
(s). And it must be a single value attribute/property.
propName
- - Name of the attribute/property.UtilException
- - when the PropertySetCollection is empty - when the specified property does not have value. - when there is more than 1 matching PropertySet. - when the specified property have more than 1 value.
|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |