| org.openharmonise.rm.resources.lifecycle.Editable
All known Subclasses: org.openharmonise.rm.resources.publishing.WebPage, org.openharmonise.rm.resources.content.Asset, org.openharmonise.rm.resources.users.UserGroup, org.openharmonise.rm.resources.metadata.properties.Property, org.openharmonise.rm.resources.AbstractProfiledObject, org.openharmonise.rm.resources.AbstractEditableObject, org.openharmonise.rm.resources.metadata.values.Value, org.openharmonise.rm.resources.metadata.properties.PropertyGroup, org.openharmonise.rm.resources.AbstractChildObject, org.openharmonise.rm.resources.metadata.values.ValueGroup, org.openharmonise.rm.resources.publishing.Template, org.openharmonise.rm.tasks.Task, org.openharmonise.rm.resources.xml.XMLResource, org.openharmonise.rm.resources.content.Document, org.openharmonise.rm.resources.AbstractParentObject, org.openharmonise.rm.resources.content.Section, org.openharmonise.rm.resources.users.User,
| Editable | | public interface Editable (Code) | | The Editable interface provides for objects which can be edited
within a versioning system.
author:
Michael Bell
version:
$Revision: 1.2 $ |
| addEditEventListener | | public void addEditEventListener(EditEventListener listener)(Code) | | Adds a listener to receive edit events when the object has been edited.
Parameters:
listener - |
| archive | | public Editable archive() throws EditException(Code) | | Archives this object in to the store of historical objects.
The archived object |
| changeStatus | | public Editable changeStatus(Status nStatus) throws EditException(Code) | | Alters the status of this object to the given status.
Parameters:
nStatus - The new Status The new version of this object of the given status |
| createNewVersion | | public Editable createNewVersion() throws EditException(Code) | | Returns a new version of this editable object, if the current version is a live
version, otherwise is returns the current object.
throws:
EditException - |
| getHistoricalVersions | | public List getHistoricalVersions() throws DataAccessException(Code) | | Gets all of the historical versions of this object.
If this is an historical document, gets all of the versions that are older than this one
Vector All of the historical versions |
| getPendingVersions | | public List getPendingVersions() throws DataAccessException(Code) | | Gets all of the unnaproved versions of this object.
Vector All of the unapproved versions |
| lock | | public void lock(User usr) throws EditException(Code) | | Locks this object, its unapproved versions and live version if exist.
Checks that user id matches lock id, if already locked do nothing.
Parameters:
nUserId -
throws:
EditException - if object locked by another user. |
| removeEditEventListener | | public void removeEditEventListener(EditEventListener listener)(Code) | | Removes a edit event listener.
Parameters:
listener - |
| save | | public Editable save() throws EditException(Code) | | Saves current data to data store. If the object being saved is a live version
and data has been changed, a new unapproved version is created. This method will
return the result of the save operation, i.e. if it is an unapproved object the
orginal object will be returned, otherwise the newly created unapproved version
will be returned.
throws:
EditException - |
| unlock | | public void unlock(User usr) throws EditException(Code) | | Unlocks this object, its unapproved versions and parent if exist.
Check that user id matches lock id or that user has permisssion to perform the
unlock, if unlocked do nothing.
Parameters:
nUserId -
throws:
EditException - if user id does not match lock id |
|
|