org.apache.slide.macro
Interface Macro

All Known Implementing Classes:

MacroImpl

public interface Macro

Macro helper class.

Version:

$Revision: 1.5 $

Author:

Remy Maucherat

Field Summary

static MacroParameters	DEFAULT_PARAMETERS Default macro parameters.
static MacroParameters	RECURSIVE_OVERWRITE_PARAMETERS Recursive, overwrite macro parameters.

Method Summary

void	copy(SlideToken token, java.lang.String sourceUri, java.lang.String destinationUri) Recursive copy with overwrite macro.
void	copy(SlideToken token, java.lang.String sourceUri, java.lang.String destinationUri, MacroParameters parameters) Copy macro.
void	delete(SlideToken token, java.lang.String targetUri) Recursive delete.
void	delete(SlideToken token, java.lang.String targetUri, MacroParameters parameters) Delete macro.
void	move(SlideToken token, java.lang.String sourceUri, java.lang.String destinationUri) Recursive move with overwrite macro.
void	move(SlideToken token, java.lang.String sourceUri, java.lang.String destinationUri, MacroParameters parameters) Move macro.

Field Detail

DEFAULT_PARAMETERS

public static final MacroParameters DEFAULT_PARAMETERS

Default macro parameters.

RECURSIVE_OVERWRITE_PARAMETERS

public static final MacroParameters RECURSIVE_OVERWRITE_PARAMETERS

Recursive, overwrite macro parameters.

Method Detail

copy

public void copy(SlideToken token,
                 java.lang.String sourceUri,
                 java.lang.String destinationUri)
          throws CopyMacroException,
                 DeleteMacroException

Recursive copy with overwrite macro.

Parameters:

token - Credentials token

sourceUri - Uri of the source

destinationUri - Uri of the destination

Throws:

CopyMacroException - Generic Slide exception

copy

public void copy(SlideToken token,
                 java.lang.String sourceUri,
                 java.lang.String destinationUri,
                 MacroParameters parameters)
          throws CopyMacroException,
                 DeleteMacroException

Copy macro.

Parameters:

token - Credentials token

sourceUri - Uri of the source

destinationUri - Uri of the destination

parameters - Macro parameters

Throws:

CopyMacroException - Generic Slide exception

move

public void move(SlideToken token,
                 java.lang.String sourceUri,
                 java.lang.String destinationUri)
          throws CopyMacroException,
                 DeleteMacroException

Recursive move with overwrite macro.

Parameters:

token - Credentials token

sourceUri - Uri of the source

destinationUri - Uri of the destination

Throws:

CopyMacroException - Exception occured during copy

DeleteMacroException - Exception occured during deletion

move

public void move(SlideToken token,
                 java.lang.String sourceUri,
                 java.lang.String destinationUri,
                 MacroParameters parameters)
          throws CopyMacroException,
                 DeleteMacroException

Move macro.

Parameters:

token - Credentials token

sourceUri - Uri of the source

destinationUri - Uri of the destination

parameters - Macro parameters

Throws:

CopyMacroException - Exception occured during copy

DeleteMacroException - Exception occured during deletion

delete

public void delete(SlideToken token,
                   java.lang.String targetUri)
            throws DeleteMacroException

Recursive delete.

Parameters:

token - Credentials token

targetUri - Uri of the object to delete

Throws:

DeleteMacroException - Generic Slide exception

delete

public void delete(SlideToken token,
                   java.lang.String targetUri,
                   MacroParameters parameters)
            throws DeleteMacroException

Delete macro.

Parameters:

token - Credentials token

targetUri - Uri of the source

parameters - Macro parameters, not used right now, so it can be null

Throws:

DeleteMacroException - Generic Slide exception