com.sap.portal.directory

Interface IExtendedList

public interface IExtendedList

Interface that provides operations for sorted folders.

Method Summary

NamingEnumeration	list(Name name, int fromIndex, int numberOfEntries) Returns only a defined sublist containing numberOfEntries objects starting with index fromIndex.
NamingEnumeration	list(String name, int fromIndex, int numberOfEntries)
NamingEnumeration	listBindings(Name name, int fromIndex, int numberOfEntries) Returns only a defined sublist containing numberOfEntries objects starting with index fromIndex.
NamingEnumeration	listBindings(String name, int fromIndex, int numberOfEntries)
int	listSize(Name name) Returns the number of objects bound to the context.
int	listSize(String name)

Method Detail

listSize

int listSize(Name name)
             throws NamingException

Returns the number of objects bound to the context. Filters and permissions are NOT taken into account. This means that the number of objects returned by list() and listBindings() could be lower.

Parameters:

name - The name of context (given as Name)

Throws:

NamingException

listSize

int listSize(String name)
             throws NamingException

Parameters:

name - The name of context (given as String)

Throws:

NamingException

See Also:

listSize(Name)

list

NamingEnumeration list(Name name,
                       int fromIndex,
                       int numberOfEntries)
                       throws NamingException

Returns only a defined sublist containing numberOfEntries objects starting with index fromIndex. If one or more objects have to be skipped, e.g. because of missing permissions, an EnumerationLimitException is thrown on the last possible call of NamingEnumeration.hasMore() or NamingEnumeration.next(). The EnumerationLimitException is also thrown if the number of entries that was specified is exceeded. The EnumerationLimitException contains the index of the last entry that was read from the PCD.

Parameters:

name - The name of context (given as Name

fromIndex - Start index

numberOfEntries - number of entries to be returned

Throws:

NamingException

See Also:

EnumerationLimitException

list

NamingEnumeration list(String name,
                       int fromIndex,
                       int numberOfEntries)
                       throws NamingException

Parameters:

name - The name of context (given as String

fromIndex - Start index

numberOfEntries - number of entries to be returned

Throws:

NamingException

See Also:

list(Name name, int fromIndex, int toIndex).

listBindings

NamingEnumeration listBindings(Name name,
                               int fromIndex,
                               int numberOfEntries)
                               throws NamingException

Returns only a defined sublist containing numberOfEntries objects starting with index fromIndex. If one or more objects have to be skipped because of filters or missing permissions, an EnumerationLimitException is thrown on the last possible call of NamingEnumeration.hasMore() or NamingEnumeration.next(). The EnumerationLimitException is also thrown if the number of entries that was specified is exceeded. The EnumerationLimitException contains the index of the last entry that was read from the PCD.

Parameters:

name - The name of context (given as Name

fromIndex - Start index

numberOfEntries - number of entries to be returned

Throws:

NamingException

See Also:

EnumerationLimitException

listBindings

NamingEnumeration listBindings(String name,
                               int fromIndex,
                               int numberOfEntries)
                               throws NamingException

Parameters:

name - The name of context (given as String

fromIndex - Start index

numberOfEntries - number of entries to be returned

Throws:

NamingException

See Also:

listBindings(Name name, int fromIndex, int toIndex).

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/basis/jndisupportdeprecated	api	EP-PIN-PRT