com.xpn.xwiki.plugin.packaging
Class PackageAPI

java.lang.Object
  extended by com.xpn.xwiki.api.Api
      extended by com.xpn.xwiki.plugin.packaging.PackageAPI

public class PackageAPI
extends Api


Field Summary
(package private)  Package plugin
           
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
PackageAPI(Package plugin, XWikiContext context)
           
 
Method Summary
 boolean add(java.lang.String docFullName)
           
 boolean add(java.lang.String docFullName, int DefaultAction)
           
 void addDocumentFilter(java.lang.Object filter)
           
 void backupWiki()
           
 java.lang.String export()
           
 java.lang.String getAuthorName()
           
 java.lang.String getDescription()
           
 java.util.List getFiles()
           
 java.lang.String getLicence()
           
 java.lang.String getName()
           
 Package getPackage()
           
 java.lang.String getVersion()
           
 java.lang.String Import(byte[] file)
           
 int install()
           
 boolean isBackupPack()
           
 boolean isWithVersions()
           
 void setAuthorName(java.lang.String authorName)
           
 void setBackupPack(boolean backupPack)
           
 void setDescription(java.lang.String description)
           
 void setDocumentAction(java.lang.String docFullName, int action)
           
 void setLicence(java.lang.String licence)
           
 void setName(java.lang.String name)
           
private  void setPlugin(Package plugin)
           
 void setVersion(java.lang.String version)
           
 void setWithVersions(boolean withVersions)
           
 int testInstall()
           
 java.lang.String toXml()
           
 
Methods inherited from class com.xpn.xwiki.api.Api
checkProgrammingRights, hasAccessLevel, hasAdminRights, hasProgrammingRights
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

plugin

Package plugin
Constructor Detail

PackageAPI

public PackageAPI(Package plugin,
                  XWikiContext context)
           throws PackageException
Throws:
PackageException
Method Detail

setPlugin

private void setPlugin(Package plugin)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getPackage

public Package getPackage()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getLicence

public java.lang.String getLicence()

setLicence

public void setLicence(java.lang.String licence)

getAuthorName

public java.lang.String getAuthorName()

setAuthorName

public void setAuthorName(java.lang.String authorName)

isBackupPack

public boolean isBackupPack()

setBackupPack

public void setBackupPack(boolean backupPack)

isWithVersions

public boolean isWithVersions()

setWithVersions

public void setWithVersions(boolean withVersions)

addDocumentFilter

public void addDocumentFilter(java.lang.Object filter)
                       throws PackageException
Throws:
PackageException

getFiles

public java.util.List getFiles()

add

public boolean add(java.lang.String docFullName,
                   int DefaultAction)
            throws XWikiException
Throws:
XWikiException

add

public boolean add(java.lang.String docFullName)
            throws XWikiException
Throws:
XWikiException

setDocumentAction

public void setDocumentAction(java.lang.String docFullName,
                              int action)

export

public java.lang.String export()
                        throws java.io.IOException,
                               XWikiException
Throws:
java.io.IOException
XWikiException

Import

public java.lang.String Import(byte[] file)
                        throws java.io.IOException,
                               XWikiException
Throws:
java.io.IOException
XWikiException

testInstall

public int testInstall()

backupWiki

public void backupWiki()
                throws XWikiException,
                       java.io.IOException
Throws:
XWikiException
java.io.IOException

toXml

public java.lang.String toXml()

install

public int install()
            throws XWikiException
Throws:
XWikiException


Copyright 2003 Ludovic Dubost