PeopleSearchProvider.DirectoryPagingIterator (server-common-api)

java.lang.Object
- com.webmethods.caf.faces.data.dir.PeopleSearchProvider.DirectoryPagingIterator

Enclosing class:: PeopleSearchProvider

public class PeopleSearchProvider.DirectoryPagingIterator
extends Object

Paging iterator from directory service.

Field Summary

Fields
Modifier and Type	Field and Description
`IDirServiceBizPolicy`	`bizPolicy`
`int`	`currentIdxInPage`
`int`	`currentPage`
`IDirPrincipal`	`currentPrincipal`
`IThingID`	`directoryServiceThingID`
`int`	`pageSize`
`int`	`pageStartIdx`
`IPagingCookie`	`pagingCookie`
`IDirPrincipalList`	`principalList`
`ISearchQuery`	`searchQuery`
`protected int`	`searchType`
`String`	`sortExpression`
`String`	`sortOrder`

Constructor Summary

Constructors
Constructor and Description
`DirectoryPagingIterator(IThingID directoryService, ISearchQuery cafSearchQuery)` Construct a paging iterator from the given directory service and search query.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IDirPrincipal`	`getPrincipal()` Get the next principal from the directory service.
`protected void`	`init()` Initialize the biz policy, paging cookie, and directory service.
`void`	`next()` Advance to the next principal in the directory service query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentPage
```
public int currentPage
```

currentIdxInPage
```
public int currentIdxInPage
```

pageStartIdx
```
public int pageStartIdx
```

pageSize
```
public int pageSize
```

sortExpression
```
public String sortExpression
```

sortOrder
```
public String sortOrder
```

directoryServiceThingID

public IThingID directoryServiceThingID

pagingCookie
```
public IPagingCookie pagingCookie
```

principalList
```
public IDirPrincipalList principalList
```

bizPolicy
```
public IDirServiceBizPolicy bizPolicy
```

currentPrincipal
```
public IDirPrincipal currentPrincipal
```

searchType
```
protected int searchType
```

searchQuery
```
public ISearchQuery searchQuery
```

Constructor Detail

DirectoryPagingIterator

public DirectoryPagingIterator(IThingID directoryService,
                               ISearchQuery cafSearchQuery)
                        throws Exception

Construct a paging iterator from the given directory service and search query.

Parameters:: directoryService -; cafSearchQuery -
Throws:: Exception

Method Detail
- init
```
protected void init()
             throws Exception
```
  Initialize the biz policy, paging cookie, and directory service.
  
  Throws:
  
  Exception
- getPrincipal
```
public IDirPrincipal getPrincipal()
```
  Get the next principal from the directory service.
  
  Returns:
  
  The directory principal.
- next
```
public void next()
          throws PortalException
```
  Advance to the next principal in the directory service query.
  
  Throws:
  
  Exception
  
  PortalException

Class PeopleSearchProvider.DirectoryPagingIterator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

currentPage

currentIdxInPage

pageStartIdx

pageSize

sortExpression

sortOrder

directoryServiceThingID

pagingCookie

principalList

bizPolicy

currentPrincipal

searchType

searchQuery

Constructor Detail

DirectoryPagingIterator

Method Detail

init

getPrincipal

next