|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.api.Api
com.xpn.xwiki.plugin.PluginApi
com.xpn.xwiki.plugin.spacemanager.plugin.SpaceManagerPluginApi
com.xpn.xwiki.plugin.workspacesmanager.WorkspacesManagerApi
public class WorkspacesManagerApi
API for the workspaces manager plugin. Expose the actual methods offered for velocity scripting from the Wiki.
Field Summary |
---|
Fields inherited from class com.xpn.xwiki.api.Api |
---|
context |
Constructor Summary | |
---|---|
WorkspacesManagerApi(WorkspacesManager plugin,
com.xpn.xwiki.XWikiContext context)
|
Method Summary | |
---|---|
void |
addReader(java.lang.String spaceName,
java.lang.String userName)
Add a user to the workspace, without allowing role downgrading. |
void |
addReader(java.lang.String spaceName,
java.lang.String userName,
boolean allowDowngrade)
Add a user as a reader to the space, adding to the reader role group. |
void |
addWriter(java.lang.String spaceName,
java.lang.String userName)
|
void |
addWriter(java.lang.String spaceName,
java.lang.String userName,
boolean allowDowngrade)
|
int |
countMembers(java.lang.String spaceName)
|
java.lang.String |
getApplicationName()
|
java.lang.String |
getApplicationName(java.lang.String docFullname)
|
java.util.Collection |
getApplicationsNames(java.lang.String spaceName)
|
java.lang.String |
getApplicationURL(java.lang.String spaceName,
java.lang.String appName)
|
java.lang.String |
getApplicationURL(java.lang.String spaceName,
java.lang.String appName,
java.lang.String docName)
|
java.lang.String |
getApplicationURL(java.lang.String spaceName,
java.lang.String appName,
java.lang.String docName,
java.lang.String queryString)
|
java.util.Collection |
getDeletedSpaces()
|
java.util.Collection |
getLastMembers(java.lang.String spaceName,
int howMany)
|
java.util.Collection |
getLastSpaces(int howMany)
|
java.util.Collection |
getLastSpaces(int howMany,
int startAt)
|
java.util.Collection |
getMyMemberships()
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getMySpace()
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getOrganizationSpace()
|
java.util.Collection |
getPotentialMembers(java.lang.String spaceName)
|
java.util.Collection |
getPotentialMembers(java.lang.String spaceName,
int howMany,
int startAt)
Lookup the wiki users that are not already members of the asked workspace. |
java.util.Collection |
getPotentialMembers(java.lang.String spaceName,
java.lang.String matching,
int howMany,
int startAt)
|
java.util.Collection |
getPublicSpaces()
|
java.util.Collection |
getReaders(java.lang.String spaceName)
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getRootSpace(java.lang.String web)
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getSpace()
|
com.xpn.xwiki.plugin.spacemanager.api.Space |
getSpaceForUser(java.lang.String userName)
|
java.util.List |
getStories(java.lang.String spaceName)
Deprecated. |
java.util.List |
getStories(java.lang.String spaceName,
int howMany)
Deprecated. |
java.util.List |
getStories(java.lang.String spaceName,
int howMany,
int startAt)
Deprecated. |
java.util.Collection |
getWebsForSpace(java.lang.String spaceName)
|
protected WorkspacesManager |
getWorkspacesManager()
|
java.util.Collection |
getWriters(java.lang.String spaceName)
|
boolean |
hasApplication(java.lang.String spaceName,
java.lang.String appName)
|
boolean |
isSpace()
|
boolean |
makeSpacePrivate(java.lang.String spaceName)
|
boolean |
makeSpacePublic(java.lang.String spaceName)
|
void |
removeAdmin(java.lang.String spaceName,
java.lang.String userName)
Remove an admin from a workspace, removing him as a member too |
void |
removeReader(java.lang.String spaceName,
java.lang.String userName)
Remove a reader from a workspace, removing him as a member too |
void |
removeWriter(java.lang.String spaceName,
java.lang.String userName)
Remove a writer from a workspace, removing him as a member too |
java.util.List |
searchDocuments(java.lang.String spaceName,
java.lang.String applicationName)
|
java.util.List |
searchDocuments(java.lang.String spaceName,
java.lang.String applicationName,
int howMany)
|
java.util.List |
searchDocuments(java.lang.String spaceName,
java.lang.String applicationName,
int howMany,
int startAt)
|
Methods inherited from class com.xpn.xwiki.plugin.spacemanager.plugin.SpaceManagerPluginApi |
---|
addAdmin, addMember, countSpaces, createSpace, createSpaceFromApplication, createSpaceFromRequest, createSpaceFromRequest, createSpaceFromTemplate, deleteSpace, getAdmins, getCurrentSpace, getLastModifiedDocuments, getMembers, getRoles, getRoles, getSpace, getSpaceManager, getSpaceNames, getSpaceNames, getSpaceNames, getSpaces, getSpaces, getSpaces, getSpaceUserProfile, getUsersForRole, getVersion, isAdmin, isMember, joinSpace, removeMember, searchSpaceNames, searchSpaceNames, searchSpaces, searchSpaces, setSpaceRights, setSubSpaceRights, undeleteSpace, updateSpaceFromRequest, updateSpaceRights, validateSpaceData |
Methods inherited from class com.xpn.xwiki.plugin.PluginApi |
---|
getInternalPlugin, getPlugin, getProtectedPlugin, setPlugin |
Methods inherited from class com.xpn.xwiki.api.Api |
---|
checkProgrammingRights, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WorkspacesManagerApi(WorkspacesManager plugin, com.xpn.xwiki.XWikiContext context)
Method Detail |
---|
protected WorkspacesManager getWorkspacesManager()
public java.util.Collection getLastSpaces(int howMany)
howMany
- the number of workspaces to return
public java.util.Collection getLastSpaces(int howMany, int startAt)
startAt
- the offset to start retrieving the latest workspaces atgetLastSpaces(int)
public java.util.Collection getLastMembers(java.lang.String spaceName, int howMany)
spaceName
- the workspace wiki name to retrieve the latest members forhowMany
- the number of members to retrieve
public com.xpn.xwiki.plugin.spacemanager.api.Space getMySpace()
Workspace
for the context userpublic int countMembers(java.lang.String spaceName)
spaceName
- the wiki name of the workspace to count the members of
public java.util.Collection getMyMemberships()
Workspace
in which the context user is a member and has a
specific role (i.e. admin, reader or writer).public java.util.Collection getPotentialMembers(java.lang.String spaceName)
getPotentialMembers(String, int, int)
public java.util.Collection getPotentialMembers(java.lang.String spaceName, int howMany, int startAt)
spaceName
- the wiki name of the workspace to retrieve the users that does not belong to
ithowMany
- the number of potential members to retrievestartAt
- the offset to start retrieving the potential members at
public java.util.Collection getPotentialMembers(java.lang.String spaceName, java.lang.String matching, int howMany, int startAt)
matching
- the sequence of letters that either the first name or the last name of the
potential members to retrieve must contains.
getPotentialMembers(String, int, int)
public java.util.Collection getWriters(java.lang.String spaceName)
spaceName
- the wiki name of the workspace to retrieve the writers of
public java.util.Collection getReaders(java.lang.String spaceName)
spaceName
- the wiki name of the workspace to retrieve the readers of
public com.xpn.xwiki.plugin.spacemanager.api.Space getSpaceForUser(java.lang.String userName)
userName
- the wiki name of the user to find the userspace of
public com.xpn.xwiki.plugin.spacemanager.api.Space getRootSpace(java.lang.String web)
web,
- the wiki space (a.k.a. web) to retrieve the root space for
public com.xpn.xwiki.plugin.spacemanager.api.Space getSpace()
public boolean isSpace()
public void addReader(java.lang.String spaceName, java.lang.String userName)
addReader(String, String, boolean)
public void addReader(java.lang.String spaceName, java.lang.String userName, boolean allowDowngrade)
spaceName
- the wiki name of the workspace to add the reader touserName
- the wiki name of the user to add to the workspace as a readerallowDowngrade
- allow or not, to downgrade the role of the user within the workspace,
if this one already is member with a higher role (writer or admin)public void removeAdmin(java.lang.String spaceName, java.lang.String userName)
removeAdmin
in class com.xpn.xwiki.plugin.spacemanager.plugin.SpaceManagerPluginApi
public void removeReader(java.lang.String spaceName, java.lang.String userName)
public void removeWriter(java.lang.String spaceName, java.lang.String userName)
public void addWriter(java.lang.String spaceName, java.lang.String userName, boolean allowDowngrade)
public void addWriter(java.lang.String spaceName, java.lang.String userName)
public boolean hasApplication(java.lang.String spaceName, java.lang.String appName)
public java.lang.String getApplicationURL(java.lang.String spaceName, java.lang.String appName, java.lang.String docName, java.lang.String queryString)
public java.util.List getStories(java.lang.String spaceName)
public java.util.List getStories(java.lang.String spaceName, int howMany)
public java.util.List getStories(java.lang.String spaceName, int howMany, int startAt)
public java.lang.String getApplicationURL(java.lang.String spaceName, java.lang.String appName, java.lang.String docName)
public java.lang.String getApplicationURL(java.lang.String spaceName, java.lang.String appName)
public java.lang.String getApplicationName()
public java.lang.String getApplicationName(java.lang.String docFullname)
public java.util.Collection getApplicationsNames(java.lang.String spaceName)
public java.util.Collection getWebsForSpace(java.lang.String spaceName)
public java.util.List searchDocuments(java.lang.String spaceName, java.lang.String applicationName)
public java.util.List searchDocuments(java.lang.String spaceName, java.lang.String applicationName, int howMany)
public java.util.List searchDocuments(java.lang.String spaceName, java.lang.String applicationName, int howMany, int startAt)
public java.util.Collection getPublicSpaces()
public java.util.Collection getDeletedSpaces()
public boolean makeSpacePublic(java.lang.String spaceName)
public boolean makeSpacePrivate(java.lang.String spaceName)
public com.xpn.xwiki.plugin.spacemanager.api.Space getOrganizationSpace()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |