org.rapla.facade
Interface ModificationModule

All Known Subinterfaces:

ClientFacade

public interface ModificationModule

All methods that allow modifing the entity-objects.

Version:

CVS $Revision: 1.50 $ $Date: 2006/01/08 14:43:14 $

Method Summary

void	checkReservation(Reservation reservation) check if the reservation can be saved
Entity	clone(Entity obj) Clones an entity.
Entity	edit(Entity obj) This call will be delegated to the StorageOperator.
Entity	getPersistant(Entity working) Returns the persistant version of a working copy.
Appointment	newAppointment(Date startDate, Date endDate)
Attribute	newAttribute(AttributeType attributeType)
Category	newCategory()
DynamicType	newDynamicType(String classificationType)
Period	newPeriod()
Allocatable	newPerson()
CalendarModelConfiguration	newRaplaCalendarModel(RaplaMap selected, ClassificationFilter[] filter, String title, Date startDate, Date endDate, Date selectedDate, String view) WARNING!
RaplaMap	newRaplaMap(Collection col)
RaplaMap	newRaplaMap(Map map)
Reservation	newReservation()
Allocatable	newResource()
User	newUser()
void	remove(Entity obj)
void	removeObjects(Entity[] obj) This call will be delegated to the StorageOperator
void	store(Entity obj)
void	storeAndRemove(Entity[] storedObjects, Entity[] removedObjects) stores and removes objects in the one transaction
void	storeObjects(Entity[] obj) This call will be delegated to the StorageOperator

Method Detail

checkReservation

void checkReservation(Reservation reservation)
                      throws RaplaException

check if the reservation can be saved

Throws:

RaplaException

newRaplaMap

RaplaMap newRaplaMap(Map map)

newRaplaMap

RaplaMap newRaplaMap(Collection col)

newRaplaCalendarModel

CalendarModelConfiguration newRaplaCalendarModel(RaplaMap selected,
                                                 ClassificationFilter[] filter,
                                                 String title,
                                                 Date startDate,
                                                 Date endDate,
                                                 Date selectedDate,
                                                 String view)

WARNING! API could change for this method

newReservation

Reservation newReservation()
                           throws RaplaException

Throws:

RaplaException

newAppointment

Appointment newAppointment(Date startDate,
                           Date endDate)
                           throws RaplaException

Throws:

RaplaException

newResource

Allocatable newResource()
                        throws RaplaException

Throws:

RaplaException

newPerson

Allocatable newPerson()
                      throws RaplaException

Throws:

RaplaException

newPeriod

Period newPeriod()
                 throws RaplaException

Throws:

RaplaException

newCategory

Category newCategory()
                     throws RaplaException

Throws:

RaplaException

newAttribute

Attribute newAttribute(AttributeType attributeType)
                       throws RaplaException

Throws:

RaplaException

newDynamicType

DynamicType newDynamicType(String classificationType)
                           throws RaplaException

Throws:

RaplaException

newUser

User newUser()
             throws RaplaException

Throws:

RaplaException

clone

Entity clone(Entity obj)
             throws RaplaException

Clones an entity. The entities will get new identifier and won't be equal to the original. The resulting object is not persistant and therefore can be editet.

Throws:

RaplaException

edit

Entity edit(Entity obj)
            throws RaplaException

This call will be delegated to the StorageOperator. It returns an editable working copy of an object. Only objects return by this method and new objects are editable. To get the persistant, non-editable version of a working copy use getPersistant(org.rapla.entities.Entity)

Throws:

RaplaException

getPersistant

Entity getPersistant(Entity working)
                     throws RaplaException

Returns the persistant version of a working copy. Throws an EntityNotFoundException when the object is not found

Throws:

RaplaException

See Also:

edit(org.rapla.entities.Entity), clone(org.rapla.entities.Entity)

storeObjects

void storeObjects(Entity[] obj)
                  throws RaplaException

This call will be delegated to the StorageOperator

Throws:

RaplaException

store

void store(Entity obj)
           throws RaplaException

Throws:

RaplaException

See Also:

storeObjects(Entity[])

removeObjects

void removeObjects(Entity[] obj)
                   throws RaplaException

This call will be delegated to the StorageOperator

Throws:

RaplaException

remove

void remove(Entity obj)
            throws RaplaException

Throws:

RaplaException

See Also:

removeObjects(Entity[])

storeAndRemove

void storeAndRemove(Entity[] storedObjects,
                    Entity[] removedObjects)
                    throws RaplaException

stores and removes objects in the one transaction

Throws:

RaplaException