Interface ListDirectoryResultSet
- 
- All Superinterfaces:
- ListDirectoryResultSetComp,- Serializable
 
 public interface ListDirectoryResultSet extends Serializable, ListDirectoryResultSetComp A List Directory result. This has a methodgetListDirectoryResults()to get an RWIterable over the matching items in the directory and a methodgetWarningMessage()to retrieve a possible warning message.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description RWIterable<ListDirectoryResult>getListDirectoryResults()Get anRWIterableover a collection ofListDirectoryResultitems, the collection will be ordered by Name.StringgetWarningMessage()Get any warning message generated by the server whilst retrieving these results.
 
- 
- 
- 
Method Detail- 
getListDirectoryResultsRWIterable<ListDirectoryResult> getListDirectoryResults() throws com.redwood.scheduler.api.exception.ListDirectoryTransientException, com.redwood.scheduler.api.exception.ListDirectoryException Get anRWIterableover a collection ofListDirectoryResultitems, the collection will be ordered by Name. If the collection is empty, an empty RWIterable will be returned, that is, this method will never returnnull.- Specified by:
- getListDirectoryResultsin interface- ListDirectoryResultSetComp
- Returns:
- An RWIterableover a collection ofListDirectoryResultitems, the collection will be ordered by Name.
- Throws:
- com.redwood.scheduler.api.exception.ListDirectoryException- permanent error, cannot be recovered.
- com.redwood.scheduler.api.exception.ListDirectoryTransientException- transient error, retry may work.
 
 - 
getWarningMessageString getWarningMessage() Get any warning message generated by the server whilst retrieving these results.- Returns:
- Warning message or null if there is none.
 
 
- 
 
-