com.xpn.xwiki.api

Class Collection

java.lang.Object

com.xpn.xwiki.api.Api

com.xpn.xwiki.api.Element

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

Constructors

Constructor and Description
Collection(BaseCollection collection, XWikiContext context)

Method Summary

Modifier and Type	Method and Description
protected BaseCollection	getCollection()
String	getName() Get the name of this element.
int	getNumber()
String	getPrettyName()
Element[]	getProperties()
Property	getProperty(String name)
Object[]	getPropertyNames()
Object	getValue(String name)
Class	getxWikiClass()

Methods inherited from class com.xpn.xwiki.api.Element

getBaseElement, getDocumentReference, getReference

Methods inherited from class com.xpn.xwiki.api.Api

convert, convert, convert, convertAttachments, getAuthorizationManager, getContextualAuthorizationManager, getXWikiContext, hasAccess, 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(BaseCollection collection,
                  XWikiContext context)

Method Detail

getCollection

protected 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 Object then it will be the name of the Document containing the Object, if it's an XWiki Class it will be the full name of the Document where the class is defined, if it's an XWiki 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)

getValue

public Object getValue(String name)

Parameters:

name - the name of the property

Returns:

the value of the passed property

Since:

6.2