uk.ac.cam.caret.sakai.rwiki.component.macros

Class WorksiteInfoMacro

java.lang.Object

org.radeox.macro.BaseMacro

uk.ac.cam.caret.sakai.rwiki.component.macros.WorksiteInfoMacro

All Implemented Interfaces:

Comparable, org.radeox.api.macro.Macro

public class WorksiteInfoMacro
extends org.radeox.macro.BaseMacro

Provides access to worksite information

Author:

ieb

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

description, initialContext, paramDescription

Constructor Summary

Constructors

Constructor and Description
WorksiteInfoMacro()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(Writer writer, org.radeox.api.macro.MacroParameter params)
String	getDescription()
String	getName()
String[]	getParamDescription()

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, setInitialContext, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WorksiteInfoMacro

public WorksiteInfoMacro()

Method Detail

getParamDescription

public String[] getParamDescription()

Specified by:

getParamDescription in interface org.radeox.api.macro.Macro

Overrides:

getParamDescription in class org.radeox.macro.BaseMacro

getDescription

public String getDescription()

Specified by:

getDescription in interface org.radeox.api.macro.Macro

Overrides:

getDescription in class org.radeox.macro.BaseMacro

getName

public String getName()

Specified by:

getName in interface org.radeox.api.macro.Macro

Specified by:

getName in class org.radeox.macro.BaseMacro

execute

public void execute(Writer writer,
           org.radeox.api.macro.MacroParameter params)
             throws IllegalArgumentException,
                    IOException

Specified by:

execute in interface org.radeox.api.macro.Macro

Specified by:

execute in class org.radeox.macro.BaseMacro

Throws:

IllegalArgumentException

IOException