Package org.dspace.content

Interface RelationshipMetadataService

All Known Implementing Classes:

RelationshipMetadataServiceImpl

public interface RelationshipMetadataService

Interface used for the RelationshipMetadataServiceImpl This will define methods regarding the RelationshipMetadata

Method Summary

Modifier and Type	Method	Description
List<RelationshipMetadataValue>	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.
String	getEntityTypeStringFromMetadata(Item item)	Deprecated. use ItemService.getEntityTypeLabel(Item) instead.
List<RelationshipMetadataValue>	getRelationshipMetadata(Item item, boolean enableVirtualMetadata)	This method retrieves a list of MetadataValue objects that get constructed from processing the given Item's Relationships through the config given to the VirtualMetadataPopulator

Method Detail

getRelationshipMetadata

List<RelationshipMetadataValue> getRelationshipMetadata(Item item,
                                                        boolean enableVirtualMetadata)

This method retrieves a list of MetadataValue objects that get constructed from processing the given Item's Relationships through the config given to the VirtualMetadataPopulator

Parameters:

item - The Item that will be processed through it's Relationships

enableVirtualMetadata - This parameter will determine whether the list of Relationship metadata should be populated with metadata that is being generated through the VirtualMetadataPopulator functionality or not

Returns:

The list of MetadataValue objects constructed through the Relationships

findRelationshipMetadataValueForItemRelationship

List<RelationshipMetadataValue> findRelationshipMetadataValueForItemRelationship(Context context,
                                                                                 Item item,
                                                                                 String entityType,
                                                                                 Relationship relationship,
                                                                                 boolean enableVirtualMetadata)
                                                                          throws SQLException

Retrieves the list of RelationshipMetadataValue objects specific to only one Relationship of the item. This method processes one Relationship of an Item and will return a list of RelationshipMetadataValue objects that are generated for this specific relationship for the item through the config in VirtualMetadataPopulator It returns a combination of the output of the findVirtualMetadataFromConfiguration method and the getRelationMetadataFromOtherItem method.

Parameters:

context - The context

item - The item whose virtual metadata is requested

entityType - The entity type of the given item

relationship - The relationship whose virtual metadata is requested

enableVirtualMetadata - Determines whether the VirtualMetadataPopulator should be used. If false, only the relation."relationname" metadata is populated If true, fields from the spring config virtual metadata is included as well

Returns:

The list of virtual metadata values

Throws:

SQLException

getEntityTypeStringFromMetadata

@Deprecated
String getEntityTypeStringFromMetadata(Item item)

Deprecated.

use ItemService.getEntityTypeLabel(Item) instead.

This method will retrieve the EntityType String from an item

Parameters:

item - The Item for which the entityType String will be returned

Returns:

A String value indicating the entityType