com.ca.jcs.sdkws
Class SDKWSNamingEnumeration

java.lang.Object
  com.ca.jcs.enumeration.RawNamingEnumeration<SearchResult>
      com.ca.jcs.sdkws.SDKWSNamingEnumeration

All Implemented Interfaces:

Enumeration<SearchResult>, NamingEnumeration<SearchResult>

public class SDKWSNamingEnumeration
extends RawNamingEnumeration<SearchResult>

Basic naming enumeration that caches the full result set. Not to be used for large results.

Author:

erstr01

Field Summary

Fields inherited from class com.ca.jcs.enumeration.RawNamingEnumeration

countLimit, scope, startTime, timeLimit, visitedCount

Constructor Summary

SDKWSNamingEnumeration(String connObjectClass, SDKWSHelper helper, Object[] results)
Constructor that sets the handle id and the resultSize of the result set.

Method Summary

void	close() Closes this enumeration by releasing the handle on the endpoint.
boolean	rawHasMore() Returns true if there are more elements in the childElements iterator.
SearchResult	rawNext() Creates the SearchResult object from the next element in the WS result iterator.

Methods inherited from class com.ca.jcs.enumeration.RawNamingEnumeration

getCountLimit, getNonFatalException, getTimeLimit, getVisitedCount, hasMore, hasMoreElements, next, nextElement, setCountLimit, setNonFatalException, setTimeLimit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SDKWSNamingEnumeration

public SDKWSNamingEnumeration(String connObjectClass,
                              SDKWSHelper helper,
                              Object[] results)
                       throws NamingException

Constructor that sets the handle id and the resultSize of the result set.

Parameters:

connObjectClass - the connector object class name. This will be used as the SearchResult's class name.

helper - the class for making the results.

results - the set of results this class enumerates through.

Throws:

NamingException - if SDKWSMetaConnector is null.

Method Detail

rawHasMore

public boolean rawHasMore()
                   throws NamingException

Returns true if there are more elements in the childElements iterator.

Specified by:

rawHasMore in class RawNamingEnumeration<SearchResult>

Returns:

true if there are more elements in the childElements iterator.

Throws:

NamingException - if childElements is null.

rawNext

public SearchResult rawNext()
                     throws NamingException

Creates the SearchResult object from the next element in the WS result iterator.

Specified by:

rawNext in class RawNamingEnumeration<SearchResult>

Returns:

the next SearchResult object.

Throws:

NamingException - if any errors occur.

close

public void close()
           throws NamingException

Closes this enumeration by releasing the handle on the endpoint.

Throws:

NamingException - if any errors occur.