org.efaps.db.PrintQuery 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.db;

import java.util.ArrayList;
import java.util.List;

import org.efaps.admin.access.AccessTypeEnums;
import org.efaps.admin.datamodel.Type;
import org.efaps.util.EFapsException;

/**
 * PrintQuery is a query uses to get the value for one object, specified by one
 * instance. The PrintQuery is able to execute various of the parts for the
 * select from EQL definition.
 *
 * TODO description!
 * TODO .value
 * TODO .attribute[ValueUOM].number
 * .attribute[ValueUOM].uom .attribute[ValueUOM].base
 *
 * @author The eFaps Team
 * @version $Id: PrintQuery.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public class PrintQuery extends AbstractPrintQuery
{

    /**
     * Instance this PrintQuery is based on.
     */
    private final Instance instance;

    /**
     * Initializes this print query depending on a _type and
     * _id.
     *
     * @param _type     type of the eFaps object to print
     * @param _id       id of the eFaps object to print
     * @throws EFapsException on error
     */
    public PrintQuery(final Type _type,
                      final String _id)
        throws EFapsException
    {
        this(Instance.get(_type, _id));
    }

    /**
     * Initializes this print query depending on a _type and
     * _id.
     *
     * @param _type     type of the eFaps object to print
     * @param _id       id of the eFaps object to print
     * @throws EFapsException on error
     */
    public PrintQuery(final Type _type,
                      final long _id)
        throws EFapsException
    {
        this(Instance.get(_type, _id));
    }

    /**
     * Initializes this print query depending on a _type and
     * _id.
     *
     * @param _type     type of the eFaps object to print
     * @param _id       id of the eFaps object to print
     * @throws EFapsException on error
     */
    public PrintQuery(final String _type,
                      final String _id)
        throws EFapsException
    {
        this(Instance.get(_type, _id));
    }

    /**
     * @param _oid OID of the instance to be updated.
     * @throws EFapsException on error
     */
    public PrintQuery(final String _oid)
        throws EFapsException
    {
        this(Instance.get(_oid));
    }

    /**
     * @param _instance instance to be updated.
     * @throws EFapsException on error
     */
    public PrintQuery(final Instance _instance)
        throws EFapsException
    {
        this.instance = _instance;
    }

    /**
     * Getter method for instance variable {@link #instance}.
     *
     * @return value of instance variable {@link #instance}
     */
    public Instance getInstance()
    {
        return this.instance;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Type getMainType()
    {
        return this.instance.getType();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Instance getCurrentInstance()
    {
        return this.instance;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public List getInstanceList()
    {
        final List ret = new ArrayList();
        ret.add(this.instance);
        return ret;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean execute() throws EFapsException
    {
        boolean ret = false;
        if (isMarked4execute()) {
            if (getMainType().hasAccess(this.instance, AccessTypeEnums.SHOW.getAccessType())) {
                ret = executeWithoutAccessCheck();
            }
        }
        return ret;
    }
}