|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.nds.dirxml.driver.xds.ElementImpl
com.novell.nds.dirxml.driver.xds.XDSQueryElement
com.novell.nds.dirxml.driver.xds.XDSQueryExElement
A <query-ex>
element.
XDSCommandDocument
,
XDSQueryDocument
Field Summary |
Fields inherited from class com.novell.nds.dirxml.driver.xds.XDSQueryElement |
UNLIMITED_RESULTS |
Method Summary | |
XDSQueryTokenElement |
appendQueryTokenElement(String someToken)
Appends an empty child <query-token; element to this
element. |
List |
childElements()
Returns this element's child elements. |
boolean |
containsQueryToken()
Does this element contain a child <query-token>
element?
|
XDSQueryTokenElement |
extractQueryToken()
Returns this element's child <query-token> element. |
String |
extractQueryTokenText()
Returns the concatenated child text nodes from this element's child <query-token> element. |
boolean |
getCancel()
Gets the value of this element's max-result-count
attribute. |
int |
getMaxResultCount()
Gets the value of this element's max-result-count
attribute. |
boolean |
hasLimitedResults()
Is this query's result set size limited? |
boolean |
hasUnlimitedResults()
Is this query's result set size unlimited? |
boolean |
isCancelled()
Has this query been cancelled? |
boolean |
isExtended()
Does this query require special result set handling? |
boolean |
isIdentity()
Is this query an identity query? |
boolean |
isInitialQuery()
Is this query the first query in a sequence? |
boolean |
isSubsequentQuery()
Is this query the nth query in a sequence? |
void |
setCancel(boolean cancel)
Sets this element's cancel attribute to
cancel . |
void |
setMaxResultCount(int someCount)
Sets this element's max-result-count attribute to
someCount . |
Methods inherited from class com.novell.nds.dirxml.driver.xds.ElementImpl |
attributeValueGet, attributeValueGet, attributeValueSet, documentImpl, domDocument, domElement, localName, namespaceName, position, tagName |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.novell.nds.dirxml.driver.xds.CommandElement |
getClassName, getEventID, getQualifiedSrcDN, getSrcDN, getSrcEntryID, setEventID |
Methods inherited from interface com.novell.nds.dirxml.driver.xds.XDSElement |
attributeValueGet, attributeValueGet, attributeValueSet, domDocument, domElement, localName, namespaceName, position, tagName |
Methods inherited from interface com.novell.nds.dirxml.driver.xds.AssociationElementParent |
appendAssociationElement, extractAssociationElement, extractAssociationText |
Method Detail |
public boolean isIdentity()
An identity query is used to identify a driver to the DirXML engine. A
query is considered an identity query if either it has an
event-id
attribute value of
"query-driver-ident"
or it contains a
<search-class>
element with a
class-name
attribute value of
"__driver_identification_class__"
.
isIdentity
in class XDSQueryElement
true
:false
:public int getMaxResultCount()
max-result-count
attribute. This value specifies the upper limit of the result set for
the all queries in the sequence. Values for this attribute in
subsequent queries should be ignored.
getMaxResultCount
in class XDSQueryElement
Integer.MAX_VALUE
public boolean getCancel()
max-result-count
attribute. This value specifies the upper limit of the result set for
the all queries in the sequence. Values for this attribute in
subsequent queries should be ignored.
public boolean isCancelled()
isCancelled
in class XDSQueryElement
true
if it has; false
if it hasn'tpublic boolean containsQueryToken()
<query-token>
element?
containsQueryToken
in class XDSQueryElement
true
if it does; false
otherwisepublic XDSQueryTokenElement extractQueryToken()
<query-token>
element.
extractQueryToken
in class XDSQueryElement
null
public String extractQueryTokenText()
<query-token>
element.
extractQueryTokenText
in class XDSQueryElement
null
public boolean hasUnlimitedResults()
hasUnlimitedResults
in class XDSQueryElement
true
if unlimited; false
if limitedpublic boolean hasLimitedResults()
hasLimitedResults
in class XDSQueryElement
true
if limited; false
if unlimitedpublic boolean isInitialQuery()
isInitialQuery
in class XDSQueryElement
true
if this query does not contain a
<query-token>
child element;
false
otherwisepublic boolean isSubsequentQuery()
isSubsequentQuery
in class XDSQueryElement
true
if this query contains a <query-token>
child element; false
otherwisepublic boolean isExtended()
isExtended
in class XDSQueryElement
true
if result set size is unlimited and this query
has a scope other than entry; false
otherwisepublic List childElements()
childElements
in interface XDSElement
childElements
in class XDSQueryElement
Collections.EMPTY_LIST
or a list of
XDSAssociationElement
,
XDSSearchClassElement
,
XDSSearchAttrElement
,
XDSReadAttrElement
,
XDSReadParentElement
,
XDSQueryTokenElement
, and
NonXDSElement
objects; will not return
null
public void setCancel(boolean cancel)
cancel
attribute to
cancel
.
cancel
- should this query be cancelled?public void setMaxResultCount(int someCount)
max-result-count
attribute to
someCount
.
someCount
- if null
or ""
, no action is
takenpublic XDSQueryTokenElement appendQueryTokenElement(String someToken)
<query-token;
element to this
element.
someToken
- may be null
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |