|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Base interface for all object filters; represents data about a query being constructed. This interface is used to conveniently pass several pieces of data about a query into a method that performs a query. The following data may be specified:
setQueryOrders
method in each derived type
from IFilter
, taking an array of the object-specific QueryOrder
type, each QueryOrder
instance in the array encapsulating a sort field and
ascending/descending order. For example, IDiscussionMessageFilter
takes an array of DiscussionMessageQueryOrder
, each QueryOrder
instance taking a DiscussionMessageAttribute
sort field.
Method Summary | |
int |
getMaximumResults()
Returns the value set by setMaximumResults . |
boolean |
isRestoreSecurity()
Returns true if security on returned objects
should be applied to with respect to the user who performs
a query. |
void |
setMaximumResults(int maximumResults)
Sets the maximum results to return. |
void |
setRestoreSecurity(boolean restoreSecurity)
Enables or disables the security filter on the result set of the query. |
Method Detail |
public int getMaximumResults()
setMaximumResults
.
public boolean isRestoreSecurity()
true
if security on returned objects
should be applied to with respect to the user who performs
a query. Returns false
if all the objects
that satisfy the query criteria should be returned regardless
of security settings. The default value is
false
. This default mode, with no security
information applied on the query, is more efficient.
Note: If this method returns true
, the
query will not return any of the objects that the
querying user does not have appropriate access to.
true
if the all security should
be restored, otherwise false
public void setMaximumResults(int maximumResults)
maximumResults
- the maximum number of rows to return; 0 means unlimitedpublic void setRestoreSecurity(boolean restoreSecurity)
true
will enable security checking on each of the returned
objects against the user who performs a query.
Note: If the querying user does not have appropriate
permission to access the returned objects, the query
result will not include those objects.
Not calling this method and calling this method
with false
will have the same effect on
the query. An additional security filter will
not be added, and all objects matching the query criteria
will be returned. The default value is
false
, which is more efficient.
This method can be used in conjunction with
isRestoreSecurity
, which would indicate if the
query has restoreSecurity
enabled.
restoreSecurity
- true
if security
should be restored, otherwise false
.
Default value is false
if not set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.