org.craftercms.commons.audit.AuditService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-audit Show documentation

Crafter Commons Audit

There is a newer version: 4.2.0

Show newest version

/*
 * Copyright (C) 2007-2020 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package org.craftercms.commons.audit;

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

/**
 * Defines  Basic Audit Service.
 * @param  Any Object that Extents AuditModel.
 */
public abstract class AuditService {
    /**
     * Sets date and persist the Audit in the repository.
     *
     * @param auditModel Audit to be save.
     */
    public void audit(final T auditModel) {
        persistAudit(auditModel);
    }

    /**
     * Gets the audit log for its Id.
     * @param id It of the audit log.
     * @return Audit log with the given id, null if not found.
     */
    public abstract T getAuditLog(final String id);

    /**
     * Defines the actual save of the audit to the given audit repository.
     *
     * @param auditModel Audit to be save.
     */
    protected abstract void persistAudit(final T auditModel);

    /**
     * Deletes all audits where its it is in the given List.
     *
     * @param auditId List of audits id to delete.
     */
    protected abstract void deleteAudits(final List auditId);

    /**
     * Returns all Audits starting the given date.
     *
     * @param from Date when the Audit was logged.
     * @return List all audits where logged date is after or the given date.Empty if nothing is found
     */
    public abstract List getAuditLogs(final Date from);

    /**
     * Returns all Audits where logged date is between the given dates.
     *
     * @param from Start Date range.(including)
     * @param to   End of Date range.(including)
     * @return List of audits that were logged between the given date range.Empty if nothing match.
     */
    public abstract List getAuditLogs(final Date from, final Date to);
}