com.ibm.portal.sitemanagement.command
Interface PromoteCommand

All Superinterfaces:
Disposable, SitemanagementCommand

public interface PromoteCommand
extends SitemanagementCommand

The PromoteCommand is responsible for transfering resources from published state into the live state. After this step is completed the resource will be visible for all users.

Note: This command can only be executed once.

Since:
6.1

Nested Class Summary
static class PromoteCommand.Method
          Method interface which describes promote method to use.
 
Method Summary
 void execute()
          Executes the Promote command
 void setPromoteMethod(PromoteCommand.Method method)
          Sets the promote option for the command
 
Methods inherited from interface com.ibm.portal.sitemanagement.command.SitemanagementCommand
setHierarchy, setResource, setResource
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Method Detail

setPromoteMethod

void setPromoteMethod(PromoteCommand.Method method)
Sets the promote option for the command

Parameters:
method - use one of the parameters defined in the interface

execute

void execute()
             throws NodeNotFoundException,
                    CannotPromotePageException
Executes the Promote command

Specified by:
execute in interface SitemanagementCommand
Throws:
NodeNotFoundException - is thrown if the given resource couldn't be found
CannotPromotePageException - is thrown if an error during the promote proccessing occurs