com.xpn.xwiki.objects
Class BaseElement

java.lang.Object
  com.xpn.xwiki.objects.BaseElement

All Implemented Interfaces:

ElementInterface, java.io.Serializable

Direct Known Subclasses:

BaseCollection, BaseProperty

public abstract class BaseElement
extends java.lang.Object
implements ElementInterface, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

BaseElement()

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object el)
java.lang.String	getDocumentSyntaxId(XWikiContext context)
java.lang.String	getName()
java.lang.String	getPrettyName()
java.lang.String	getWiki()
void	setName(java.lang.String name)
void	setPrettyName(java.lang.String name)
void	setWiki(java.lang.String wiki)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xpn.xwiki.objects.ElementInterface

toString

Constructor Detail

BaseElement

public BaseElement()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface ElementInterface

See Also:

ElementInterface.getName()

setName

public void setName(java.lang.String name)

Specified by:

setName in interface ElementInterface

See Also:

ElementInterface.setName(java.lang.String)

getPrettyName

public java.lang.String getPrettyName()

setPrettyName

public void setPrettyName(java.lang.String name)

getWiki

public java.lang.String getWiki()

Returns:

the name of the wiki where this element is stored. If null, the context's wiki is used.

setWiki

public void setWiki(java.lang.String wiki)

Parameters:

wiki - the name of the wiki where this element is stored. If null, the context's wiki is used.

equals

public boolean equals(java.lang.Object el)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

getDocumentSyntaxId

public java.lang.String getDocumentSyntaxId(XWikiContext context)

Returns:

the syntax id of the document containing this element. If an error occurs while retrieving the document a syntax id of "xwiki/1.0" is assumed.