org.sakaiproject.entitybroker.entityprovider.capabilities

Interface Deleteable

All Superinterfaces:

EntityProvider

All Known Subinterfaces:

CRUDable, RESTful

public interface Deleteable
extends EntityProvider

This entity type can be deleted (this is the D in CRUD), the current user id should be used for permissions checking in most cases
This is one of the capability extensions for the EntityProvider interface

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Method Summary

Modifier and Type	Method and Description
void	deleteEntity(EntityReference ref, Map<String,Object> params) Deletes the entity identified by this entity reference, if the entity cannot be found then nothing happens

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

Method Detail

deleteEntity

void deleteEntity(EntityReference ref,
                  Map<String,Object> params)

Deletes the entity identified by this entity reference, if the entity cannot be found then nothing happens

Parameters:

ref - the parsed reference object which uniquely represents this entity

params - (optional) incoming set of parameters which may be used to send data specific to this request, may be null

Throws:

SecurityException - if permissions prevented this entity from being created

IllegalStateException - for all other failures