com.xpn.xwiki.api
Class Element

java.lang.Object
  extended by com.xpn.xwiki.api.Api
      extended by com.xpn.xwiki.api.Element
Direct Known Subclasses:
Collection, Property

public class Element
extends Api

Element is a superclass for any XWiki Class, Object, or Property which might be stored in the database.

Version:
$Id$

Field Summary
protected  com.xpn.xwiki.objects.BaseElement element
          The internal element which this wraps.
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
Element(com.xpn.xwiki.objects.BaseElement element, com.xpn.xwiki.XWikiContext context)
          The Constructor.
 
Method Summary
protected  com.xpn.xwiki.objects.BaseElement getBaseElement()
           
 String getName()
          Get the name of this element.
 
Methods inherited from class com.xpn.xwiki.api.Api
convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

element

protected com.xpn.xwiki.objects.BaseElement element
The internal element which this wraps.

Constructor Detail

Element

public Element(com.xpn.xwiki.objects.BaseElement element,
               com.xpn.xwiki.XWikiContext context)
The Constructor. Create a new element wrapping the given internal BaseElement.

Parameters:
element - the internal BaseElement to wrap.
context - the XWikiContext which may be used to get information about the current request.
Method Detail

getBaseElement

protected com.xpn.xwiki.objects.BaseElement getBaseElement()
Returns:
the internal BaseElement which this Element wraps.

getName

public String getName()
Get the name of this element. If the Element is an XWiki com.xon.xwiki.api.Object then it will be the name of the Document containing the Object, if it's an XWiki com.xon.xwiki.api.Class it will be the full name of the com.xon.xwiki.api.Document where the class is defined, if it's an XWiki com.xon.xwiki.api.Property then it will be the name of the property.

Returns:
the name of this Element.


Copyright © 2004-2012 XWiki. All Rights Reserved.