com.xpn.xwiki.api
Class Collection

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

public abstract class Collection
extends Element


Field Summary
 
Fields inherited from class com.xpn.xwiki.api.Element
element
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
Collection(com.xpn.xwiki.objects.BaseCollection collection, com.xpn.xwiki.XWikiContext context)
           
 
Method Summary
protected  com.xpn.xwiki.objects.BaseCollection getCollection()
           
 String getName()
          Get the name of this element.
 int getNumber()
           
 String getPrettyName()
           
 Element[] getProperties()
           
 Property getProperty(String name)
           
 Object[] getPropertyNames()
           
 Class getxWikiClass()
           
 
Methods inherited from class com.xpn.xwiki.api.Element
getBaseElement
 
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
 

Constructor Detail

Collection

public Collection(com.xpn.xwiki.objects.BaseCollection collection,
                  com.xpn.xwiki.XWikiContext context)
Method Detail

getCollection

protected com.xpn.xwiki.objects.BaseCollection getCollection()

getxWikiClass

public Class getxWikiClass()

getName

public String getName()
Description copied from class: Element
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.

Overrides:
getName in class Element
Returns:
the name of this Element.

getPrettyName

public String getPrettyName()

getNumber

public int getNumber()

getPropertyNames

public Object[] getPropertyNames()

getProperties

public Element[] getProperties()

getProperty

public Property getProperty(String name)


Copyright © 2004-2012 XWiki. All Rights Reserved.