|
Sun Adapter for LDAP API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface LDAPSearchControls
LDAP Search Controls interface. This defines methods for setting the search controls.
| Method Summary | |
|---|---|
java.util.HashMap |
getControls()
Method to retrieve the Controls set |
boolean |
getPageControlCriticality()
Method to retrieve the criticality set for the PagedResultsControl |
int |
getPageSize()
Method to retrieve the page size set for the search operation |
java.lang.String |
getSortAttributes()
Method to retrieve the list of attributes based on which the result is to be sorted |
boolean |
getSortControlCriticality()
Method to retrieve the criticality set for the SortControl |
void |
removePagedResultsControl()
Method to remove the PagedResultsControl from the context |
void |
removeSortControl()
Method to remove the SortControl from the context |
void |
reset()
Method to reset the values |
void |
setPageControlCriticality(boolean pageControlCriticality)
Method to set the criticality for the PagedResultsControl. |
void |
setPageSize(int pageSize)
Method to set the page size for the search operation |
void |
setSortAttributes(java.lang.String sortAttributes)
Method to set the list of attributes based on which the result is to be sorted |
void |
setSortControlCriticality(boolean sortControlCriticality)
Method to set the criticality for the SortControl. |
| Method Detail |
|---|
java.lang.String getSortAttributes()
throws LDAPApplicationException
LDAPApplicationException - if there is no connection is available to the LDAP server.
void setSortAttributes(java.lang.String sortAttributes)
throws LDAPApplicationException
a - String that contains the list of attributes delimited by '|' symbol.
LDAPApplicationException - if there is no connection is available to the LDAP server.
boolean getSortControlCriticality()
throws LDAPApplicationException
LDAPApplicationException - if there is no connection is available to the LDAP server.
void setSortControlCriticality(boolean sortControlCriticality)
throws LDAPApplicationException
true - for setting the SortControl as CRITICAL
LDAPApplicationException - if there is no connection is available to the LDAP server.
int getPageSize()
throws LDAPApplicationException
LDAPApplicationException - if there is no connection is available to the LDAP server.
void setPageSize(int pageSize)
throws LDAPApplicationException
an - integer value representing the page size
LDAPApplicationException - if there is no connection is available to the LDAP server.
boolean getPageControlCriticality()
throws LDAPApplicationException
LDAPApplicationException - if there is no connection is available to the LDAP server.
void setPageControlCriticality(boolean pageControlCriticality)
throws LDAPApplicationException
true - for setting the PagedResultsControl as CRITICAL
LDAPApplicationException - if there is no connection is available to the LDAP server.
void removeSortControl()
throws LDAPApplicationException
LDAPApplicationException - if there is no connection is available to the LDAP server.
void removePagedResultsControl()
throws LDAPApplicationException
LDAPApplicationException - if there is no connection is available to the LDAP server.
java.util.HashMap getControls()
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 | ||||||||