RevisionLogRevisionEntityMetadataBuilder.java

/*
 * gvNIX is an open source tool for rapid application development (RAD).
 * Copyright (C) 2010 Generalitat Valenciana
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 <http://www.gnu.org/licenses/>.
 */
package org.gvnix.addon.jpa.addon.audit.providers;

import org.gvnix.support.ItdBuilderHelper;
import org.springframework.roo.classpath.details.ItdTypeDetailsBuilder;
import org.springframework.roo.model.JavaType;

/**
 * Interface provider by {@link RevisionLogProvider} which produces required
 * artifacts for the entity annotated with
 * {@link org.gvnix.addon.jpa.audit.GvNIXJpaAuditRevisionEntity} to handle
 * revisionLog functionality.
 * 
 * @author <a href="http://www.disid.com">DISID Corporation S.L.</a> made for <a
 *         href="http://www.dgti.gva.es">General Directorate for Information
 *         Technologies (DGTI)</a>
 * @since 1.3.0
 */
public interface RevisionLogRevisionEntityMetadataBuilder {

    /**
     * Initializes builder with commons required objects
     * 
     * @param builder
     * @param context
     */
    void initialize(ItdTypeDetailsBuilder builder, Context context);

    /**
     * Clean builder commons objects
     */
    void done();

    /**
     * Fill revision entity with required artifacts
     */
    void fillEntity();

    /**
     * Interface which contains generation time metadata information required by
     * RevisionLogRevisionEntityMetadataBuilder
     * 
     * @author <a href="http://www.disid.com">DISID Corporation S.L.</a> made
     *         for <a href="http://www.dgti.gva.es">General Directorate for
     *         Information Technologies (DGTI)</a>
     */
    public interface Context {

        /**
         * @return the helper
         */
        public ItdBuilderHelper getHelper();

        /**
         * @return metadataId
         */
        public String getMetadataId();

        /**
         * @return entity
         */
        public JavaType getEntity();

        /**
         * @return class to use to store "user" information
         */
        public JavaType getUserType();

        /**
         * @return class which provider the current user
         */
        public JavaType getUserService();

        /**
         * @return if class which provider the current user is a application JPA
         *         entity
         */
        public boolean getUserTypeIsEntity();

        /**
         * @return if class which provider the current user implements Spring
         *         Security UserDetail interface
         */
        public boolean getUserTypeIsUserDetails();

        /**
         * @return true if timestamp field uses date/time pattern or uses style
         *         if false
         */
        public boolean usePatternForTimestamp();

        /**
         * @return timestamp field date/time pattern to use
         */
        public String getPatternForTimestamp();

        /**
         * @return timestamp field style to use
         */
        public String getTimestampStyle();

    }

}