|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.objects.BaseElement<R>
com.xpn.xwiki.objects.BaseCollection<BaseObjectReference>
com.xpn.xwiki.objects.BaseObject
public class BaseObject
Field Summary |
---|
Fields inherited from class com.xpn.xwiki.objects.BaseCollection |
---|
currentReferenceDocumentReferenceResolver, fields, fieldsToRemove, number, relativeEntityReferenceResolver |
Fields inherited from class com.xpn.xwiki.objects.BaseElement |
---|
localEntityReferenceSerializer, referenceCache |
Constructor Summary | |
---|---|
BaseObject()
|
Method Summary | |
---|---|
BaseObject |
clone()
|
protected BaseObjectReference |
createReference()
|
void |
displayEdit(StringBuffer buffer,
String name,
String prefix,
XWikiContext context)
|
String |
displayEdit(String name,
String prefix,
XWikiContext context)
|
String |
displayEdit(String name,
XWikiContext context)
|
void |
displayHidden(StringBuffer buffer,
String name,
String prefix,
XWikiContext context)
|
String |
displayHidden(String name,
String prefix,
XWikiContext context)
|
String |
displayHidden(String name,
XWikiContext context)
|
void |
displayView(StringBuffer buffer,
String name,
String prefix,
XWikiContext context)
|
String |
displayView(String name,
String prefix,
XWikiContext context)
|
String |
displayView(String name,
XWikiContext context)
|
BaseObject |
duplicate()
Similar to clone() but whereas a clone is an exact copy (with the same GUID), a duplicate keeps the same
data but with a different identity. |
BaseObject |
duplicate(DocumentReference documentReference)
|
boolean |
equals(Object obj)
|
void |
fromXML(org.dom4j.Element oel)
|
List<ObjectDiff> |
getDiff(Object oldEntity,
XWikiContext context)
|
String |
getGuid()
|
String |
getName()
Deprecated. since 2.2M2 use BaseElement.getDocumentReference() |
Object |
newObjectApi(BaseObject obj,
XWikiContext context)
|
void |
set(String fieldname,
Object value,
XWikiContext context)
|
void |
setGuid(String guid)
|
void |
setName(String name)
Deprecated. since 2.2M2 use BaseCollection.setDocumentReference(org.xwiki.model.reference.DocumentReference) |
void |
setNumber(int number)
|
void |
setOwnerDocument(XWikiDocument ownerDocument)
Set the owner document of this base object. |
void |
setXClassReference(EntityReference xClassReference)
Set the reference to the XClass (used for an XObject). |
org.dom4j.Element |
toXML(BaseClass bclass)
|
Methods inherited from class com.xpn.xwiki.objects.BaseElement |
---|
getDocumentReference, getId, getLocalKey, getLocalUidStringEntityReferenceSerializer, getPrettyName, getReference, hashCode, setId, setPrettyName |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.xpn.xwiki.objects.ObjectInterface |
---|
get, getXClass, put, safeget, safeput |
Methods inherited from interface com.xpn.xwiki.objects.ElementInterface |
---|
apply, getDocumentReference, getReference, merge, setDocumentReference, toString |
Constructor Detail |
---|
public BaseObject()
Method Detail |
---|
@Deprecated public String getName()
BaseElement.getDocumentReference()
Note: This method is overridden to add the deprecation warning so that code using it can see it's deprecated.
getName
in interface ElementInterface
getName
in class BaseElement<BaseObjectReference>
BaseProperty
).ElementInterface.getName()
@Deprecated public void setName(String name)
BaseCollection.setDocumentReference(org.xwiki.model.reference.DocumentReference)
Note: BaseElement.setName() does not support setting reference anymore since 2.4M2.
setName
in interface ElementInterface
setName
in class BaseCollection<BaseObjectReference>
ElementInterface.setName(java.lang.String)
protected BaseObjectReference createReference()
createReference
in class BaseElement<BaseObjectReference>
public void setNumber(int number)
setNumber
in class BaseCollection<BaseObjectReference>
public void setXClassReference(EntityReference xClassReference)
BaseCollection
Note that absolute reference are not supported for xclasses which mean that the wiki part (whatever the wiki is) of the reference will be systematically removed.
setXClassReference
in class BaseCollection<BaseObjectReference>
xClassReference
- the reference to the XClass of this XObject.public void displayHidden(StringBuffer buffer, String name, String prefix, XWikiContext context)
public void displayView(StringBuffer buffer, String name, String prefix, XWikiContext context)
public void displayEdit(StringBuffer buffer, String name, String prefix, XWikiContext context)
public String displayHidden(String name, String prefix, XWikiContext context)
public String displayView(String name, String prefix, XWikiContext context)
public String displayEdit(String name, String prefix, XWikiContext context)
public String displayHidden(String name, XWikiContext context)
public String displayView(String name, XWikiContext context)
public String displayEdit(String name, XWikiContext context)
public BaseObject clone()
clone
in class BaseCollection<BaseObjectReference>
public BaseObject duplicate()
clone()
but whereas a clone is an exact copy (with the same GUID), a duplicate keeps the same
data but with a different identity.
public BaseObject duplicate(DocumentReference documentReference)
public boolean equals(Object obj)
equals
in class BaseCollection<BaseObjectReference>
public org.dom4j.Element toXML(BaseClass bclass)
toXML
in interface ObjectInterface
toXML
in class BaseCollection<BaseObjectReference>
public void fromXML(org.dom4j.Element oel) throws XWikiException
XWikiException
public List<ObjectDiff> getDiff(Object oldEntity, XWikiContext context)
getDiff
in class BaseCollection<BaseObjectReference>
public Object newObjectApi(BaseObject obj, XWikiContext context)
public void set(String fieldname, Object value, XWikiContext context)
public String getGuid()
public void setGuid(String guid)
public void setOwnerDocument(XWikiDocument ownerDocument)
ownerDocument
- The owner document.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |