org.xwiki.query

Interface SecureQuery

All Superinterfaces:

Query

public interface SecureQuery
extends Query

Extends Query with various security related options.

Since:

7.2M2

Version:

$Id: 8fe13c926ce42a6e0cb9cbd22bf90c52fd7d39f1 $

Field Summary

Fields inherited from interface org.xwiki.query.Query

HQL, XPATH, XWQL

Method Summary

Modifier and Type	Method and Description
SecureQuery	checkCurrentAuthor(boolean checkCurrentAuthor)
SecureQuery	checkCurrentUser(boolean checkCurrentUser)
boolean	isCurrentAuthorChecked()
boolean	isCurrentUserChecked()

Methods inherited from interface org.xwiki.query.Query

addFilter, bindValue, bindValue, bindValue, bindValues, bindValues, execute, getFilters, getLanguage, getLimit, getNamedParameters, getOffset, getPositionalParameters, getStatement, getWiki, isNamed, setLimit, setOffset, setWiki

Method Detail

isCurrentAuthorChecked

boolean isCurrentAuthorChecked()

Returns:

true if the right of the current author (usually the content author of the context document or secure document) should be checked

checkCurrentAuthor

SecureQuery checkCurrentAuthor(boolean checkCurrentAuthor)

Parameters:

checkCurrentAuthor - true if the right of the current author (usually the content author of the context document or secure document) should be checked

Returns:

this query.

isCurrentUserChecked

boolean isCurrentUserChecked()

Returns:

true if the right of the current author should be checked (for example to filter results)

checkCurrentUser

SecureQuery checkCurrentUser(boolean checkCurrentUser)

Parameters:

checkCurrentUser - true if the right of the current user should be checked (for example to filter results)

Returns:

this query.