net.sourceforge.jwbf.mediawiki.actions.editing

Class MovePage

java.lang.Object

net.sourceforge.jwbf.mediawiki.actions.util.MWAction

net.sourceforge.jwbf.mediawiki.actions.editing.MovePage

All Implemented Interfaces:

ContentProcessable, ReturningText

public class MovePage
extends MWAction

Action class using the MediaWiki-API's "action=move".

To allow your bot to move articles in your MediaWiki add the following line to your MediaWiki's LocalSettings.php:

 $wgEnableWriteAPI = true;
 $wgGroupPermissions['bot']['move'] = true;
 $wgGroupPermissions['bot']['movefile'] = true;            // optional
 $wgGroupPermissions['bot']['move-subpages'] = true;       // optional
 $wgGroupPermissions['bot']['move-rootuserpages'] = true;  // optional
 

Move an article with

 String oldtitle = ...
 String newtitle = ...
 String reason = ...
 Boolean withsubpages = ...
 Boolean noredirect = ...
 
 MediaWikiBot bot = ...
 bot.performAction(new MovePage(bot, oldtitle, newtitle, reason, withsubpages, noredirect));
 

Author:

Christoph Giesel

Constructor Summary

Constructors

Constructor and Description
MovePage(MediaWikiBot bot, String oldtitle, String newtitle, String reason, boolean withsubpages, boolean noredirect) Constructs a new MovePage action.

Method Summary

Methods

Modifier and Type	Method and Description
HttpAction	getNextMessage()
String	processReturningText(String s, HttpAction hm) Deals with the MediaWiki API's response by parsing the provided text.

Methods inherited from class net.sourceforge.jwbf.mediawiki.actions.util.MWAction

createNsString, evaluateXpath, getErrorElement, getRootElement, getRootElementWithError, hasMoreMessages, isSelfExecuter, processAllReturningText, setExceptionHandler, setHasMoreMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

MovePage

public MovePage(MediaWikiBot bot,
        String oldtitle,
        String newtitle,
        String reason,
        boolean withsubpages,
        boolean noredirect)

Constructs a new MovePage action.

Parameters:

bot - the MediaWikiBot

oldtitle - title to move

newtitle - new title

reason - reason why to move

withsubpages - if TRUE also move the subpages

noredirect - if TRUE create no redirects

Method Detail

processReturningText

public String processReturningText(String s,
                          HttpAction hm)

Deals with the MediaWiki API's response by parsing the provided text.

Specified by:

processReturningText in interface ReturningText

Overrides:

processReturningText in class MWAction

Parameters:

s - the answer to the most recently generated MediaWiki API request

hm - the requestor message

Returns:

the returning text on processing problems

getNextMessage

public HttpAction getNextMessage()

Returns:

the of messages in this action