| org.sakaiproject.entity.api.Entity
All known Subclasses: org.sakaiproject.chat2.model.ChatChannel, org.sakaiproject.chat2.model.ChatMessage,
| Entity | | public interface Entity (Code) | |
Entity is the generic interface for all information units modeled in Sakai.
|
| Method Summary | |
| String | getId()
Access the id of the entity. | | ResourceProperties | getProperties()
Access the entity's properties. | | String | getReference()
Access the internal reference which can be used to access the entity from within the system. | | String | getReference(String rootProperty)
Access the alternate internal reference which can be used to access the entity from within the system.
Parameters:
rootProperty - The name of the entity property whose value controls which alternate reference is requested. | | String | getUrl()
Access the URL which can be used to access the entity. | | String | getUrl(String rootProperty)
Access the alternate URL which can be used to access the entity.
Parameters:
rootProperty - The name of the entity property whose value controls which alternate reference URL is requested. | | Element | toXml(Document doc, Stack stack)
Serialize the entity into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "entity" element. |
| SEPARATOR | | final static String SEPARATOR(Code) | | The character used to separate names in the region address path
|
| getId | | String getId()(Code) | | Access the id of the entity.
The id. |
| getReference | | String getReference()(Code) | | Access the internal reference which can be used to access the entity from within the system.
The the internal reference which can be used to access the entity from within the system. |
| getReference | | String getReference(String rootProperty)(Code) | | Access the alternate internal reference which can be used to access the entity from within the system.
Parameters:
rootProperty - The name of the entity property whose value controls which alternate reference is requested. If null, the native 'raw' reference is requested. The the alternate internal reference which can be used to access the entity from within the system. |
| getUrl | | String getUrl()(Code) | | Access the URL which can be used to access the entity.
The URL which can be used to access the entity. |
| getUrl | | String getUrl(String rootProperty)(Code) | | Access the alternate URL which can be used to access the entity.
Parameters:
rootProperty - The name of the entity property whose value controls which alternate reference URL is requested. If null, the native 'raw' URL is requested. The alternate URL which can be used to access the entity. |
| toXml | | Element toXml(Document doc, Stack stack)(Code) | | Serialize the entity into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "entity" element. The newly added element. |
|
|