Package org.dspace.content.dao

Interface RelationshipTypeDAO

All Superinterfaces:

GenericDAO<RelationshipType>

All Known Implementing Classes:

RelationshipTypeDAOImpl

public interface RelationshipTypeDAO
extends GenericDAO<RelationshipType>

Database Access Object Interface class for the RelationshipType object The implementation of this class is responsible for all database calls for the RelationshipType object and is autowired by spring This class should only be accessed from a single service and should never be exposed outside of the API

Method Summary

Modifier and Type	Method	Description
int	countByEntityType(Context context, EntityType entityType)	Count all RelationshipType objects for which the given EntityType is equal to either the leftType or the rightType
List<RelationshipType>	findByEntityType(Context context, EntityType entityType)	This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType
List<RelationshipType>	findByEntityType(Context context, EntityType entityType, Boolean isLeft)	This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType
List<RelationshipType>	findByEntityType(Context context, EntityType entityType, Boolean isLeft, Integer limit, Integer offset)	This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType
List<RelationshipType>	findByEntityType(Context context, EntityType entityType, Integer limit, Integer offset)	This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType
List<RelationshipType>	findByLeftwardOrRightwardTypeName(Context context, String type)	This method will return a list of RelationshipType objects for which the given label is equal to either the leftwardType or rightwardType.
List<RelationshipType>	findByLeftwardOrRightwardTypeName(Context context, String type, Integer limit, Integer offset)	This method will return a list of RelationshipType objects for which the given label is equal to either the leftLabel or rightLabel.
RelationshipType	findbyTypesAndTypeName(Context context, EntityType leftType, EntityType rightType, String leftwardType, String rightwardType)	This method is used to retrieve the RelationshipType object that has the same leftType, rightType, leftwardType and rightwardType as given in the parameters

Methods inherited from interface org.dspace.core.GenericDAO

create, delete, findAll, findAll, findByID, findByID, findMany, findUnique, save

Method Detail

findbyTypesAndTypeName

RelationshipType findbyTypesAndTypeName(Context context,
                                        EntityType leftType,
                                        EntityType rightType,
                                        String leftwardType,
                                        String rightwardType)
                                 throws SQLException

This method is used to retrieve the RelationshipType object that has the same leftType, rightType, leftwardType and rightwardType as given in the parameters

Parameters:

context - The relevant DSpace context

leftType - The leftType EntityType object to be matched in the query

rightType - The rightType EntityType object to be matched in the query

leftwardType - The leftwardType String to be matched in the query

rightwardType - The rightwardType String to be matched in the query

Returns:

The RelationshipType object that matches all the given parameters

Throws:

SQLException - If something goes wrong

findByLeftwardOrRightwardTypeName

List<RelationshipType> findByLeftwardOrRightwardTypeName(Context context,
                                                         String type)
                                                  throws SQLException

This method will return a list of RelationshipType objects for which the given label is equal to either the leftwardType or rightwardType.

Parameters:

context - The relevant DSpace context

type - The label that will be used to check on

Returns:

A list of RelationshipType objects that have the given label as either the leftwardType or rightwardType

Throws:

SQLException - If something goes wrong

findByLeftwardOrRightwardTypeName

List<RelationshipType> findByLeftwardOrRightwardTypeName(Context context,
                                                         String type,
                                                         Integer limit,
                                                         Integer offset)
                                                  throws SQLException

This method will return a list of RelationshipType objects for which the given label is equal to either the leftLabel or rightLabel.

Parameters:

context - The relevant DSpace context

type - The label that will be used to check on

limit - paging limit

offset - paging offset

Returns:

A list of RelationshipType objects that have the given label as either the leftLabel or rightLabel

Throws:

SQLException - If something goes wrong

findByEntityType

List<RelationshipType> findByEntityType(Context context,
                                        EntityType entityType)
                                 throws SQLException

This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType

Parameters:

context - The relevant DSpace context

entityType - The EntityType object that will be used to check on

Returns:

The list of RelationshipType objects that have the given EntityType object as either a leftType or rightType

Throws:

SQLException - If something goes wrong

findByEntityType

List<RelationshipType> findByEntityType(Context context,
                                        EntityType entityType,
                                        Integer limit,
                                        Integer offset)
                                 throws SQLException

This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType

Parameters:

context - The relevant DSpace context

entityType - The EntityType object that will be used to check on

limit - paging limit

offset - paging offset

Returns:

The list of RelationshipType objects that have the given EntityType object as either a leftType or rightType

Throws:

SQLException - If something goes wrong

findByEntityType

List<RelationshipType> findByEntityType(Context context,
                                        EntityType entityType,
                                        Boolean isLeft)
                                 throws SQLException

This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType

Parameters:

context - The relevant DSpace context

entityType - The EntityType object that will be used to check on

isLeft - Boolean value used to filter by left_type or right_type. If true left_type results only else right_type results.

Returns:

The list of RelationshipType objects that have the given EntityType object as either a leftType or rightType

Throws:

SQLException - If something goes wrong

findByEntityType

List<RelationshipType> findByEntityType(Context context,
                                        EntityType entityType,
                                        Boolean isLeft,
                                        Integer limit,
                                        Integer offset)
                                 throws SQLException

This method will return a list of RelationshipType objects for which the given EntityType object is equal to the leftType or rightType

Parameters:

context - The relevant DSpace context

entityType - The EntityType object that will be used to check on

isLeft - Boolean value used to filter by left_type or right_type. If true left_type results only else right_type results.

limit - paging limit

offset - paging offset

Returns:

The list of RelationshipType objects that have the given EntityType object as either a leftType or rightType

Throws:

SQLException - If something goes wrong

countByEntityType

int countByEntityType(Context context,
                      EntityType entityType)
               throws SQLException

Count all RelationshipType objects for which the given EntityType is equal to either the leftType or the rightType

Parameters:

context - DSpace context object

entityType - The EntityType object used to check the leftType and rightType properties

Returns:

Total RelationshipType objects

Throws:

SQLException - If database error