org.assistments.service.dao.base

Interface CommonDao<T>

All Known Subinterfaces:

AccessTokenDao, ActionEndDao, ActionHintDao, ActionLevelTypeDao, ActionResponseDao, ActionStartDao, ActionSubmitDao, ActionSurveyResponseDao, ActionTypeDao, ActionUrlDao, AnswerDao, AnswerEvalTypeDao, AssignmentActionDao, AssignmentContentPropertyDao, AssignmentDao, AssignmentLogDao, AssignmentObjectPropertyDao, AssistmentDao, AssistmentInfoDao, AssistmentOwnershipDao, AssistmentTypeDao, ContentPropertyDefinitionDao, ContentPropertyToPSNavigationDao, ContentPropertyValidValueDao, ContentPropertyValueDao, DataTypeDao, DependentPartnerDao, ErrorLogDao, ExternalReferenceDao, ExternalReferenceTypeDao, FirstActionTypeDao, GroupDao, GroupMembershipDao, HintDao, LegacyAccessTokenDao, LegacyApiPartnerDao, LegacyAssignmentLogDao, LegacyAssistmentToSequenceAssociationDao, LegacyClassAssignmentDao, LegacyCurriculumItemDao, LegacyEnrollmentDao, LegacyExternalReferenceDao, LegacyFolderDao, LegacyFolderItemDao, LegacyFolderOwnershipDao, LegacyPartnerExternalReferencesDao, LegacyPrerequisiteSkillDao, LegacyProblemLogDao, LegacyStudentClassDao, LegacyTeacherClassDao, LegacyUserDao, LegacyUserRoleDao, LMSAccessTokenDao, LMSMappingDao, LMSObjectTypeDao, LMSProtocolTypeDao, LMSProviderDao, LoggedRequestDao, LoginAliasDao, LoginProviderDao, NavigationTypeDao, NavigatorDao, NetworkStateTypeDao, ObjectPropertyDefinitionDao, ObjectPropertyHierarchyDao, ObjectPropertyHierarchyTypeDao, ObjectPropertyTargetTypeDao, ObjectPropertyValueDao, PartnerBridgeDao, PartnerDao, PartnerTypeDao, PlacementsMultiProblemSkillSequenceDao, PrerequisiteSkillDao, PrincipalTypeDao, ProblemActionDao, ProblemDao, ProblemLogDao, ProblemToSkillAssociationDao, ProblemTypeDao, PropertyCategoryDao, PropertyExposureDao, PropertyTypeDao, QualityLevelDao, ResponseDao, ResponseValuePartDao, ScaffoldDao, SectionDao, SectionLinkDao, SequenceDao, SequenceInfoDao, SequenceOwnershipDao, SetActionDao, SkillDao, SkillSequenceDao, TerminatorDao, TutoringTypeDao, TutorStrategyDao, UserDao, UserGeneratedHintDao, UserRoleDao, UserRoleTypeDao, UserTypeDao, VariableDao

All Known Implementing Classes:

JdbcAccessTokenDao, JdbcActionEndDao, JdbcActionHintDao, JdbcActionLevelTypeDao, JdbcActionResponseDao, JdbcActionStartDao, JdbcActionSubmitDao, JdbcActionSurveyResponseDao, JdbcActionTypeDao, JdbcActionUrlDao, JdbcAnswerDao, JdbcAnswerEvalTypeDao, JdbcAssignmentActionDao, JdbcAssignmentContentPropertyDao, JdbcAssignmentDao, JdbcAssignmentLogDao, JdbcAssignmentObjectPropertyDao, JdbcAssistmentDao, JdbcAssistmentInfoDao, JdbcAssistmentOwnershipDao, JdbcAssistmentTypeDao, JdbcBaseDao, JdbcContentPropertyDefinitionDao, JdbcContentPropertyToPSNavigationDao, JdbcContentPropertyValidValueDao, JdbcContentPropertyValueDao, JdbcDataTypeDao, JdbcDependentPartnerDao, JdbcErrorLogDao, JdbcExternalReferenceDao, JdbcExternalReferenceTypeDao, JdbcFirstActionTypeDao, JdbcGroupDao, JdbcGroupMembershipDao, JdbcHintDao, JdbcLegacyApiPartnerLegacyDao, JdbcLegacyAssignmentLogDao, JdbcLegacyAssistmentToSequenceAssociationDao, JdbcLegacyClassAssignmentDao, JdbcLegacyCurriculumItemDao, JdbcLegacyEnrollmentDao, JdbcLegacyExternalReferenceDao, JdbcLegacyFolderDao, JdbcLegacyFolderItemDao, JdbcLegacyFolderOwnershipDao, JdbcLegacyPartnerExternalReferencesDao, JdbcLegacyPrerequisiteSkillDao, JdbcLegacyProblemLogDao, JdbcLegacySkillDao, JdbcLegacyStudentClassDao, JdbcLegacyTeacherClassDao, JdbcLegacyUserDao, JdbcLegacyUserRoleDao, JdbcLMSAccessTokenDao, JdbcLMSMappingDao, JdbcLMSObjectTypeDao, JdbcLMSProtocolTypeDao, JdbcLMSProviderDao, JdbcLoggedRequestDao, JdbcLoginAliasDao, JdbcLoginProviderDao, JdbcNavigationTypeDao, JdbcNavigatorDao, JdbcNetworkStateTypeDao, JdbcObjectPropertyDefinitionDao, JdbcObjectPropertyHierarchyDao, JdbcObjectPropertyHierarchyTypeDao, JdbcObjectPropertyTargetTypeDao, JdbcObjectPropertyValueDao, JdbcPartnerBridgeDao, JdbcPartnerDao, JdbcPartnerTypeDao, JdbcPlacementsMultiProblemSkillSequenceDao, JdbcPrerequisiteSkillDao, JdbcPrincipalTypeDao, JdbcProblemActionDao, JdbcProblemDao, JdbcProblemLogDao, JdbcProblemToSkillAssociationDao, JdbcPropertyCategoryDao, JdbcPropertyExposureDao, JdbcPropertyTypeDao, JdbcQualityLevelDao, JdbcResponseDao, JdbcResponseValuePartDao, JdbcScaffoldDao, JdbcSectionDao, JdbcSectionLinkDao, JdbcSequenceDao, JdbcSequenceInfoDao, JdbcSequenceQwnershipDao, JdbcSetActionDao, JdbcSkillDao, JdbcSkillSequenceDao, JdbcTerminatorDao, JdbcTutoringTypeDao, JdbcTutorStrategyDao, JdbcUserDao, JdbcUserGeneratedHintDao, JdbcUserRoleDao, JdbcUserRoleTypeDao, JdbcUserTypeDao, JdbcVariableDao

public interface CommonDao<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<Pair<java.lang.Enum<?>,java.lang.String>>	FieldTypes Drops a single table.

Method Summary

Modifier and Type	Method and Description
int	delete(java.util.List<QueryTerm> terms)
int	delete(QueryInstance qi)
int	delete(QueryTerm term)
int	deleteById(int dbid)
boolean	exists(java.util.List<QueryTerm> terms)
boolean	exists(QueryTerm term) Determines whether one or more rows exist matching all of the specified fields with exact values.
java.util.List<java.lang.Integer>	findAllIds(java.util.List<QueryTerm> terms) Returns the list of row IDs matching all of the specified fields with exact values.
java.util.List<java.lang.Integer>	findAllIds(QueryInstance qi)
java.util.List<java.lang.Integer>	findAllIds(QueryTerm term)
java.util.List<T>	findAllObjects() Returns the list of domain objects from all rows in the table.
java.util.List<T>	findAllObjects(java.util.List<QueryTerm> terms) Returns the list of domain objects matching all of the specified fields with exact values.
java.util.List<T>	findAllObjects(QueryInstance qi)
java.util.List<T>	findAllObjects(QueryTerm term)
T	findById(int dbId) Returns the domain object for the specified internal database ID.
int	findId(java.util.List<QueryTerm> terms)
int	findId(QueryTerm term) Returns the first IDs matching all of the specified fields with exact values.
java.util.List<T>	findMultipleObjects(java.util.List<QueryTerm> terms, int limit)
java.util.List<T>	findMultipleObjects(java.util.List<QueryTerm> terms, int start, int limit)
T	findObject(java.util.List<QueryTerm> terms) Returns the object matching all of the specified fields with exact values.
T	findObject(QueryInstance qi) Returns the object matching the specified query.
T	findObject(QueryTerm term) Returns the object matching the specified query term.
int	getCount(java.util.List<QueryTerm> terms)
int	getCount(QueryInstance qi)
int	getCount(QueryTerm term) Returns the number of rows matching all of the specified fields with exact values.
default java.util.List<Pair<java.lang.Enum<?>,java.lang.String>>	getFieldDefns()
int	persist(T obj) Inserts a row in the current table.
void	update(int dbId, java.util.List<NVPair> values) Updates a row in the current table
void	update(int dbId, NVPair value)
void	update(int dbId, T obj) Updates a row in the current table.

Field Detail

FieldTypes

static final java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> FieldTypes

Drops a single table.

Method Detail

persist

int persist(T obj)
     throws java.lang.IllegalArgumentException

Inserts a row in the current table. Assumes the table has a primary key defines.

Parameters:

obj - The object forming the basis of the new row.

Returns:

For tables with a primary key, returns the internal database ID of the newly created row; otherwise 0.

Throws:

java.lang.IllegalArgumentException - If the number of values does not match exactly the number of columns in the table, less the primary key field (if applicable).

update

void update(int dbId,
            java.util.List<NVPair> values)
     throws NotFoundException

Updates a row in the current table

Parameters:

dbId - The internal database ID for the row to modify.

values - A list of Pairs containing the field names (from the enum element defined in the concrete class) and values to change.

Throws:

NotFoundException - If no such row exists

update

void update(int dbId,
            NVPair value)
     throws NotFoundException

Throws:

NotFoundException

update

void update(int dbId,
            T obj)
     throws NotFoundException

Updates a row in the current table.

Parameters:

dbId - The internal database ID for the row to modify. A caller should be able to obtain this value by getting it directly from the obj.

obj - Source object for updating the table row's fields.

Throws:

NotFoundException - If no such row exists

findById

T findById(int dbId)
    throws NotFoundException

Returns the domain object for the specified internal database ID.

Parameters:

dbId - Internal database ID for the row to return.

Returns:

A pojo containing the row's data.

Throws:

NotFoundException - If no such row exists

findId

int findId(QueryTerm term)
    throws NotFoundException

Returns the first IDs matching all of the specified fields with exact values. That is to say the resulting query is of the form:

field1 = value1 AND field2 = value2 AND ...

Parameters:

values - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

The first internal database IDs matching the values.

Throws:

NotFoundException - If no such row exists

findId

int findId(java.util.List<QueryTerm> terms)
    throws NotFoundException

Throws:

NotFoundException

findAllIds

java.util.List<java.lang.Integer> findAllIds(java.util.List<QueryTerm> terms)

Returns the list of row IDs matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Parameters:

terms - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

A list of internal database IDs matching the values.

Throws:

NotFoundException - If no rows exist

findAllIds

java.util.List<java.lang.Integer> findAllIds(QueryTerm term)

findAllIds

java.util.List<java.lang.Integer> findAllIds(QueryInstance qi)

findObject

T findObject(java.util.List<QueryTerm> terms)
      throws NotFoundException,
             TooManyTooLargeException

Returns the object matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Parameters:

terms - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

The result matching the terms.

Throws:

NotFoundException - If no such row exists

TooManyTooLargeException - If more than one row is found

findObject

T findObject(QueryTerm term)
      throws NotFoundException,
             TooManyTooLargeException

Returns the object matching the specified query term.

Parameters:

term - A single term

Returns:

The result matching the terms.

Throws:

NotFoundException - If no such row exists

TooManyTooLargeException - If more than one row is found

findObject

T findObject(QueryInstance qi)
      throws NotFoundException,
             TooManyTooLargeException

Returns the object matching the specified query.

Parameters:

qi - A QueryInstance derived from a QueryBuilder

Returns:

The result matching the query.

Throws:

NotFoundException - If no such row exists

TooManyTooLargeException - If more than one row is found

findAllObjects

java.util.List<T> findAllObjects()
                          throws NotFoundException

Returns the list of domain objects from all rows in the table.

Note: Use with caution. findAllObjects() is intentende for use on tables containing a modest number of rows.

Returns:

The list of domain object instances.

Throws:

NotFoundException - If no rows exist

findAllObjects

java.util.List<T> findAllObjects(java.util.List<QueryTerm> terms)
                          throws NotFoundException

Returns the list of domain objects matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Parameters:

terms - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

A list of domain object instances matching the values.

Throws:

NotFoundException - If no rows exist

findAllObjects

java.util.List<T> findAllObjects(QueryTerm term)
                          throws NotFoundException

Throws:

NotFoundException

findAllObjects

java.util.List<T> findAllObjects(QueryInstance qi)
                          throws NotFoundException

Throws:

NotFoundException

findMultipleObjects

java.util.List<T> findMultipleObjects(java.util.List<QueryTerm> terms,
                                      int limit)
                               throws NotFoundException

Throws:

NotFoundException

findMultipleObjects

java.util.List<T> findMultipleObjects(java.util.List<QueryTerm> terms,
                                      int start,
                                      int limit)

exists

boolean exists(QueryTerm term)

Determines whether one or more rows exist matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Parameters:

values - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

true if at least one row matches the values; otherwise false.

exists

boolean exists(java.util.List<QueryTerm> terms)

getCount

int getCount(QueryTerm term)

Returns the number of rows matching all of the specified fields with exact values. That is to say the resulting query is of the form:
field1 = value1 AND field2 = value2 AND ...

Parameters:

values - A list of Pairs containing field names (as the enum element defined in the concrete class) and values to search on.

Returns:

The number of rows matching the values.

getCount

int getCount(java.util.List<QueryTerm> terms)

getCount

int getCount(QueryInstance qi)

deleteById

int deleteById(int dbid)

delete

int delete(QueryTerm term)

delete

int delete(java.util.List<QueryTerm> terms)

delete

int delete(QueryInstance qi)

getFieldDefns

default java.util.List<Pair<java.lang.Enum<?>,java.lang.String>> getFieldDefns()