com.ibm.portal.sitemanagement.command
Interface SitemanagementCommand

All Superinterfaces:
Disposable
All Known Subinterfaces:
DemoteCommand, PromoteCommand, PublishCommand

public interface SitemanagementCommand
extends Disposable

This is the general sitemanagement command interface. It provides all common methods for the extending commands

Since:
6.1

Method Summary
 void execute()
          Executes the command
 void setHierarchy(boolean hierarchy)
          Specifies if hierarchy has to be handled as well.
 void setResource(Identifiable resource)
          Sets the reference to the object to handle
 void setResource(java.lang.String uniqueName)
          Sets the reference to the uniquename to handle
 
Methods inherited from interface com.ibm.portal.Disposable
dispose
 

Method Detail

setResource

void setResource(Identifiable resource)
Sets the reference to the object to handle

Parameters:
resource - Identifiable reference

setResource

void setResource(java.lang.String uniqueName)
Sets the reference to the uniquename to handle

Parameters:
uniqueName - String reference

setHierarchy

void setHierarchy(boolean hierarchy)
Specifies if hierarchy has to be handled as well. If true, the Sitemanagement command will apply to the resource specified in the setResource() method, and its children. If false, only the resource itself will be acted on

Parameters:
hierarchy - boolean

execute

void execute()
             throws SitemanagementCommandException
Executes the command

Throws:
SitemanagementCommandException