com.xpn.xwiki.plugin.wikimanager.doc
Class XWikiServerClass

java.lang.Object
  com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.AbstractXClassManager<XWikiServer>
      com.xpn.xwiki.plugin.wikimanager.doc.XWikiServerClass

All Implemented Interfaces:

XClassManager<XWikiServer>

public class XWikiServerClass
extends AbstractXClassManager<XWikiServer>

XClassManager implementation for XWiki.XWikiServerClass class.

Version:

$Id$

See Also:

XClassManager

Field Summary

static java.lang.String	DEFAULT_FIELDS Default list separators of XWiki.XWikiServerClass fields.
static java.lang.String	DEFAULT_HOMEPAGE The full name of the default home page of a newly created wiki.
static java.lang.Boolean	DEFAULT_ISWIKITEMPLATE Default value of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	DEFAULT_PAGE_PARENT The full name of the default parent of a newly created document.
static java.lang.Boolean	DEFAULT_SECURE Default value of field secure for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_DESCRIPTION Name of field description for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_HOMEPAGE Name of field homepage for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_ISWIKITEMPLATE Name of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_LANGUAGE Name of field language for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_OWNER Name of field owner for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_SECURE Name of field secure for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_SERVER Name of field server for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_STATE Name of field state for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_VISIBILITY Name of field visibility for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELD_WIKIPRETTYNAME Name of field prettyname for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDDT_ISWIKITEMPLATE Display type of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDDT_SECURE Display type of field secure for the XWiki class XWiki.XWikiServerClass.
static int	FIELDDV_ISWIKITEMPLATE_INT Default value of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_LANGUAGE List of possible values for language for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_STATE List of possible values for state for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_STATE_ACTIVE First possible values for state for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_STATE_INACTIVE Second possible values for state for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_STATE_LOCKED Third possible values for state for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_VISIBILITY List of possible values for visibility for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_VISIBILITY_PRIVATE Second possible values for visibility for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDL_VISIBILITY_PUBLIC First possible values for visibility for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_DESCRIPTION Pretty name of field description for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_HOMEPAGE Pretty name of field homepage for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_ISWIKITEMPLATE Pretty name of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_LANGUAGE Pretty name of field language for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_OWNER Pretty name of field owner for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_SECURE Pretty name of field secure for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_SERVER Pretty name of field server for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_STATE Pretty name of field state for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_VISIBILITY Pretty name of field visibility for the XWiki class XWiki.XWikiServerClass.
static java.lang.String	FIELDPN_WIKIPRETTYNAME Pretty name of field prettyname for the XWiki class XWiki.XWikiServerClass.

Fields inherited from interface com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.XClassManager

XWIKI_CLASS_SPACE_PREFIX, XWIKI_CLASS_SPACE_SUFFIX, XWIKI_CLASS_SUFFIX, XWIKI_CLASSSHEET_SPACE_SUFFIX, XWIKI_CLASSSHEET_SUFFIX, XWIKI_CLASSTEMPLATE_SPACE_SUFFIX, XWIKI_CLASSTEMPLATE_SUFFIX

Constructor Summary

protected

XWikiServerClass() Default constructor for XWikiServerClass.

Method Summary

protected void	check(XWikiContext context)
boolean	forceValidDocumentName()
static XWikiServerClass	getInstance(XWikiContext context) Return unique instance of XWikiServerClass and update documents for this context.
XWikiServer	getWikiAlias(java.lang.String wikiName, int objectId, boolean validate, XWikiContext context) Get wiki alias XWikiServer.
XWikiServer	getWikiTemplateAlias(java.lang.String wikiName, int objectId, boolean validate, XWikiContext context) Get wiki template alias XWikiServer.
XWikiServer	getXObjectDocument(java.lang.String itemName, int objectId, boolean validate, XWikiContext context)
XWikiServer	newXObjectDocument(XWikiDocument doc, int objId, XWikiContext context)
java.util.List<XWikiServer>	searchXObjectDocumentsByFields(java.lang.Object[][] fieldDescriptors, XWikiContext context)
protected boolean	updateBaseClass(com.xpn.xwiki.objects.classes.BaseClass baseClass)
protected boolean	updateClassTemplateDocument(XWikiDocument doc)

Methods inherited from class com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.AbstractXClassManager

createWhereClause, getBaseClass, getClassDocument, getClassFullName, getClassName, getClassPrefix, getClassSheetDefaultContent, getClassSheetDocument, getClassSheetFullName, getClassSheetName, getClassSheetSpace, getClassSpace, getClassSpacePrefix, getClassTemplateDefaultContent, getClassTemplateDocument, getClassTemplateFullName, getClassTemplateName, getClassTemplateSpace, getItemDefaultName, getItemDocumentDefaultFullName, getItemDocumentDefaultName, intFromBoolean, isInstance, isInstance, isValidName, newXObjectDocument, newXObjectDocument, newXObjectDocumentList, newXObjectDocumentList, searchXObjectDocuments, searchXObjectDocumentsByField, updateBooleanClassDefaultValue, updateDocBooleanValue, updateDocStringValue

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIELDS

public static final java.lang.String DEFAULT_FIELDS

Default list separators of XWiki.XWikiServerClass fields.

See Also:

Constant Field Values

FIELD_WIKIPRETTYNAME

public static final java.lang.String FIELD_WIKIPRETTYNAME

Name of field prettyname for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_WIKIPRETTYNAME

public static final java.lang.String FIELDPN_WIKIPRETTYNAME

Pretty name of field prettyname for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_OWNER

public static final java.lang.String FIELD_OWNER

Name of field owner for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_OWNER

public static final java.lang.String FIELDPN_OWNER

Pretty name of field owner for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final java.lang.String FIELD_DESCRIPTION

Name of field description for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_DESCRIPTION

public static final java.lang.String FIELDPN_DESCRIPTION

Pretty name of field description for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_SERVER

public static final java.lang.String FIELD_SERVER

Name of field server for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_SERVER

public static final java.lang.String FIELDPN_SERVER

Pretty name of field server for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_VISIBILITY

public static final java.lang.String FIELD_VISIBILITY

Name of field visibility for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_VISIBILITY_PUBLIC

public static final java.lang.String FIELDL_VISIBILITY_PUBLIC

First possible values for visibility for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_VISIBILITY_PRIVATE

public static final java.lang.String FIELDL_VISIBILITY_PRIVATE

Second possible values for visibility for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_VISIBILITY

public static final java.lang.String FIELDL_VISIBILITY

List of possible values for visibility for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_VISIBILITY

public static final java.lang.String FIELDPN_VISIBILITY

Pretty name of field visibility for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_STATE

public static final java.lang.String FIELD_STATE

Name of field state for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_STATE_ACTIVE

public static final java.lang.String FIELDL_STATE_ACTIVE

First possible values for state for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_STATE_INACTIVE

public static final java.lang.String FIELDL_STATE_INACTIVE

Second possible values for state for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_STATE_LOCKED

public static final java.lang.String FIELDL_STATE_LOCKED

Third possible values for state for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_STATE

public static final java.lang.String FIELDL_STATE

List of possible values for state for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_STATE

public static final java.lang.String FIELDPN_STATE

Pretty name of field state for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_LANGUAGE

public static final java.lang.String FIELD_LANGUAGE

Name of field language for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDL_LANGUAGE

public static final java.lang.String FIELDL_LANGUAGE

List of possible values for language for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_LANGUAGE

public static final java.lang.String FIELDPN_LANGUAGE

Pretty name of field language for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELD_SECURE

public static final java.lang.String FIELD_SECURE

Name of field secure for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_SECURE

public static final java.lang.String FIELDPN_SECURE

Pretty name of field secure for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDDT_SECURE

public static final java.lang.String FIELDDT_SECURE

Display type of field secure for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

DEFAULT_SECURE

public static final java.lang.Boolean DEFAULT_SECURE

Default value of field secure for the XWiki class XWiki.XWikiServerClass.

FIELD_HOMEPAGE

public static final java.lang.String FIELD_HOMEPAGE

Name of field homepage for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_HOMEPAGE

public static final java.lang.String FIELDPN_HOMEPAGE

Pretty name of field homepage for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

DEFAULT_HOMEPAGE

public static final java.lang.String DEFAULT_HOMEPAGE

The full name of the default home page of a newly created wiki.

See Also:

Constant Field Values

FIELD_ISWIKITEMPLATE

public static final java.lang.String FIELD_ISWIKITEMPLATE

Name of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDPN_ISWIKITEMPLATE

public static final java.lang.String FIELDPN_ISWIKITEMPLATE

Pretty name of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

FIELDDT_ISWIKITEMPLATE

public static final java.lang.String FIELDDT_ISWIKITEMPLATE

Display type of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

DEFAULT_ISWIKITEMPLATE

public static final java.lang.Boolean DEFAULT_ISWIKITEMPLATE

Default value of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

FIELDDV_ISWIKITEMPLATE_INT

public static final int FIELDDV_ISWIKITEMPLATE_INT

Default value of field iswikitemplate for the XWiki class XWiki.XWikiServerClass.

See Also:

Constant Field Values

DEFAULT_PAGE_PARENT

public static final java.lang.String DEFAULT_PAGE_PARENT

The full name of the default parent of a newly created document.

See Also:

Constant Field Values

Constructor Detail

XWikiServerClass

protected XWikiServerClass()

Default constructor for XWikiServerClass.

Method Detail

getInstance

public static XWikiServerClass getInstance(XWikiContext context)
                                    throws XWikiException

Return unique instance of XWikiServerClass and update documents for this context.

Parameters:

context - Context.

Returns:

XWikiServerClass Instance of XWikiApplicationClass.

Throws:

XWikiException - error when checking for class, class template and class sheet.

forceValidDocumentName

public boolean forceValidDocumentName()

Specified by:

forceValidDocumentName in interface XClassManager<XWikiServer>

Overrides:

forceValidDocumentName in class AbstractXClassManager<XWikiServer>

See Also:

AbstractXClassManager.forceValidDocumentName()

check

protected void check(XWikiContext context)
              throws XWikiException

Overrides:

check in class AbstractXClassManager<XWikiServer>

Throws:

XWikiException

See Also:

AbstractXClassManager.check(com.xpn.xwiki.XWikiContext)

updateBaseClass

protected boolean updateBaseClass(com.xpn.xwiki.objects.classes.BaseClass baseClass)

Overrides:

updateBaseClass in class AbstractXClassManager<XWikiServer>

See Also:

util.AbstractXClassManager

updateClassTemplateDocument

protected boolean updateClassTemplateDocument(XWikiDocument doc)

Overrides:

updateClassTemplateDocument in class AbstractXClassManager<XWikiServer>

See Also:

AbstractXClassManager.updateClassTemplateDocument(com.xpn.xwiki.doc.XWikiDocument)

searchXObjectDocumentsByFields

public java.util.List<XWikiServer> searchXObjectDocumentsByFields(java.lang.Object[][] fieldDescriptors,
                                                                  XWikiContext context)
                                                           throws XWikiException

Make sure it return main wiki documents.

Overrides:

searchXObjectDocumentsByFields in class AbstractXClassManager<XWikiServer>

Throws:

XWikiException

Since:

1.5

See Also:

AbstractXClassManager.searchXObjectDocumentsByFields(java.lang.Object[][], com.xpn.xwiki.XWikiContext)

getWikiAlias

public XWikiServer getWikiAlias(java.lang.String wikiName,
                                int objectId,
                                boolean validate,
                                XWikiContext context)
                         throws XWikiException

Get wiki alias XWikiServer.

Parameters:

wikiName - the name of the wiki.

objectId - the id of the XWiki object included in the document to manage.

validate - indicate if it return new XWikiServer or throw exception if wiki descriptor does not exist.

context - the XWiki context.

Returns:

the XWikiServer representing wiki descriptor.

Throws:

XWikiException - error when searching for wiki descriptor document.

getWikiTemplateAlias

public XWikiServer getWikiTemplateAlias(java.lang.String wikiName,
                                        int objectId,
                                        boolean validate,
                                        XWikiContext context)
                                 throws XWikiException

Get wiki template alias XWikiServer.

Parameters:

wikiName - the name of the wiki.

objectId - the id of the XWiki object included in the document to manage.

context - the XWiki context.

validate - indicate if it return new XWikiServer or throw exception if wiki descriptor does not exist.

Returns:

the XWikiServer representing wiki descriptor.

Throws:

XWikiException - error when searching for wiki descriptor document.

getXObjectDocument

public XWikiServer getXObjectDocument(java.lang.String itemName,
                                      int objectId,
                                      boolean validate,
                                      XWikiContext context)
                               throws XWikiException

Specified by:

getXObjectDocument in interface XClassManager<XWikiServer>

Overrides:

getXObjectDocument in class AbstractXClassManager<XWikiServer>

Throws:

XWikiException

See Also:

AbstractXClassManager.getXObjectDocument(java.lang.String, int, boolean, com.xpn.xwiki.XWikiContext)

newXObjectDocument

public XWikiServer newXObjectDocument(XWikiDocument doc,
                                      int objId,
                                      XWikiContext context)
                               throws XWikiException

Override abstract method using XWikiApplication as XObjectDocument.

Specified by:

newXObjectDocument in interface XClassManager<XWikiServer>

Overrides:

newXObjectDocument in class AbstractXClassManager<XWikiServer>

Throws:

XWikiException

See Also:

AbstractXClassManager.newXObjectDocument(com.xpn.xwiki.doc.XWikiDocument, int, com.xpn.xwiki.XWikiContext)