Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.upgrade.tasks
Class StripMessageTokensFromWatchTemplates

java.lang.Object
  extended by com.jivesoftware.forum.upgrade.tasks.StripMessageTokensFromWatchTemplates
All Implemented Interfaces:
UpgradeTask

public class StripMessageTokensFromWatchTemplates
extends java.lang.Object
implements UpgradeTask

Alters any custom email watch templates to remove tokens which are no longer included for email reply support.


Constructor Summary
StripMessageTokensFromWatchTemplates()
           
 
Method Summary
 void doTask()
          Executes the upgrade task
 java.lang.String getDescription()
          Upgrade task description
 java.lang.String getEstimatedRunTime()
          Upgrade task estimated run time
 java.lang.String getInstructionsFile()
          Returns the name of the manual instructions file that will be displayed if the task fails.
 java.lang.String getName()
          Upgrade task name
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StripMessageTokensFromWatchTemplates

public StripMessageTokensFromWatchTemplates()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: UpgradeTask
Upgrade task name

Specified by:
getName in interface UpgradeTask

getDescription

public java.lang.String getDescription()
Description copied from interface: UpgradeTask
Upgrade task description

Specified by:
getDescription in interface UpgradeTask

getEstimatedRunTime

public java.lang.String getEstimatedRunTime()
Description copied from interface: UpgradeTask
Upgrade task estimated run time

Specified by:
getEstimatedRunTime in interface UpgradeTask

getInstructionsFile

public java.lang.String getInstructionsFile()
Description copied from interface: UpgradeTask
Returns the name of the manual instructions file that will be displayed if the task fails. All instructions files will be loaded from com/jivesoftware/forum/upgrade/instructions/ and will have .txt appended to the end of the name.

Specified by:
getInstructionsFile in interface UpgradeTask

doTask

public void doTask()
            throws java.sql.SQLException,
                   java.io.IOException,
                   java.lang.Exception
Description copied from interface: UpgradeTask
Executes the upgrade task

Specified by:
doTask in interface UpgradeTask
Throws:
java.sql.SQLException
java.io.IOException
java.lang.Exception

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.