org.dspace.app.sherpa.v2.SHERPAPermittedVersion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
There is a newer version: 8.0
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.app.sherpa.v2;

import java.util.List;

/**
 * Plain java representation of a SHERPA Permitted Version object, based on SHERPA API v2 responses.
 *
 * In a SHERPA search for journal deposit policies, this data is contained within a publisher policy.
 * Each permitted version is for a particular article version (e.g. submitted, accepted, published) and contains:
 *
 * 
 *   A list of general conditions / terms for deposit of this version of work
 *   A list of allowed locations (e.g. institutional repository, personal homepage, non-commercial repository)
 *   A list of prerequisite conditions for deposit (e.g. attribution, linking to published version)
 *   A list of required licenses for the deposited work (e.g. CC-BY-NC)
 *   Embargo requirements, if any
 * 
 *
 * This class also has some helper data for labels, which can be used with i18n
 * when displaying policy information.
 *
 * @see SHERPAPublisherPolicy
 */
public class SHERPAPermittedVersion {

    // Version (submitted, accepted, published)
    private String articleVersion;

    // Option number
    private int option;

    // General conditions
    private List conditions;
    // Prerequisites (eg. if required by funder)
    private List prerequisites;
    // Allowed locations
    private List locations;
    // Required license(s)
    private List licenses;
    // Embargo
    private SHERPAEmbargo embargo;

    protected static class SHERPAEmbargo {
        String units;
        int amount;
    }

    public String getArticleVersion() {
        return articleVersion;
    }

    public void setArticleVersion(String articleVersion) {
        this.articleVersion = articleVersion;
    }

    public List getConditions() {
        return conditions;
    }

    public void setConditions(List conditions) {
        this.conditions = conditions;
    }

    public List getPrerequisites() {
        return prerequisites;
    }

    public void setPrerequisites(List prerequisites) {
        this.prerequisites = prerequisites;
    }

    public List getLocations() {
        return locations;
    }

    public void setLocations(List locations) {
        this.locations = locations;
    }

    public List getLicenses() {
        return licenses;
    }

    public void setLicenses(List licenses) {
        this.licenses = licenses;
    }

    public SHERPAEmbargo getEmbargo() {
        return embargo;
    }

    public void setEmbargo(SHERPAEmbargo embargo) {
        this.embargo = embargo;
    }

    public int getOption() {
        return option;
    }

    public void setOption(int option) {
        this.option = option;
    }

}