com.xpn.xwiki.api

Class Object

java.lang.Object

com.xpn.xwiki.api.Api

com.xpn.xwiki.api.Element

com.xpn.xwiki.api.Collection

com.xpn.xwiki.api.Object

public class Object
extends Collection

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
Object(BaseObject obj, XWikiContext context)

Method Summary

Modifier and Type	Method and Description
Object	display(String name, String mode)
Object	display(String name, String mode, boolean isolate)
boolean	equals(Object arg0)
Object	get(String name) Display the passed field.
protected BaseObject	getBaseObject()
String	getGuid()
BaseObjectReference	getReference()
BaseObject	getXWikiObject()
void	set(String fieldname, Object value)
void	setGuid(String guid)

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

getCollection, getName, getNumber, getPrettyName, getProperties, getProperty, getPropertyNames, getValue, getxWikiClass

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

getBaseElement, getDocumentReference

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Object

public Object(BaseObject obj,
              XWikiContext context)

Method Detail

getBaseObject

protected BaseObject getBaseObject()

getXWikiObject

public BaseObject getXWikiObject()

getGuid

public String getGuid()

setGuid

public void setGuid(String guid)

get

public Object get(String name)

Display the passed field.

This method's name is misleading since it doesn't return the Object's property value; it"s equivalent to display(String, String) (with type equals to the context action ("view" or "edit" usually). The right method to get the field value is Collection.getValue(String).

display

public Object display(String name,
                      String mode)

display

public Object display(String name,
                      String mode,
                      boolean isolate)

Since:

13.0

equals

public boolean equals(Object arg0)

Overrides:

equals in class Object

set

public void set(String fieldname,
                Object value)

getReference

public BaseObjectReference getReference()

Overrides:

getReference in class Element

Returns:

the reference of the element