Uses of Class
org.dspace.content.Relationship

Packages that use Relationship

Package	Description
org.dspace.content	Provides an API for reading and manipulating content in the DSpace system.
org.dspace.content.dao
org.dspace.content.dao.impl
org.dspace.content.service
org.dspace.versioning
org.dspace.versioning.utils

Uses of Relationship in org.dspace.content

Fields in org.dspace.content with type parameters of type Relationship

Modifier and Type	Field	Description
static jakarta.persistence.metamodel.EntityType<Relationship>	Relationship_.class_
static jakarta.persistence.metamodel.SingularAttribute<Relationship,Integer>	Relationship_.id
static jakarta.persistence.metamodel.SingularAttribute<Relationship,Relationship.LatestVersionStatus>	Relationship_.latestVersionStatus
static jakarta.persistence.metamodel.SingularAttribute<Relationship,Item>	Relationship_.leftItem
static jakarta.persistence.metamodel.SingularAttribute<Relationship,Integer>	Relationship_.leftPlace
static jakarta.persistence.metamodel.SingularAttribute<Relationship,String>	Relationship_.leftwardValue
static jakarta.persistence.metamodel.SingularAttribute<Relationship,RelationshipType>	Relationship_.relationshipType
static jakarta.persistence.metamodel.SingularAttribute<Relationship,Item>	Relationship_.rightItem
static jakarta.persistence.metamodel.SingularAttribute<Relationship,Integer>	Relationship_.rightPlace
static jakarta.persistence.metamodel.SingularAttribute<Relationship,String>	Relationship_.rightwardValue

Methods in org.dspace.content that return Relationship

Modifier and Type	Method	Description
Relationship	RelationshipServiceImpl.create(Context context)
Relationship	RelationshipServiceImpl.create(Context c, Item leftItem, Item rightItem, RelationshipType relationshipType, int leftPlace, int rightPlace)
Relationship	RelationshipServiceImpl.create(Context c, Item leftItem, Item rightItem, RelationshipType relationshipType, int leftPlace, int rightPlace, String leftwardValue, String rightwardValue)
Relationship	RelationshipServiceImpl.create(Context c, Item leftItem, Item rightItem, RelationshipType relationshipType, int leftPlace, int rightPlace, String leftwardValue, String rightwardValue, Relationship.LatestVersionStatus latestVersionStatus)
Relationship	RelationshipServiceImpl.create(Context context, Relationship relationship)
Relationship	RelationshipServiceImpl.find(Context context, int id)
Relationship	RelationshipServiceImpl.move(Context context, Relationship relationship, Integer newLeftPlace, Integer newRightPlace)
Relationship	RelationshipServiceImpl.move(Context context, Relationship relationship, Item newLeftItem, Item newRightItem)

Methods in org.dspace.content that return types with arguments of type Relationship

Modifier and Type	Method	Description
List<Relationship>	RelationshipServiceImpl.findAll(Context context)
List<Relationship>	RelationshipServiceImpl.findAll(Context context, Integer limit, Integer offset)
List<Relationship>	RelationshipServiceImpl.findByItem(Context context, Item item)
List<Relationship>	RelationshipServiceImpl.findByItem(Context context, Item item, Integer limit, Integer offset, boolean excludeTilted)
List<Relationship>	RelationshipServiceImpl.findByItem(Context context, Item item, Integer limit, Integer offset, boolean excludeTilted, boolean excludeNonLatest)
List<Relationship>	RelationshipServiceImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType)
List<Relationship>	RelationshipServiceImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft)
List<Relationship>	RelationshipServiceImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft, int limit, int offset)
List<Relationship>	RelationshipServiceImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft, int limit, int offset, boolean excludeNonLatest)
List<Relationship>	RelationshipServiceImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, int limit, int offset)
List<Relationship>	RelationshipServiceImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, int limit, int offset, boolean excludeNonLatest)
List<Relationship>	RelationshipServiceImpl.findByItemRelationshipTypeAndRelatedList(Context context, UUID focusUUID, RelationshipType relationshipType, List<UUID> items, boolean isLeft, int offset, int limit)
List<Relationship>	RelationshipServiceImpl.findByRelationshipType(Context context, RelationshipType relationshipType)
List<Relationship>	RelationshipServiceImpl.findByRelationshipType(Context context, RelationshipType relationshipType, Integer limit, Integer offset)
List<Relationship>	RelationshipServiceImpl.findByTypeName(Context context, String typeName)
List<Relationship>	RelationshipServiceImpl.findByTypeName(Context context, String typeName, Integer limit, Integer offset)
List<Relationship>	EntityServiceImpl.getLeftRelations(Context context, Entity entity)
List<Relationship>	EntityServiceImpl.getRelationsByTypeName(Context context, String typeName)
List<Relationship>	EntityServiceImpl.getRelationsByTypeName(Context context, String typeName, Integer limit, Integer offset)
List<Relationship>	Entity.getRelationships()	Standard getter for the list of relationships for the Item in this Entity object
List<Relationship>	EntityServiceImpl.getRightRelations(Context context, Entity entity)

Methods in org.dspace.content with parameters of type Relationship

Modifier and Type	Method	Description
Relationship	RelationshipServiceImpl.create(Context context, Relationship relationship)
void	RelationshipServiceImpl.delete(Context context, Relationship relationship)
void	RelationshipServiceImpl.delete(Context context, Relationship relationship, boolean copyToLeftItem, boolean copyToRightItem)
List<RelationshipMetadataValue>	RelationshipMetadataService.findRelationshipMetadataValueForItemRelationship(Context context, Item item, String entityType, Relationship relationship, boolean enableVirtualMetadata)	Retrieves the list of RelationshipMetadataValue objects specific to only one Relationship of the item.
List<RelationshipMetadataValue>	RelationshipMetadataServiceImpl.findRelationshipMetadataValueForItemRelationship(Context context, Item item, String entityType, Relationship relationship, boolean enableVirtualMetadata)
void	RelationshipServiceImpl.forceDelete(Context context, Relationship relationship, boolean copyToLeftItem, boolean copyToRightItem)
Relationship	RelationshipServiceImpl.move(Context context, Relationship relationship, Integer newLeftPlace, Integer newRightPlace)
Relationship	RelationshipServiceImpl.move(Context context, Relationship relationship, Item newLeftItem, Item newRightItem)
void	RelationshipServiceImpl.update(Context context, Relationship relationship)

Method parameters in org.dspace.content with type arguments of type Relationship

Modifier and Type	Method	Description
void	Entity.setRelationships(List<Relationship> relationships)	Standard setter for the list of relationships for the Item in this Entity object
void	RelationshipServiceImpl.update(Context context, List<Relationship> relationships)

Constructor parameters in org.dspace.content with type arguments of type Relationship

Modifier	Constructor	Description
	Entity(Item item, List<Relationship> relationshipList)	constructor for the Entity object

Uses of Relationship in org.dspace.content.dao

Methods in org.dspace.content.dao that return types with arguments of type Relationship

Modifier and Type	Method	Description
List<Relationship>	RelationshipDAO.findByItem(Context context, Item item, boolean excludeTilted, boolean excludeNonLatest)	This method returns a list of Relationship objects that have the given Item object as a leftItem or a rightItem
List<Relationship>	RelationshipDAO.findByItem(Context context, Item item, Integer limit, Integer offset, boolean excludeTilted, boolean excludeNonLatest)	This method returns a list of Relationship objects that have the given Item object as a leftItem or a rightItem
List<Relationship>	RelationshipDAO.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft, Integer limit, Integer offset, boolean excludeNonLatest)	This method returns a list of Relationship objects for the given RelationshipType object.
List<Relationship>	RelationshipDAO.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, Integer limit, Integer offset, boolean excludeNonLatest)	This method returns a list of Relationship objects for the given RelationshipType object.
List<Relationship>	RelationshipDAO.findByItemAndRelationshipTypeAndList(Context context, UUID focusUUID, RelationshipType relationshipType, List<UUID> items, boolean isLeft, int offset, int limit)	This method is used to retrieve relationships that match focusItem on the one hand and matches list of related items elsewhere.
List<Relationship>	RelationshipDAO.findByRelationshipType(Context context, RelationshipType relationshipType)	This method returns a list of Relationship objects for the given RelationshipType object.
List<Relationship>	RelationshipDAO.findByRelationshipType(Context context, RelationshipType relationshipType, Integer limit, Integer offset)	This method returns a list of Relationship objects for the given RelationshipType object.
List<Relationship>	RelationshipDAO.findByTypeName(Context context, String typeName)	This method returns a list of Relationship objects for the given typeName
List<Relationship>	RelationshipDAO.findByTypeName(Context context, String typeName, Integer limit, Integer offset)	This method returns a list of Relationship objects for the given typeName

Uses of Relationship in org.dspace.content.dao.impl

Methods in org.dspace.content.dao.impl that return types with arguments of type Relationship

Modifier and Type	Method	Description
List<Relationship>	RelationshipDAOImpl.findByItem(Context context, Item item, boolean excludeTilted, boolean excludeNonLatest)
List<Relationship>	RelationshipDAOImpl.findByItem(Context context, Item item, Integer limit, Integer offset, boolean excludeTilted, boolean excludeNonLatest)
List<Relationship>	RelationshipDAOImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft, Integer limit, Integer offset, boolean excludeNonLatest)
List<Relationship>	RelationshipDAOImpl.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, Integer limit, Integer offset, boolean excludeNonLatest)
List<Relationship>	RelationshipDAOImpl.findByItemAndRelationshipTypeAndList(Context context, UUID focusUUID, RelationshipType relationshipType, List<UUID> items, boolean isLeft, int offset, int limit)
List<Relationship>	RelationshipDAOImpl.findByRelationshipType(Context context, RelationshipType relationshipType)
List<Relationship>	RelationshipDAOImpl.findByRelationshipType(Context context, RelationshipType relationshipType, Integer limit, Integer offset)
List<Relationship>	RelationshipDAOImpl.findByTypeName(Context context, String typeName)
List<Relationship>	RelationshipDAOImpl.findByTypeName(Context context, String typeName, Integer limit, Integer offset)

Method parameters in org.dspace.content.dao.impl with type arguments of type Relationship

Modifier and Type	Method	Description
protected jakarta.persistence.criteria.Predicate	RelationshipDAOImpl.getLeftItemPredicate(jakarta.persistence.criteria.CriteriaBuilder criteriaBuilder, jakarta.persistence.criteria.Root<Relationship> relationshipRoot, Item item, boolean excludeTilted, boolean excludeNonLatest)	Get the predicate for a criteria query that selects relationships by their left item.
protected jakarta.persistence.criteria.Predicate	RelationshipDAOImpl.getRightItemPredicate(jakarta.persistence.criteria.CriteriaBuilder criteriaBuilder, jakarta.persistence.criteria.Root<Relationship> relationshipRoot, Item item, boolean excludeTilted, boolean excludeNonLatest)	Get the predicate for a criteria query that selects relationships by their right item.

Uses of Relationship in org.dspace.content.service

Methods in org.dspace.content.service that return Relationship

Modifier and Type	Method	Description
Relationship	RelationshipService.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, except the leftward label, rightward label and latest version status
Relationship	RelationshipService.create(Context c, Item leftItem, Item rightItem, RelationshipType relationshipType, int leftPlace, int rightPlace, String leftwardValue, String rightwardValue)	This method is used to construct a Relationship object with all it's variables, except the latest version status
Relationship	RelationshipService.create(Context c, Item leftItem, Item rightItem, RelationshipType relationshipType, int leftPlace, int rightPlace, String leftwardValue, String rightwardValue, Relationship.LatestVersionStatus latestVersionStatus)	This method is used to construct a Relationship object with all it's variables
Relationship	RelationshipService.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
Relationship	RelationshipService.move(Context context, Relationship relationship, Integer newLeftPlace, Integer newRightPlace)	Move the given relationship to a new leftPlace and/or rightPlace.
Relationship	RelationshipService.move(Context context, Relationship relationship, Item newLeftItem, Item newRightItem)	Move the given relationship to a new leftItem and/or rightItem.

Methods in org.dspace.content.service that return types with arguments of type Relationship

Modifier and Type	Method	Description
List<Relationship>	RelationshipService.findAll(Context context)	Retrieves the full list of relationships currently in the system
List<Relationship>	RelationshipService.findAll(Context context, Integer limit, Integer offset)	Retrieves the full list of relationships currently in the system
List<Relationship>	RelationshipService.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>	RelationshipService.findByItem(Context context, Item item, Integer limit, Integer offset, boolean excludeTilted)	Retrieves the list of Relationships currently in the system for which the given Item is either a leftItem or a rightItem object
List<Relationship>	RelationshipService.findByItem(Context context, Item item, Integer limit, Integer offset, boolean excludeTilted, boolean excludeNonLatest)	Retrieves the list of Relationships currently in the system for which the given Item is either a leftItem or a rightItem object
List<Relationship>	RelationshipService.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 NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft, int limit, int offset)	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 NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, boolean isLeft, int limit, int offset, boolean excludeNonLatest)	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 NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, int limit, int offset)	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 NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByItemAndRelationshipType(Context context, Item item, RelationshipType relationshipType, int limit, int offset, boolean excludeNonLatest)	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 NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByItemRelationshipTypeAndRelatedList(Context context, UUID focusUUID, RelationshipType relationshipType, List<UUID> items, boolean isLeft, int offset, int limit)	This method is used to retrieve relationships that match focusItem on the one hand and matches list of related items elsewhere.
List<Relationship>	RelationshipService.findByRelationshipType(Context context, RelationshipType relationshipType)	This method returns a list of Relationship objects for which the relationshipType property is equal to the given RelationshipType object NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByRelationshipType(Context context, RelationshipType relationshipType, Integer limit, Integer offset)	This method returns a list of Relationship objects for which the relationshipType property is equal to the given RelationshipType object NOTE: tilted relationships are NEVER excluded when fetching one relationship type
List<Relationship>	RelationshipService.findByTypeName(Context context, String typeName)	This method returns a list of Relationship objects for the given typeName
List<Relationship>	RelationshipService.findByTypeName(Context context, String typeName, Integer limit, Integer offset)	This method returns a list of Relationship objects for the given typeName
List<Relationship>	EntityService.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<Relationship>	EntityService.getRelationsByTypeName(Context context, String typeName)	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<Relationship>	EntityService.getRelationsByTypeName(Context context, String typeName, Integer limit, Integer offset)	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<Relationship>	EntityService.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

Methods in org.dspace.content.service with parameters of type Relationship

Modifier and Type	Method	Description
Relationship	RelationshipService.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
void	RelationshipService.delete(Context context, Relationship relationship, boolean copyToLeftItem, boolean copyToRightItem)	This method is used to delete a Relationship whilst given the possibility to copy the Virtual Metadata created by this relationship to the left and/or right item
void	RelationshipService.forceDelete(Context context, Relationship relationship, boolean copyToLeftItem, boolean copyToRightItem)	This method is used to delete a Relationship whilst given the possibility to copy the Virtual Metadata created by this relationship to the left and/or right item.
Relationship	RelationshipService.move(Context context, Relationship relationship, Integer newLeftPlace, Integer newRightPlace)	Move the given relationship to a new leftPlace and/or rightPlace.
Relationship	RelationshipService.move(Context context, Relationship relationship, Item newLeftItem, Item newRightItem)	Move the given relationship to a new leftItem and/or rightItem.

Uses of Relationship in org.dspace.versioning

Methods in org.dspace.versioning that return Relationship

Modifier and Type	Method	Description
protected Relationship	VersioningConsumer.getMatchingRelationship(Item latestItem, boolean isLeft, Relationship previousItemRelationship, List<Relationship> relationships)	From a list of relationships, find the relationship with the correct relationship type and items.
protected Relationship	VersioningConsumer.getMatchingRelationship(Item expectedLeftItem, RelationshipType expectedRelationshipType, Item expectedRightItem, List<Relationship> relationships)	Find the relationship with the given left item, relation type and right item, from a list of relationships.

Methods in org.dspace.versioning that return types with arguments of type Relationship

Modifier and Type	Method	Description
protected List<Relationship>	VersioningConsumer.getAllRelationships(Context ctx, Item item, RelationshipType relationshipType)	Get all relationships of the given type linked to the given item.

Methods in org.dspace.versioning with parameters of type Relationship

Modifier and Type	Method	Description
protected Relationship	VersioningConsumer.getMatchingRelationship(Item latestItem, boolean isLeft, Relationship previousItemRelationship, List<Relationship> relationships)	From a list of relationships, find the relationship with the correct relationship type and items.
protected void	VersioningConsumer.reindexRelationship(Context ctx, RelationshipVersioningUtils.LatestVersionStatusChangelog changelog, Relationship relationship)	If the latestVersionStatus of the relationship has changed, an "item modified" event should be fired for both the left and right item of the relationship.

Method parameters in org.dspace.versioning with type arguments of type Relationship

Modifier and Type	Method	Description
protected Relationship	VersioningConsumer.getMatchingRelationship(Item latestItem, boolean isLeft, Relationship previousItemRelationship, List<Relationship> relationships)	From a list of relationships, find the relationship with the correct relationship type and items.
protected Relationship	VersioningConsumer.getMatchingRelationship(Item expectedLeftItem, RelationshipType expectedRelationshipType, Item expectedRightItem, List<Relationship> relationships)	Find the relationship with the given left item, relation type and right item, from a list of relationships.

Uses of Relationship in org.dspace.versioning.utils

Methods in org.dspace.versioning.utils with parameters of type Relationship

Modifier and Type	Method	Description
RelationshipVersioningUtils.LatestVersionStatusChangelog	RelationshipVersioningUtils.updateLatestVersionStatus(Relationship relationship, boolean updateLeftSide, boolean isLatest)	Update latestVersionStatus of the given relationship.