org.kuali.student.common.ui.server.applicationstate.dao
Interface ApplicationStateDao

All Superinterfaces:

CrudDao, SearchableDao

All Known Implementing Classes:

ApplicationStateDaoImpl

public interface ApplicationStateDao
extends CrudDao, SearchableDao

This data access interface stores the GUI (page, section, widget, etc.) application states as key value pairs in a database.

Method Summary

ApplicationState	createApplicationState(ApplicationState appState) Creates and returns an application state.
List<String>	createApplicationState(Collection<ApplicationState> appStates) Creates a collection of application states and returns their ids.
ApplicationState	getApplicationState(String applicationId, String referenceKey, String referenceType) Gets a list of application states by applicationId, referenceKey and referenceType.
ApplicationState	getApplicationState(String applicationId, String referenceKey, String referenceType, String userId) Gets a list of application states by applicationId, referenceKey, referenceType and userId.

Methods inherited from interface org.kuali.student.common.dao.CrudDao

create, delete, delete, fetch, find, update

Methods inherited from interface org.kuali.student.common.dao.SearchableDao

search

Method Detail

getApplicationState

ApplicationState getApplicationState(String applicationId,
                                     String referenceKey,
                                     String referenceType,
                                     String userId)
                                     throws DoesNotExistException

Gets a list of application states by applicationId, referenceKey, referenceType and userId.

Parameters:

applicationId - Application id

referenceKey - Reference key

referenceType - Reference type

userId - User id

Returns:

An application state

Throws:

DoesNotExistException - Thrown if application state does not exist

getApplicationState

ApplicationState getApplicationState(String applicationId,
                                     String referenceKey,
                                     String referenceType)
                                     throws DoesNotExistException

Gets a list of application states by applicationId, referenceKey and referenceType.

Parameters:

applicationId - Application id

referenceKey - Reference key

referenceType - Reference type

Returns:

A list of application states

Throws:

DoesNotExistException - Thrown if application state does not exist

createApplicationState

ApplicationState createApplicationState(ApplicationState appState)
                                        throws AlreadyExistsException

Creates and returns an application state.

Parameters:

appState - Application state

Returns:

A new application state

Throws:

AlreadyExistsException - Thrown if application state already exists

createApplicationState

List<String> createApplicationState(Collection<ApplicationState> appStates)
                                    throws AlreadyExistsException

Creates a collection of application states and returns their ids.

Parameters:

appStateList - collection of application states

Returns:

A list of newly created application state ids

Throws:

AlreadyExistsException - Thrown if application state already exists