com.atlassian.confluence.content.service
Interface PageService

All Known Implementing Classes:
DefaultPageService

public interface PageService

The PageService is a service layer implementation of the PageManager.

See Also:
Confluence Service Layer Documentation

Method Summary
 PageLocator getIdPageLocator(long pageId)
          Creates a page locator that can locate a page based on an id.
 ServiceCommand newDeletePageCommand(PageLocator pageLocator)
          Retrieve a command to remove an existing page
 MovePageCommand newMovePageCommand(PageLocator sourcePageLocator, PageLocator targetPageLocator, java.lang.String position)
          Retrieve a command to perform a simple move operation.
 MovePageCommand newMovePageCommand(PageLocator sourcePageLocator, SpaceLocator targetSpaceLocator)
          Retrieve a command that performs a move operation of a page to a top level of a target space.
 ServiceCommand newRevertPageCommand(PageLocator pageToRevert, int version, java.lang.String revertComment, boolean revertTitle)
          Retreive a command to revert a page
 ServiceCommand newRevertPageOrderCommand(PageLocator parentPageLocator)
          Retrieve a command to clear any existing positions for children of the located Page.
 ServiceCommand newSetPageOrderCommand(PageLocator parentPageLocator, java.util.List<java.lang.Long> childPageIds)
          Retrieve a command to set the order of all children for a supplied parent Page locator.
 

Method Detail

newMovePageCommand

MovePageCommand newMovePageCommand(PageLocator sourcePageLocator,
                                   PageLocator targetPageLocator,
                                   java.lang.String position)
Retrieve a command to perform a simple move operation.

Parameters:
position - the point describing where the source should be moved to in relation to the target, see MovePageCommand
Returns:
an appropriate command instance

newMovePageCommand

MovePageCommand newMovePageCommand(PageLocator sourcePageLocator,
                                   SpaceLocator targetSpaceLocator)
Retrieve a command that performs a move operation of a page to a top level of a target space.


getIdPageLocator

PageLocator getIdPageLocator(long pageId)
Creates a page locator that can locate a page based on an id.


newSetPageOrderCommand

ServiceCommand newSetPageOrderCommand(PageLocator parentPageLocator,
                                      java.util.List<java.lang.Long> childPageIds)
Retrieve a command to set the order of all children for a supplied parent Page locator.

Parameters:
parentPageLocator - locator for the parent Page object
childPageIds - a list of child page ids

newRevertPageOrderCommand

ServiceCommand newRevertPageOrderCommand(PageLocator parentPageLocator)
Retrieve a command to clear any existing positions for children of the located Page.


newDeletePageCommand

ServiceCommand newDeletePageCommand(PageLocator pageLocator)
Retrieve a command to remove an existing page


newRevertPageCommand

ServiceCommand newRevertPageCommand(PageLocator pageToRevert,
                                    int version,
                                    java.lang.String revertComment,
                                    boolean revertTitle)
Retreive a command to revert a page



Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.