org.dspace.app.ldn.service.NotifyServiceInboundPatternService 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.app.ldn.service;

import java.sql.SQLException;
import java.util.List;

import org.dspace.app.ldn.NotifyServiceEntity;
import org.dspace.app.ldn.NotifyServiceInboundPattern;
import org.dspace.core.Context;

/**
 * Service interface class for the {@link NotifyServiceInboundPattern} object.
 *
 * @author Mohamed Eskander (mohamed.eskander at 4science.com)
 */
public interface NotifyServiceInboundPatternService {

    /**
     * find all notifyServiceInboundPatterns matched with
     * the provided notifyServiceEntity and pattern
     *
     * @param context the context
     * @param notifyServiceEntity the notifyServiceEntity
     * @param pattern the pattern
     * @return all notifyServiceInboundPatterns matched with
     * the provided notifyServiceEntity and pattern
     * @throws SQLException if database error
     */
    public NotifyServiceInboundPattern findByServiceAndPattern(Context context,
                                                               NotifyServiceEntity notifyServiceEntity,
                                                               String pattern) throws SQLException;

    /**
     * find all automatic notifyServiceInboundPatterns
     *
     * @param context the context
     * @return all automatic notifyServiceInboundPatterns
     * @throws SQLException if database error
     */
    public List findAutomaticPatterns(Context context) throws SQLException;

    /**
     * create new notifyServiceInboundPattern
     *
     * @param context the context
     * @param notifyServiceEntity the notifyServiceEntity
     * @return the created notifyServiceInboundPattern
     * @throws SQLException if database error
     */
    public NotifyServiceInboundPattern create(Context context, NotifyServiceEntity notifyServiceEntity)
        throws SQLException;

    /**
     * update the provided notifyServiceInboundPattern
     *
     * @param context the context
     * @param inboundPattern the notifyServiceInboundPattern
     * @throws SQLException if database error
     */
    public void update(Context context, NotifyServiceInboundPattern inboundPattern) throws SQLException;

    /**
     * delete the provided notifyServiceInboundPattern
     *
     * @param context the context
     * @param inboundPattern the notifyServiceInboundPattern
     * @throws SQLException if database error
     */
    public void delete(Context context, NotifyServiceInboundPattern inboundPattern) throws SQLException;
}