com.jalios.rest.client
Class Relateds

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.AbstractSequentialList<E>
              java.util.LinkedList<String>
                  com.jalios.rest.client.Relateds

All Implemented Interfaces:

Serializable, Cloneable, Iterable<String>, Collection<String>, List<String>, Queue<String>

public class Relateds
extends LinkedList<String>

The relateds are specific fields in data not corresponding to persisted attributes, but possibly get from getters. If a related is present as a parameter in the query String, the corresponding accessor in the data may be invoqued and the result is included in the xml result in a related tag. Example : for a call to /rest/data/j_2?related=dataImage we would have : <data class="com.jalios.jcms.Member" id="j_2" url="jcms/j_2/admin"> <field name="author" id="j_2" class="com.jalios.jcms.Member" login="admin">Admin</field> <field name="opAuthor" id="j_2" class="com.jalios.jcms.Member" login="admin">Admin</field> <field name="cdate">2004-08-03T11:40:19+02:00</field> <field name="mdate">2009-04-20T16:35:39+02:00</field> <field name="login">admin</field> <field name="name">Admin</field> <field name="email">admin@company.com</field> <field name="isEmailVisible">false</field> <field name="info">Administrator</field> <field name="declaredGroups"> <item id="j_1" class="com.jalios.jcms.Group">Administrators</item> </field> <field name="isAdmin">true</field> <field name="useCategoryMode">0</field> <field name="language">fr</field> <field name="webdavAccess">true</field> <related name="dataImage">upload/photos/2009-04/mbr_j_2.jpg</related> </data>

Since:

JCMS-6.1

Author:

dissert

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Relateds()

Relateds(String[] relatedsKeys)

Method Summary

void	addAllReferrerSet()
void	addAllReferrerSet(String className)
void	addChildrenSet()
void	addDataImage()
void	addExtraData(String extraDataName)
void	addExtraDBData(String extraDBDataName)
void	addExtraInfo(String extraInfoName)
void	addLinkCount()
void	addLinkIndexedDataSet(String className)
void	addLinkIndexedDataSet(String className, String fieldName)
void	addLockDate()
void	addLockMember()
void	addMemberCategoryRootSet()
void	addVirtualID()
void	addWorkspaceSet()
org.jdom.Element	getAllReferrerSet()
org.jdom.Element	getAllReferrerSet(String className)
org.jdom.Element	getChildrenSet()
String	getDataImage()
String	getExtraData(String extraDataName)
String	getExtraDBData(String extraDBDataName)
org.jdom.Element	getExtraInfo(String extraInfoName)
int	getLinkCount()
org.jdom.Element	getLinkIndexedDataSet(String className)
org.jdom.Element	getLinkIndexedDataSet(String className, String fieldName)
Date	getLockDate()
String	getLockMemberId()
org.jdom.Element	getMemberCategoryRootSet()
String	getVirtualID()
org.jdom.Element	getWorkspaceSet()

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, peek, poll, remove, remove, remove, removeFirst, removeLast, set, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, retainAll, subList

Constructor Detail

Relateds

public Relateds()

Relateds

public Relateds(String[] relatedsKeys)

Method Detail

addExtraData

public void addExtraData(String extraDataName)

addExtraDBData

public void addExtraDBData(String extraDBDataName)

addExtraInfo

public void addExtraInfo(String extraInfoName)

addDataImage

public void addDataImage()

addLinkCount

public void addLinkCount()

addLockDate

public void addLockDate()

addVirtualID

public void addVirtualID()

addAllReferrerSet

public void addAllReferrerSet()

addAllReferrerSet

public void addAllReferrerSet(String className)

addLinkIndexedDataSet

public void addLinkIndexedDataSet(String className)

addLinkIndexedDataSet

public void addLinkIndexedDataSet(String className,
                                  String fieldName)

addLockMember

public void addLockMember()

getExtraData

public String getExtraData(String extraDataName)

getExtraDBData

public String getExtraDBData(String extraDBDataName)

getExtraInfo

public org.jdom.Element getExtraInfo(String extraInfoName)

getDataImage

public String getDataImage()

getLinkCount

public int getLinkCount()

getLockDate

public Date getLockDate()

getVirtualID

public String getVirtualID()

getAllReferrerSet

public org.jdom.Element getAllReferrerSet()

getAllReferrerSet

public org.jdom.Element getAllReferrerSet(String className)

getLinkIndexedDataSet

public org.jdom.Element getLinkIndexedDataSet(String className)

getLinkIndexedDataSet

public org.jdom.Element getLinkIndexedDataSet(String className,
                                              String fieldName)

getLockMemberId

public String getLockMemberId()

addWorkspaceSet

public void addWorkspaceSet()

getWorkspaceSet

public org.jdom.Element getWorkspaceSet()

addMemberCategoryRootSet

public void addMemberCategoryRootSet()

getMemberCategoryRootSet

public org.jdom.Element getMemberCategoryRootSet()

addChildrenSet

public void addChildrenSet()

getChildrenSet

public org.jdom.Element getChildrenSet()