|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.criteria.impl.ScopeFactory
public class ScopeFactory
Helper factory class for creating Scope objects in velocity
Field Summary | |
---|---|
static Scope |
ALL
A scope that matches the entire application as a unit |
static Scope |
ALL_PAGES
A scope that matches all pages within any space and any wiki |
static Scope |
ALL_SPACES
A scope that matches all spaces within any wiki |
static Scope |
ALL_WIKIS
A scope that matches all wikis within the application |
Constructor Summary | |
---|---|
ScopeFactory()
|
Method Summary | |
---|---|
static Scope |
createPageScope(String pageName)
Creates a new scope associated with the specified page. |
static Scope |
createScope(int type,
String name,
boolean deep)
|
static Scope |
createSpaceScope(String spaceName)
Creates a new scope associated with the specified space and matching all its pages. |
static Scope |
createSpaceScope(String spaceName,
boolean deep)
Creates a new scope associated with the specified space. |
static Scope |
createWikiScope(String wikiName)
Creates a new scope associated with the specified wiki and matching all its spaces. |
static Scope |
createWikiScope(String wikiName,
boolean deep)
Creates a new scope associated with the specified wiki. |
static Scope |
getALL_PAGES()
Helper method for accessing ALL_PAGES static field in velocity |
static Scope |
getALL_SPACES()
Helper method for accessing ALL_SPACES static field in velocity |
static Scope |
getALL_WIKIS()
Helper method for accessing ALL_WIKIS static field in velocity |
static Scope |
getALL()
Helper method for accessing ALL static field in velocity |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final Scope ALL_PAGES
public static final Scope ALL_SPACES
public static final Scope ALL_WIKIS
public static final Scope ALL
Constructor Detail |
---|
public ScopeFactory()
Method Detail |
---|
public static Scope createScope(int type, String name, boolean deep)
Scope.Scope(int, String, boolean)
public static Scope createPageScope(String pageName)
pageName
- A page name
public static Scope createSpaceScope(String spaceName)
spaceName
- A space name
public static Scope createSpaceScope(String spaceName, boolean deep)
spaceName
- A space namedeep
- true
for matching all its pages; false
for matching this space as a unit
public static Scope createWikiScope(String wikiName)
wikiName
- A wiki name
public static Scope createWikiScope(String wikiName, boolean deep)
wikiName
- A wiki namedeep
- true
for matching all its spaces; false
for matching this wiki as a unit
public static Scope getALL_PAGES()
ALL_PAGES
static field in velocity
public static Scope getALL_SPACES()
ALL_SPACES
static field in velocity
public static Scope getALL_WIKIS()
ALL_WIKIS
static field in velocity
public static Scope getALL()
ALL
static field in velocity
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |