org.sakaiproject.component.app.syllabus
Class SyllabusServiceImpl.BaseResourceEdit

java.lang.Object
  extended byorg.sakaiproject.component.app.syllabus.SyllabusServiceImpl.BaseResourceEdit
All Implemented Interfaces:
Edit, Entity
Enclosing class:
SyllabusServiceImpl

public class SyllabusServiceImpl.BaseResourceEdit
extends Object
implements Entity, Edit


Field Summary
protected  boolean m_active
           
protected  boolean m_bodyUpdated
           
protected  SyllabusData m_data
           
protected  String m_event
           
protected  String m_id
           
protected  boolean m_isRemoved
           
protected  ResourcePropertiesEdit m_properties
           
protected  String m_reference
           
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Constructor Summary
SyllabusServiceImpl.BaseResourceEdit(String id, SyllabusData data)
           
 
Method Summary
protected  void activate()
           
protected  void closeEdit()
           
protected  String getEvent()
           
 String getId()
          Access the id of the entity.
 ResourceProperties getProperties()
          Access the entity's properties.
 ResourcePropertiesEdit getPropertiesEdit()
          Access the resource's properties for modification
 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.
 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.
 boolean isActiveEdit()
          Check to see if the edit is still active, or has already been closed.
protected  void setEvent(String event)
           
 Element toXml(Document doc, Stack stack)
          Serialize the entity into XML, adding an element to the doc under the top of the stack element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_id

protected String m_id

m_event

protected String m_event

m_active

protected boolean m_active

m_isRemoved

protected boolean m_isRemoved

m_bodyUpdated

protected boolean m_bodyUpdated

m_properties

protected ResourcePropertiesEdit m_properties

m_reference

protected String m_reference

m_data

protected SyllabusData m_data
Constructor Detail

SyllabusServiceImpl.BaseResourceEdit

public SyllabusServiceImpl.BaseResourceEdit(String id,
                                            SyllabusData data)
Method Detail

getUrl

public String getUrl()
Description copied from interface: Entity
Access the URL which can be used to access the entity.

Specified by:
getUrl in interface Entity
Returns:
The URL which can be used to access the entity.

getReference

public String getReference()
Description copied from interface: Entity
Access the internal reference which can be used to access the entity from within the system.

Specified by:
getReference in interface Entity
Returns:
The the internal reference which can be used to access the entity from within the system.

getReference

public String getReference(String rootProperty)
Description copied from interface: Entity
Access the alternate internal reference which can be used to access the entity from within the system.

Specified by:
getReference in interface Entity
Parameters:
rootProperty - The name of the entity property whose value controls which alternate reference is requested. If null, the native 'raw' reference is requested.
Returns:
The the alternate internal reference which can be used to access the entity from within the system.

getUrl

public String getUrl(String rootProperty)
Description copied from interface: Entity
Access the alternate URL which can be used to access the entity.

Specified by:
getUrl in interface 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.
Returns:
The alternate URL which can be used to access the entity.

getId

public String getId()
Description copied from interface: Entity
Access the id of the entity.

Specified by:
getId in interface Entity
Returns:
The id.

getProperties

public ResourceProperties getProperties()
Description copied from interface: Entity
Access the entity's properties.

Specified by:
getProperties in interface Entity
Returns:
The entity's properties.

toXml

public Element toXml(Document doc,
                     Stack stack)
Description copied from interface: Entity
Serialize the entity into XML, adding an element to the doc under the top of the stack element.

Specified by:
toXml in interface Entity
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
stack - The DOM elements, the top of which is the containing element of the new "entity" element.
Returns:
The newly added element.

isActiveEdit

public boolean isActiveEdit()
Description copied from interface: Edit
Check to see if the edit is still active, or has already been closed.

Specified by:
isActiveEdit in interface Edit
Returns:
true if the edit is active, false if it's been closed.

getPropertiesEdit

public ResourcePropertiesEdit getPropertiesEdit()
Description copied from interface: Edit
Access the resource's properties for modification

Specified by:
getPropertiesEdit in interface Edit
Returns:
The resource's properties.

closeEdit

protected void closeEdit()

activate

protected void activate()

getEvent

protected String getEvent()

setEvent

protected void setEvent(String event)