org.dspace.content.service

Interface EntityService

All Known Implementing Classes:

EntityServiceImpl

public interface EntityService

This Service provides us with a few methods to return objects based on the Entity object. Since the Entity object isn't a database object, this method mostly outsources to getters for other services to return the wanted objects to then check for properties on either the list of relationships or the item included in the Entity.

Method Summary

Modifier and Type	Method and Description
Entity	findByItemId(Context context, UUID itemId) This will construct an Entity object that will be returned with the Item that matches the ItemID that was passed along as well as a list of relationships for that Item.
List<RelationshipType>	getAllRelationshipTypes(Context context, Entity entity) Retrieves the list of relationships that have a relationshiptype that contains the EntityType for the given Entity in either the leftEntityType or the rightEntityType variables
List<Relationship>	getLeftRelations(Context context, Entity entity) Retrieves the list of relationships, which are attached to the Entity object that is passed along, where the left item object of each relationship is equal to the Item object of the Entity object that is passed along
List<RelationshipType>	getLeftRelationshipTypes(Context context, Entity entity) Retrieves the list of relationships that have a relationshiptype that contains the EntityType for the given Entity in the leftEntityType
List<Relationship>	getRelationsByLabel(Context context, String label) Retrieves the list of relationships for which their relationshiptype has a left or right label that is equal to the passed along label String
List<RelationshipType>	getRelationshipTypesByLabel(Context context, String label) Retrieves a list of RelationshipType objects for which either their left or right label is equal to the label parameter that's being passed along
List<Relationship>	getRightRelations(Context context, Entity entity) Retrieves the list of relationships, which are attached to the Entity object that is passed along, where the right item object of each relationship is equal to the Item object of the Entity object that is passed along
List<RelationshipType>	getRightRelationshipTypes(Context context, Entity entity) Retrieves the list of relationships that have a relationshiptype that contains the EntityType for the given Entity in the rightEntityType
EntityType	getType(Context context, Entity entity) Returns the EntityType for the Item that is attached to the Entity that is passed along to this method.

Method Detail

findByItemId

Entity findByItemId(Context context,
                    UUID itemId)
             throws SQLException

This will construct an Entity object that will be returned with the Item that matches the ItemID that was passed along as well as a list of relationships for that Item.

Parameters:

context - The relevant DSpace context

itemId - The ItemID for the Item that is to be used in the Entity object

Returns:

The constructed Entity object with the Item and the list of relationships

Throws:

SQLException - If something goes wrong

getType

EntityType getType(Context context,
                   Entity entity)
            throws SQLException

Returns the EntityType for the Item that is attached to the Entity that is passed along to this method. The EntityType String logic is in the Metadata for that Item and will be searched on in the EntityTypeService to retrieve the actual EntityType object

Parameters:

context - The relevant DSpace context

entity - The Entity object which contains the Item

Returns:

The EntityType that belongs to this Item

Throws:

SQLException - If something goes wrong

getLeftRelations

List<Relationship> getLeftRelations(Context context,
                                    Entity entity)

Retrieves the list of relationships, which are attached to the Entity object that is passed along, where the left item object of each relationship is equal to the Item object of the Entity object that is passed along

Parameters:

context - The relevant DSpace context

entity - The Entity object to be returned

Returns:

The list of relationships that have the Item in the Entity object as their left item

getRightRelations

List<Relationship> getRightRelations(Context context,
                                     Entity entity)

Retrieves the list of relationships, which are attached to the Entity object that is passed along, where the right item object of each relationship is equal to the Item object of the Entity object that is passed along

Parameters:

context - The relevant DSpace context

entity - The Entity object to be returned

Returns:

The list of relationships that have the Item in the Entity object as their right item

getRelationsByLabel

List<Relationship> getRelationsByLabel(Context context,
                                       String label)
                                throws SQLException

Retrieves the list of relationships for which their relationshiptype has a left or right label that is equal to the passed along label String

Parameters:

context - The relevant DSpace context

label - The label that needs to be in the relationshiptype of the relationship

Returns:

The list of relationships that have a relationshiptype with a left or right label that is equal to the label param

Throws:

SQLException - If something goes wrong

getAllRelationshipTypes

List<RelationshipType> getAllRelationshipTypes(Context context,
                                               Entity entity)
                                        throws SQLException

Retrieves the list of relationships that have a relationshiptype that contains the EntityType for the given Entity in either the leftEntityType or the rightEntityType variables

Parameters:

context - The relevant DSpace context

entity - The Entity for which the EntityType should be checked for relationships

Returns:

The list of relationships that each contain a relationshiptype in which there is a right or left entity type that is equal to the entity type for the given entity

Throws:

SQLException - If something goes wrong

getLeftRelationshipTypes

List<RelationshipType> getLeftRelationshipTypes(Context context,
                                                Entity entity)
                                         throws SQLException

Retrieves the list of relationships that have a relationshiptype that contains the EntityType for the given Entity in the leftEntityType

Parameters:

context - The relevant DSpace context

entity - The Entity for which the EntityType should be checked for relationships

Returns:

The list of relationships that each contain a relationshiptype in which there is a left entity type that is equal to the entity type for the given entity

Throws:

SQLException - If something goes wrong

getRightRelationshipTypes

List<RelationshipType> getRightRelationshipTypes(Context context,
                                                 Entity entity)
                                          throws SQLException

Retrieves the list of relationships that have a relationshiptype that contains the EntityType for the given Entity in the rightEntityType

Parameters:

context - The relevant DSpace context

entity - The Entity for which the EntityType should be checked for relationships

Returns:

The list of relationships that each contain a relationshiptype in which there is a right entity type that is equal to the entity type for the given entity

Throws:

SQLException - If something goes wrong

getRelationshipTypesByLabel

List<RelationshipType> getRelationshipTypesByLabel(Context context,
                                                   String label)
                                            throws SQLException

Retrieves a list of RelationshipType objects for which either their left or right label is equal to the label parameter that's being passed along

Parameters:

context - The relevant DSpace context

label - The label for which the relationshiptype's labels must be checked

Returns:

The list of relationshiptypes that each contain a left or right label that is equal to the given label parameter

Throws:

SQLException - If something goes wrong