|
Novell exteNd Director 5.0 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines a generic LDAP query. It's used to construct queries that return search results.
Method Summary | |
void |
addOrderBy(String attribName,
boolean asc)
Designate an attribute for ordering in a JNDI query. |
void |
addSelect(String attribName)
Designate an attribute for selection in a JNDI query. |
void |
clear()
Clear all selections related to this query |
Object[] |
getArguments()
Get the query arguments, if there are any. |
String |
getContextName()
Get the contextName value for the query. |
long |
getCountLimit()
Get the CountLimit attribute for the query. |
DirContext |
getDirContext()
Get the DirContext for the query. |
String[] |
getReturningAttributes()
Get the array of attributes to be returned by this query. |
SearchControls |
getSearchControls()
Get the search controls for this query. |
int |
getSearchScope()
Get the scope attribute for the query. |
int |
getTimeLimit()
Get the TimeLimit attribute for the query. |
EbiQueryExpression |
getWhere()
Get a query's search filter. |
void |
setArguments(Object[] args)
Specify an array or arguments for an argument style query. |
void |
setContextName(String contextName)
Designate the context name for a JNDI query. |
void |
setCountLimit(long limit)
Specify a maximum number of entries to be returned by the query. |
void |
setDirContext(DirContext dirContext)
Designate the DirContext for a JNDI query. |
void |
setSearchScope(int scope)
Specify the scope for the query. |
void |
setTimeLimit(int msecs)
Specify a timeout interval to be used with the query. |
void |
setWhere(EbiQueryExpression expr)
Designate a filter expression for a JNDI query. |
EbiQueryExpression |
whereAttributeBetween(String attribName,
Object first,
Object last,
boolean not)
Specify the search condition for selecting from a range of attribute values |
EbiQueryExpression |
whereAttributeIn(String attribName,
Object[] values,
boolean not)
Specify the search condition for selecting from a set of attribute values |
EbiQueryExpression |
whereAttributeOp(String attribName,
Object value,
int op,
boolean not)
Specify the search condition for an attribute |
EbiQueryExpression |
whereAttributeOpWithArg(String attribName,
int op,
boolean not)
Specify the search condition for an attribute. |
EbiQueryExpression |
whereAttributeOpWithAttrArg(int op,
boolean not)
Specify the search condition for an attribute. |
Methods implemented from interface com.sssw.fw.api.EbiQuery |
allSelected,
deselectAll,
getOrderBys,
getQueryString,
getSelects,
removeOrderBys,
selectAll |
Method Detail |
public void setContextName(String contextName)
contextName
- the name of the context for the query (e.g., o=Administrator )public String getContextName()
public void setDirContext(DirContext dirContext)
dirContext
- the context against which the query will be executed.public DirContext getDirContext()
public void addSelect(String attribName)
attribName
- an attribute name to be selected in the query.public void addOrderBy(String attribName, boolean asc)
attribName
- an attribute name to be used for ordering in a query.asc
- a boolean value indicating whether to use ascending order.public void setWhere(EbiQueryExpression expr)
expr
- an EbiQueryExpression containing the search filter.public EbiQueryExpression whereAttributeOp(String attribName, Object value, int op, boolean not)
attribName
- the name of the attribute being evaluatedvalue
- an Object value for the condition, valid objects are defined
in EboLdapSearchHelperop
- an operator, valid operators are defined in EboLdapSearchHelpernot
- whether to negate the conditionpublic EbiQueryExpression whereAttributeOpWithArg(String attribName, int op, boolean not)
attribName
- the name of the attribute being evaluatedop
- an operator, valid operators are defined in EboLdapSearchHelpernot
- whether to negate the conditionpublic EbiQueryExpression whereAttributeOpWithAttrArg(int op, boolean not)
op
- an operator, valid operators are defined in EboLdapSearchHelpernot
- whether to negate the conditionpublic EbiQueryExpression whereAttributeIn(String attribName, Object[] values, boolean not)
attribName
- the name of the attribute being evaluatedvalues
- Object values for the selectable setnot
- whether to negate the conditionpublic EbiQueryExpression whereAttributeBetween(String attribName, Object first, Object last, boolean not)
attribName
- the name of the attribute being evaluatedfirst
- the start Object value for the rangelast
- the end Object value for the rangenot
- whether to negate the conditionpublic EbiQueryExpression getWhere()
public void clear()
public void setCountLimit(long limit)
limit
- is a long containing the maximum entries to be returned.public long getCountLimit()
public void setSearchScope(int scope)
scope
- is an integer identifying the scope for the query.public int getSearchScope()
public void setTimeLimit(int msecs)
msecs
- is an int representing the timeout in milliseconds.public int getTimeLimit()
public String[] getReturningAttributes()
public SearchControls getSearchControls()
public void setArguments(Object[] args)
args
- the array of argument valuespublic Object[] getArguments()
|
Novell exteNd Director 5.0 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |