|
Sun Adapter for LDAP API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PersistentSearch
LDAP Persistent Search interface. This defines methods for Persistent Search Control.
Method Summary | |
---|---|
java.lang.String |
getContextName()
Method to retrieve the context name on which the listener is listening |
java.lang.String |
getEntryName()
Method to retrieve the entry name on which the listener is interested. |
STCEventQueue |
getEventQueue()
Method to retrieve the event queue associated with this search operation |
java.lang.String |
getSearchFilter()
Method to retrieve the search filter that was set for this search operation |
int |
getSearchScope()
Method to retrieve the search scope that was set for this search operation |
void |
reset()
Method to reset the values |
void |
search()
Method that is invoked by the client to initiate a Persistent Search. |
void |
setContextName(java.lang.String contextName)
Method to set the context name on which the listener should listening |
void |
setEntryName(java.lang.String entryName)
Method to set the entry name on which the listener is interested. |
void |
setSearchFilter(java.lang.String searchFilter)
Method to set the search filter for this search operation |
void |
setSearchScope(int searchScope)
Method to set the search scope for this search operation |
Method Detail |
---|
int getSearchScope() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.void setSearchScope(int searchScope) throws LDAPApplicationException
the
- integer value representing the search scope set
LDAPApplicationException
- if there is no connection is available to the LDAP server.java.lang.String getContextName() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.void setContextName(java.lang.String contextName) throws LDAPApplicationException
the
- context name on which the listener should be listening for updates
LDAPApplicationException
- if there is no connection is available to the LDAP server.java.lang.String getEntryName() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.void setEntryName(java.lang.String entryName) throws LDAPApplicationException
the
- entry name on which the listener is interested for updates
LDAPApplicationException
- if there is no connection is available to the LDAP server.java.lang.String getSearchFilter() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.void setSearchFilter(java.lang.String searchFilter) throws LDAPApplicationException
the
- search filter that is to be set for this search operation
LDAPApplicationException
- if there is no connection is available to the LDAP server.void search() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.STCEventQueue getEventQueue() throws LDAPApplicationException
LDAPApplicationException
- if there is no connection is available to the LDAP server.void reset()
|
Sun Adapter for LDAP API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |