org.efaps.admin.datamodel.IAttributeDefinitionStore Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * 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.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.admin.datamodel;

import java.io.InputStream;
import java.io.OutputStream;

import org.efaps.db.Context;
import org.efaps.db.Instance;
import org.efaps.util.EFapsException;

/**
 * The interface describes the needed methods for using a file store.
 *
 * @author The eFaps Team
 * @version $Id: IAttributeDefinitionStore.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public interface IAttributeDefinitionStore
{
    /**
     * @param _context  eFaps context for this request
     * @param _instance eFaps instance itself for which the file is checked out
     * @param _fileName name of the file to check in
     * @param _in       file represented by input stream
     * @throws EFapsException if check in failed
     */
    void checkin(final Context _context,
                 final Instance _instance,
                 final String _fileName,
                 final InputStream _in)
        throws EFapsException;

    /**
     * Returns the file name for the file representing.
     *
     * @param _context  eFaps context for this request
     * @param _instance eFaps instance itself for which the file is checked out
     * @return found file name
     * @throws EFapsException if fetching of the file name failed
     */
    String getFileName(final Context _context,
                       final Instance _instance)
        throws EFapsException;

    /**
     * @param _context  eFaps context for this request
     * @param _instance eFaps instance itself for which the file is checked out
     * @param _out      output stream to write the file in
     * @throws EFapsException if check out failed
     */
    void checkout(final Context _context,
                  final Instance _instance,
                  final OutputStream _out)
        throws EFapsException;
}