org.kuali.student.r2.common.dao

Interface EntityDao<K extends Serializable,T extends PersistableEntity<K>>

All Known Subinterfaces:

ActivityOfferingClusterDaoApi, CourseWaitListDaoApi, SeatPoolDefinitionDaoApi

All Known Implementing Classes:

ActivityOfferingClusterDao, AppliedHoldDao, AppointmentDao, AppointmentSlotDao, AppointmentWindowDao, AtpAtpRelationDao, AtpDao, AtpMilestoneRelationDao, BuildingServiceDao, CheckDao, CodeGeneratorLocksDao, CommentDao, CourseWaitListDao, CourseWaitListEntryDao, EnrollmentFeeDao, EnumContextValueDao, EnumeratedValueDao, EnumerationDao, ExtendedOrgDao, GenericEntityDao, HoldIssueDao, InstructionDao, LifecycleDao, LprDao, LprRosterDao, LprRosterEntryDao, LprTransactionDao, LprTransactionItemDao, LrrDao, LuiDao, LuiLuiRelationDao, LuiSetDao, MilestoneDao, PopulationDao, PopulationRuleDao, ProcessDao, ResultScaleDao, ResultSourceDao, ResultValueDao, ResultValuesGroupDao, RoomResponsibleOrgDao, RoomServiceDao, ScheduleComponentDao, ScheduleDao, ScheduleRequestDao, ScheduleRequestSetDao, SeatPoolDefinitionDao, SocDao, SocRolloverResultDao, SocRolloverResultItemDao, StateChangeDao, StateConstraintDao, StateDao, StatePropagationDao, SubjectCodeDao, SubjectCodeJoinOrgDao, TimeSlotDao, TypeDao, TypeTypeRelationDao

public interface EntityDao<K extends Serializable,T extends PersistableEntity<K>>

Interface, that describes default methods of Dao objects for entity.

Author:

Kuali Student Team

Method Summary

Methods

Modifier and Type	Method and Description
T	find(K primaryKey) Find object by primary key.
List<T>	findAll() Load all entities of this type.
List<T>	findByIds(List<K> primaryKeys) Find objects of specified class by primary keys.
List<T>	findByIds(String primaryKeyMemberName, List<K> primaryKeys) Find objects of specified class by primary keys.
EntityManager	getEm()
T	merge(T entity) Merge detached object.
void	persist(T entity) Persist unsaved object.
void	remove(T entity) Remove entity from the persistent store.
void	setEm(EntityManager em)
void	update(T entity) Update detached object.

Method Detail

find

T find(K primaryKey)

Find object by primary key.

Parameters:

primaryKey - Primary key

Returns:

Entity for given key

findByIds

List<T> findByIds(List<K> primaryKeys)
                                               throws Exception

Find objects of specified class by primary keys. Note: this method assumes that your primary key is "id"

Parameters:

primaryKeys - - list of Primary keys

Returns:

Entity for given key

Throws:

Exception

findByIds

List<T> findByIds(String primaryKeyMemberName,
                List<K> primaryKeys)
                                               throws Exception

Find objects of specified class by primary keys.

Parameters:

primaryKeys - - list of Primary keys

Returns:

Entity for given key

Throws:

Exception

findAll

List<T> findAll()

Load all entities of this type.

Returns:

List of entities

persist

void persist(T entity)

Persist unsaved object.

Parameters:

entity - Entity to save

update

void update(T entity)

Update detached object.

Parameters:

entity - Entity to update

merge

T merge(T entity)

Merge detached object.

Parameters:

entity - Entity to save

Returns:

Merged entity.

remove

void remove(T entity)

Remove entity from the persistent store.

Parameters:

entity - Entity to remove

getEm

EntityManager getEm()
                    throws UnsupportedOperationException

Returns:

An entity manager, if applicable

Throws:

UnsupportedOperationException - if there is no EM associated with this

setEm

void setEm(EntityManager em)
           throws UnsupportedOperationException

Parameters:

em - An entity manager, if applicable

Throws:

UnsupportedOperationException - if there is no EM associated with this