|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.AbstractXClassManager<XWikiApplication>
com.xpn.xwiki.plugin.applicationmanager.doc.XWikiApplicationClass
public class XWikiApplicationClass
XClassManager
implementation for
XAppClasses.XWikiApplicationClass class.
XClassManager
,
AbstractXClassManager
Field Summary | |
---|---|
static String |
DEFAULT_FIELDDT
Default list display type of XAppClasses.XWikiApplicationClass fields. |
static String |
DEFAULT_FIELDS
Default list separators of XAppClasses.XWikiApplicationClass fields. |
static String |
FIELD_APPAUTHORS
Name of field appauthors for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_APPLICATIONS
Name of field applications for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_APPNAME
Name of field appname for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_APPPRETTYNAME
Name of field appprettyname for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_APPVERSION
Name of field version for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_DEPENDENCIES
Name of field dependencies for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_DESCRIPTION
Name of field description for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_DOCSTOINCLUDE
Name of field docstoinclude for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_DOCSTOLINK
Name of field docstolink for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_DOCUMENTS
Name of field documents for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_LICENSE
Name of field license for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELD_TRANSLATIONDOCS
Name of field translationdocs for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_APPAUTHORS
Pretty name of field appauthors for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_APPLICATIONS
Pretty name of field applications for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_APPNAME
Pretty name of field appname for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_APPPRETTYNAME
Pretty name of field appprettyname for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_APPVERSION
Pretty name of field version for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_DEPENDENCIES
Pretty name of field dependencies for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_DESCRIPTION
Pretty name of field description for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_DOCSTOINCLUDE
Pretty name of field docstoinclude for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_DOCSTOLINK
Pretty name of field docstolink for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_DOCUMENTS
Pretty name of field documents for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_LICENSE
Pretty name of field license for the XWiki class XAppClasses.XWikiApplicationClass. |
static String |
FIELDPN_TRANSLATIONDOCS
Pretty name of field translationdocs for the XWiki class XAppClasses.XWikiApplicationClass. |
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 |
XWikiApplicationClass()
Construct the overload of AbstractXClassManager with spaceprefix= CLASS_SPACE_PREFIX and prefix=
CLASS_PREFIX . |
Method Summary | |
---|---|
XWikiApplication |
getApplication(String appName,
boolean validate,
XWikiContext context)
Get the XWiki document descriptor of containing XAppClasses.XWikiApplication XWiki object with "appname" field equals to appName . |
protected XWikiDocument |
getApplicationDocument(String appName,
XWikiContext context,
boolean validate)
Get the XWiki document descriptor of containing XAppClasses.XWikiApplication XWiki object with "appname" field equals to appName . |
static XWikiApplicationClass |
getInstance(XWikiContext context)
Return unique instance of XWikiApplicationClass and update documents for this context. |
static XWikiApplicationClass |
getInstance(XWikiContext context,
boolean check)
Return unique instance of XWikiApplicationClass and update documents for this context. |
static boolean |
isApplication(XWikiDocument doc)
Indicate if the provided document contains application descriptor. |
XWikiApplication |
newXObjectDocument(XWikiDocument doc,
int objId,
XWikiContext context)
Create new super document containing object of class XClassManager.getClassFullName() . |
protected boolean |
updateBaseClass(BaseClass baseClass)
Configure BaseClass. |
protected boolean |
updateClassTemplateDocument(XWikiDocument doc)
Initialize template document with default content. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_FIELDDT
public static final String DEFAULT_FIELDS
public static final String FIELD_APPNAME
appname
for the XWiki class XAppClasses.XWikiApplicationClass. The unique name of the
application.
public static final String FIELDPN_APPNAME
appname
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_APPPRETTYNAME
appprettyname
for the XWiki class XAppClasses.XWikiApplicationClass. The displayed
name of the application.
public static final String FIELDPN_APPPRETTYNAME
appprettyname
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_DESCRIPTION
description
for the XWiki class XAppClasses.XWikiApplicationClass. The description of
the application.
public static final String FIELDPN_DESCRIPTION
description
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_APPVERSION
version
for the XWiki class XAppClasses.XWikiApplicationClass. The version of the
application.
public static final String FIELDPN_APPVERSION
version
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_APPAUTHORS
appauthors
for the XWiki class XAppClasses.XWikiApplicationClass. The description of
the application.
public static final String FIELDPN_APPAUTHORS
appauthors
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_LICENSE
license
for the XWiki class XAppClasses.XWikiApplicationClass. The description of the
application.
public static final String FIELDPN_LICENSE
license
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_DEPENDENCIES
dependencies
for the XWiki class XAppClasses.XWikiApplicationClass. The list of
plugins on which application depends.
public static final String FIELDPN_DEPENDENCIES
dependencies
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_APPLICATIONS
applications
for the XWiki class XAppClasses.XWikiApplicationClass. The list of other
applications on which current application depends.
public static final String FIELDPN_APPLICATIONS
applications
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_DOCUMENTS
documents
for the XWiki class XAppClasses.XWikiApplicationClass. The list of documents
application contains.
public static final String FIELDPN_DOCUMENTS
documents
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_DOCSTOINCLUDE
docstoinclude
for the XWiki class XAppClasses.XWikiApplicationClass. The list of
document application contains that will be included in place of copy from wiki template.
public static final String FIELDPN_DOCSTOINCLUDE
docstoinclude
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_DOCSTOLINK
docstolink
for the XWiki class XAppClasses.XWikiApplicationClass. The list of document
application contains that will be linked in place of copy from wiki template.
public static final String FIELDPN_DOCSTOLINK
docstolink
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELD_TRANSLATIONDOCS
translationdocs
for the XWiki class XAppClasses.XWikiApplicationClass.
public static final String FIELDPN_TRANSLATIONDOCS
translationdocs
for the XWiki class XAppClasses.XWikiApplicationClass.
Constructor Detail |
---|
protected XWikiApplicationClass()
CLASS_SPACE_PREFIX
and prefix=
CLASS_PREFIX
.
Method Detail |
---|
public static XWikiApplicationClass getInstance(XWikiContext context, boolean check) throws XWikiException
context
- the XWiki context.check
- indicate if class existence has to be checked in the wiki.
XWikiException
- error when checking for class, class template and class sheet.public static XWikiApplicationClass getInstance(XWikiContext context) throws XWikiException
context
- the XWiki context.
XWikiException
- error when checking for class, class template and class sheet.public static boolean isApplication(XWikiDocument doc)
doc
- the document.
protected boolean updateBaseClass(BaseClass baseClass)
AbstractXClassManager
updateBaseClass
in class AbstractXClassManager<XWikiApplication>
baseClass
- the baseClass to configure.
baseClass
modified.protected boolean updateClassTemplateDocument(XWikiDocument doc)
AbstractXClassManager
updateClassTemplateDocument
in class AbstractXClassManager<XWikiApplication>
doc
- the class template document that will be saved.
doc
modified.protected XWikiDocument getApplicationDocument(String appName, XWikiContext context, boolean validate) throws XWikiException
appName
.
appName
- the name of the application.context
- the XWiki context.validate
- indicate if it return new XWikiDocument
or throw exception if application descriptor does
not exist.
XWikiDocument
representing application descriptor.
XWikiException
- error when searching for application descriptor document.#getApplication(String, XWikiContext, boolean)
public XWikiApplication getApplication(String appName, boolean validate, XWikiContext context) throws XWikiException
appName
.
appName
- the name of the application.context
- the XWiki context.validate
- indicate if it return new XWikiDocument or throw exception if application descriptor does not
exist.
XWikiException
- error when searching for application descriptor document.getApplicationDocument(String, XWikiContext, boolean)
public XWikiApplication newXObjectDocument(XWikiDocument doc, int objId, XWikiContext context) throws XWikiException
XClassManager
XClassManager.getClassFullName()
. If document already exist it is
returned with new object if it does not contains any.
newXObjectDocument
in interface XClassManager<XWikiApplication>
newXObjectDocument
in class AbstractXClassManager<XWikiApplication>
doc
- the XWiki document to manage.objId
- the id of the XWiki object included in the document to manage.context
- the XWiki context.
XWikiException
- error when calling XObjectDocument implementation constructor.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |