com.atlassian.confluence.rpc.soap.services
Interface SoapServiceHelper

All Known Implementing Classes:
SoapServiceHelperImpl

public interface SoapServiceHelper


Method Summary
 void assertCanAdminister()
           
 void assertCanAdminister(Space space)
           
 void assertCanCreateBlogPost(Space space)
           
 void assertCanCreatePage(Space space)
           
 void assertCanExport(Space space)
           
 void assertCanModify(AbstractPage page)
           
 void assertCanModifyObject(Object obj, String typeDescription)
          Determines if the current user can modify/edit the given object If the current user is a super-user, they will automatically pass this test
 void assertCanRemove(AbstractPage page)
           
 void assertCanView(AbstractPage page)
           
 void assertCanView(Space space)
           
 AbstractPage retrieveAbstractPage(long pageId)
           
 ContentEntityObject retrieveContent(long contentId)
          Retrieves the content with the given ID, throwing an exception if the content can not be found, or the current user has not permission to view it.
 Page retrievePage(String spaceKey, String pageTitle)
           
 Space retrieveSpace(String spaceKey)
           
 com.atlassian.user.User retrieveUser(String username)
          Retrieves the user with the given username
 

Method Detail

retrieveSpace

Space retrieveSpace(String spaceKey)
                    throws RemoteException
Throws:
RemoteException

retrieveAbstractPage

AbstractPage retrieveAbstractPage(long pageId)
                                  throws RemoteException
Throws:
RemoteException

retrievePage

Page retrievePage(String spaceKey,
                  String pageTitle)
                  throws RemoteException
Throws:
RemoteException

retrieveUser

com.atlassian.user.User retrieveUser(String username)
                                     throws RemoteException
Retrieves the user with the given username

Parameters:
username - the username of the user
Returns:
The User instance corresponding to the user
Throws:
RemoteException - if the username is empty or null
RemoteException - if no User could be found for the username

assertCanAdminister

void assertCanAdminister()
                         throws RemoteException
Throws:
RemoteException

assertCanModifyObject

void assertCanModifyObject(Object obj,
                           String typeDescription)
                           throws NotPermittedException
Determines if the current user can modify/edit the given object If the current user is a super-user, they will automatically pass this test

Parameters:
obj - the target object
typeDescription - the type of object (e.g. "labels")
Throws:
NotPermittedException - if the user lacks EDIT permission

assertCanModify

void assertCanModify(AbstractPage page)
                     throws RemoteException
Throws:
RemoteException

assertCanRemove

void assertCanRemove(AbstractPage page)
                     throws RemoteException
Throws:
RemoteException

assertCanView

void assertCanView(AbstractPage page)
                   throws RemoteException
Throws:
RemoteException

assertCanExport

void assertCanExport(Space space)
                     throws RemoteException
Throws:
RemoteException

assertCanAdminister

void assertCanAdminister(Space space)
                         throws RemoteException
Throws:
RemoteException

assertCanView

void assertCanView(Space space)
                   throws RemoteException
Throws:
RemoteException

assertCanCreateBlogPost

void assertCanCreateBlogPost(Space space)
                             throws RemoteException
Throws:
RemoteException

assertCanCreatePage

void assertCanCreatePage(Space space)
                         throws RemoteException
Throws:
RemoteException

retrieveContent

ContentEntityObject retrieveContent(long contentId)
                                    throws RemoteException
Retrieves the content with the given ID, throwing an exception if the content can not be found, or the current user has not permission to view it.

Parameters:
contentId - the ID of the content to retrieve
Returns:
the associated content object
Throws:
RemoteException - if the user lacks VIEW permission or the content does not exist


Copyright © 2003-2012 Atlassian. All Rights Reserved.