at.molindo.notify.dao.INotificationDAO Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of molindo-notify Show documentation

Extensible notification framework

The newest version!

/**
 * Copyright 2010 Molindo GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package at.molindo.notify.dao;

import java.util.Date;
import java.util.List;
import java.util.Set;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;

import at.molindo.notify.model.Notification;
import at.molindo.notify.model.Notification.Type;
import at.molindo.notify.model.PushState;

public interface INotificationDAO {

	void save(@Nonnull Notification notification);

	void update(@Nonnull Notification notification);

	void delete(@Nonnull Notification notification);

	/**
	 * Delete all notifications with pushDate older than maxAge and with the
	 * given PushState.
	 *
	 * @param maxAge
	 * @param statesToDelete
	 *            states to delete, omit to delete all states
	 * @return amount of deleted notifications
	 */
	int deleteAll(Date maxAge, PushState... statesToDelete);

	/**
	 * @return next notification from push queue
	 */
	Notification getNext();

	/**
	 * @return recent notifications for userId (pull)
	 */
	@Nonnull
	List getRecent(@Nonnull String userId, @Nonnull Set types, @Nonnegative int first,
			@Nonnegative int count);

	Notification getByConfirmationKey(String key);

}