Added relevant JavaDocs to public methods in altered classes

This commit is contained in:
Raf Ponsaerts
2018-10-26 08:48:33 +02:00
parent af94859404
commit eb0ea9a6bf
2 changed files with 28 additions and 0 deletions

View File

@@ -1268,6 +1268,27 @@ prevent the generation of resource policy entry values with null dspace_object a
return false; return false;
} }
/**
* This method will return a list of MetadataValue objects that contains all the regular
* metadata of the item passed along in the parameters as well as all the virtual metadata
* which will be generated and processed together with the {@link VirtualMetadataPopulator}
* by processing the item's relationships
* @param item the Item to be processed
* @param schema the schema for the metadata field. <em>Must</em> match
* the <code>name</code> of an existing metadata schema.
* @param element the element name. <code>DSpaceObject.ANY</code> matches any
* element. <code>null</code> doesn't really make sense as all
* metadata must have an element.
* @param qualifier the qualifier. <code>null</code> means unqualified, and
* <code>DSpaceObject.ANY</code> means any qualifier (including
* unqualified.)
* @param lang the ISO639 language code, optionally followed by an underscore
* and the ISO3166 country code. <code>null</code> means only
* values with no language are returned, and
* <code>DSpaceObject.ANY</code> means values with any country code or
* no country code are returned.
* @return
*/
@Override @Override
public List<MetadataValue> getMetadata(Item item, String schema, String element, String qualifier, String lang) { public List<MetadataValue> getMetadata(Item item, String schema, String element, String qualifier, String lang) {
List<MetadataValue> dbMetadataValues = super.getMetadata(item, schema, element, qualifier, lang); List<MetadataValue> dbMetadataValues = super.getMetadata(item, schema, element, qualifier, lang);

View File

@@ -26,6 +26,7 @@ import org.dspace.content.MetadataField;
import org.dspace.content.MetadataValue; import org.dspace.content.MetadataValue;
import org.dspace.content.Thumbnail; import org.dspace.content.Thumbnail;
import org.dspace.content.WorkspaceItem; import org.dspace.content.WorkspaceItem;
import org.dspace.content.virtual.VirtualMetadataPopulator;
import org.dspace.core.Context; import org.dspace.core.Context;
import org.dspace.eperson.EPerson; import org.dspace.eperson.EPerson;
import org.dspace.eperson.Group; import org.dspace.eperson.Group;
@@ -641,6 +642,12 @@ public interface ItemService extends DSpaceObjectService<Item>, DSpaceObjectLega
*/ */
boolean isInProgressSubmission(Context context, Item item) throws SQLException; boolean isInProgressSubmission(Context context, Item item) throws SQLException;
/**
* This method retrieves a list of MetadataValue objects that get constructed from processing
* the given Item's Relationships through the config given to the {@link VirtualMetadataPopulator}
* @param item The Item that will be processed through it's Relationships
* @return The list of MetadataValue objects constructed through the Relationships
*/
public List<MetadataValue> getRelationshipMetadata(Item item); public List<MetadataValue> getRelationshipMetadata(Item item);
} }