org.dspace.content.service

Interface RelationshipService

All Superinterfaces:

DSpaceCRUDService<Relationship>

All Known Implementing Classes:

RelationshipServiceImpl

public interface RelationshipService
extends DSpaceCRUDService<Relationship>

This Service will use the DAO classes to access the information about Relationships from the database

Method Summary

Modifier and Type	Method and Description
Relationship	create(Context c, Item leftItem, Item rightItem, RelationshipType relationshipType, int leftPlace, int rightPlace) This method is used to construct a Relationship object with all it's variables
Relationship	create(Context context, Relationship relationship) This method creates a relationship object in the database equal to the given relationship param if this is a valid relationship
List<Relationship>	findAll(Context context) Retrieves the full list of relationships currently in the system
List<Relationship>	findByItem(Context context, Item item) Retrieves the list of Relationships currently in the system for which the given Item is either a leftItem or a rightItem object
List<Relationship>	findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType) This method returns a list of Relationships for which the leftItem or rightItem is equal to the given Item object and for which the RelationshipType object is equal to the relationshipType property
List<Relationship>	findByRelationshipType(Context context, RelationshipType relationshipType) This method returns a list of Relationship objets for which the relationshipType property is equal to the given RelationshipType object
int	findLeftPlaceByLeftItem(Context context, Item item) Retrieves the highest integer value for the leftplace property of a Relationship for all relationships that have the given item as a left item
int	findRightPlaceByRightItem(Context context, Item item) Retrieves the highest integer value for the rightplace property of a Relationship for all relationships that have the given item as a right item
void	updateItem(Context context, Item relatedItem) This method will update the given item's metadata order.
void	updatePlaceInRelationship(Context context, Relationship relationship, boolean isCreation) This method will update the place for the Relationship and all other relationships found by the items and relationship type of the given Relatonship.

Methods inherited from interface org.dspace.service.DSpaceCRUDService

create, delete, find, update, update

Method Detail

findByItem

List<Relationship> findByItem(Context context,
                              Item item)
                       throws SQLException

Retrieves the list of Relationships currently in the system for which the given Item is either a leftItem or a rightItem object

Parameters:

context - The relevant DSpace context

item - The Item that has to be the left or right item for the relationship to be included in the list

Returns:

The list of relationships for which each relationship adheres to the above listed constraint

Throws:

SQLException - If something goes wrong

findAll

List<Relationship> findAll(Context context)
                    throws SQLException

Retrieves the full list of relationships currently in the system

Parameters:

context - The relevant DSpace context

Returns:

The list of all relationships currently in the system

Throws:

SQLException - If something goes wrong

create

Relationship create(Context context,
                    Relationship relationship)
             throws SQLException,
                    AuthorizeException

This method creates a relationship object in the database equal to the given relationship param if this is a valid relationship

Parameters:

context - The relevant DSpace context

relationship - The relationship that will be created in the database if it is valid

Returns:

The created relationship with updated place variables

Throws:

SQLException - If something goes wrong

AuthorizeException - If something goes wrong with authorizations

findLeftPlaceByLeftItem

int findLeftPlaceByLeftItem(Context context,
                            Item item)
                     throws SQLException

Retrieves the highest integer value for the leftplace property of a Relationship for all relationships that have the given item as a left item

Parameters:

context - The relevant DSpace context

item - The item that has to be the leftItem of a relationship for it to qualify

Returns:

The integer value of the highest left place property of all relationships that have the given item as a leftitem property

Throws:

SQLException - If something goes wrong

findRightPlaceByRightItem

int findRightPlaceByRightItem(Context context,
                              Item item)
                       throws SQLException

Retrieves the highest integer value for the rightplace property of a Relationship for all relationships that have the given item as a right item

Parameters:

context - The relevant DSpace context

item - The item that has to be the rightitem of a relationship for it to qualify

Returns:

The integer value of the highest right place property of all relationships that have the given item as a rightitem property

Throws:

SQLException - If something goes wrong

findByItemAndRelationshipType

List<Relationship> findByItemAndRelationshipType(Context context,
                                                 Item item,
                                                 RelationshipType relationshipType)
                                          throws SQLException

This method returns a list of Relationships for which the leftItem or rightItem is equal to the given Item object and for which the RelationshipType object is equal to the relationshipType property

Parameters:

context - The relevant DSpace context

item - The Item object to be matched on the leftItem or rightItem for the relationship

relationshipType - The RelationshipType object that will be used to check the Relationship on

Returns:

The list of Relationship objects that have the given Item object as leftItem or rightItem and for which the relationshipType property is equal to the given RelationshipType

Throws:

SQLException - If something goes wrong

updatePlaceInRelationship

void updatePlaceInRelationship(Context context,
                               Relationship relationship,
                               boolean isCreation)
                        throws SQLException,
                               AuthorizeException

This method will update the place for the Relationship and all other relationships found by the items and relationship type of the given Relatonship. It will give this Relationship the last place in both the left and right place determined by querying for the list of leftRelationships and rightRelationships by the leftItem, rightItem and relationshipType of the given Relationship.

Parameters:

context - The relevant DSpace context

relationship - The Relationship object that will have it's place updated and that will be used to retrieve the other relationships whose place might need to be updated

isCreation - Is the relationship new or did it already exist

Throws:

SQLException - If something goes wrong

AuthorizeException

updateItem

void updateItem(Context context,
                Item relatedItem)
         throws SQLException,
                AuthorizeException

This method will update the given item's metadata order. If the relationships for the item have been modified and will calculate the place based on a metadata field, this function will ensure the place is calculated.

Parameters:

context - The relevant DSpace context

relatedItem - The Item for which the list of Relationship location is calculated based on a metadata field

Throws:

SQLException - If something goes wrong

AuthorizeException - If the user is not authorized to update the item

findByRelationshipType

List<Relationship> findByRelationshipType(Context context,
                                          RelationshipType relationshipType)
                                   throws SQLException

This method returns a list of Relationship objets for which the relationshipType property is equal to the given RelationshipType object

Parameters:

context - The relevant DSpace context

relationshipType - The RelationshipType object that will be used to check the Relationship on

Returns:

The list of Relationship objects for which the given RelationshipType object is equal to the relationshipType property

Throws:

SQLException - If something goes wrong

create

Relationship create(Context c,
                    Item leftItem,
                    Item rightItem,
                    RelationshipType relationshipType,
                    int leftPlace,
                    int rightPlace)
             throws AuthorizeException,
                    SQLException

This method is used to construct a Relationship object with all it's variables

Parameters:

c - The relevant DSpace context

leftItem - The leftItem Item object for the relationship

rightItem - The rightItem Item object for the relationship

relationshipType - The RelationshipType object for the relationship

leftPlace - The leftPlace integer for the relationship

rightPlace - The rightPlace integer for the relationship

Returns:

The created Relationship object with the given properties

Throws:

AuthorizeException - If something goes wrong

SQLException - If something goes wrong