org.dspace.subscriptions.SubscriptionEmailNotificationConfiguration 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.

The newest version!

/**
 * 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.subscriptions;

import java.util.Objects;

import org.apache.commons.cli.Options;
import org.dspace.scripts.DSpaceRunnable;
import org.dspace.scripts.configuration.ScriptConfiguration;

/**
 * Implementation of {@link DSpaceRunnable} to find subscribed objects and send notification mails about them
 */
public class SubscriptionEmailNotificationConfiguration extends ScriptConfiguration {

    private Class dspaceRunnableClass;

    @Override
    public Options getOptions() {
        if (Objects.isNull(options)) {
            Options options = new Options();
            options.addOption("f", "frequency", true,
                              "Subscription frequency. Valid values include: D (Day), W (Week) and M (Month)");
            options.getOption("f").setRequired(true);
            super.options = options;
        }
        return options;
    }

    @Override
    public Class getDspaceRunnableClass() {
        return dspaceRunnableClass;
    }

    @Override
    public void setDspaceRunnableClass(Class dspaceRunnableClass) {
        this.dspaceRunnableClass = dspaceRunnableClass;
    }

}