source: trunk/src/core/net/sf/basedb/core/filter-def.hbm.xml @ 6037

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC
    "-//Hibernate/Hibernate Mapping DTD 3.0//EN" 
    "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
<!--
  $Id: filter-def.hbm.xml 6037 2012-03-29 09:50:36Z nicklas $

  Copyright (C) 2005 Nicklas Nordborg
  Copyright (C) 2006 Jari Häkkinen

  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/

  BASE 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.

  BASE 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 BASE. If not, see <http://www.gnu.org/licenses/>.
  Foundation, Inc., 59 Temp le Place - Suite 330,
-->
<!--
  This XML file contains predefined filters used
  by queries for filtering out items to which the logged
  in user doesn't have access. The actual filter expressions are
  added to the configuration by HibernateUtil.addFilterConditions().
  The filter are applied at runtime by classes created by the 
  QueryRuntimeFilterFactory.
-->
<hibernate-mapping>
  <!--
    Do not return any items, since the user has been denied
    to all of them.
  -->
  <filter-def name="denyAll">
  </filter-def>

  <!-- 
    Filter Removable items on the isRemoved status 
    Typical condition is ":removed = removed"
  -->
  <filter-def name="isRemoved">
    <filter-param name="removed" type="boolean" />
  </filter-def>
  
  <!-- 
    Filter Annotatable items on the presense/absense of annotations 
    Typical condition is ":annotated = (`annotationset_id` IS NULL)"
  -->
  <filter-def name="isAnnotated">
    <filter-param name="annotated" type="boolean" />
  </filter-def>
  
  <!-- 
    Filter Ownable items on the owner to only return
    items owned by the logged in user. 
    Typical condition is ":owner = owner"
  -->
  <filter-def name="ownedBy">
    <filter-param name="owner" type="int" />
  </filter-def>

  <!-- 
    Filter Ownable items on the owner to only return
    items NOT owned by the logged in user. 
    Typical condition is ":owner != owner"
  -->
  <filter-def name="notOwnedBy">
    <filter-param name="owner" type="int" />
  </filter-def>

  <!-- 
    Filter items on the id to only return
    items that the logged in user is a member of.
    Typical condition is ":owner != owner AND id IN (:items)"
  -->
  <filter-def name="memberOf">
    <filter-param name="owner" type="int" />
    <filter-param name="items" type="int" />
  </filter-def>
  
  <!-- 
    Filter items on the owner and id
    to only return items where the logged in user is the owner or
    a member.  
    Typical condition is ":owner = owner OR id IN (:items)"
  -->
  <filter-def name="ownedByOrMemberOf">
    <filter-param name="owner" type="int" />
    <filter-param name="items" type="int" />
  </filter-def>

  <!-- 
    Filter Shareable items on the item key to only return
    items that are shared to the logged in user.
    Typical condition is ":owner != owner AND itemkey_id IN (:itemKeys)"
  -->
  <filter-def name="sharedTo">
    <filter-param name="owner" type="int" />
    <filter-param name="itemKeys" type="int" />
  </filter-def>

  <!-- 
    Filter Shareable items on the owner and item key 
    to only return items owned by or shared to
    the logged in user 
    Typical condition is ":owner = owner OR itemkey_id IN (:itemKeys)"
  -->
  <filter-def name="ownedByOrSharedTo">
    <filter-param name="owner" type="int" />
    <filter-param name="itemKeys" type="int" />
  </filter-def>

  <!-- 
    Filter Shareable items on the active project 
    to only return items shared to the active project.
    Typical condition is "projectkey_id IN (:projectKeys)"
  -->
  <filter-def name="inProject">
    <filter-param name="owner" type="int" />
    <filter-param name="projectKeys" type="int" />
  </filter-def>

  <!-- 
    Filter Shareable items on the owner and the active project 
    to only return items owned by logged in user or shared to
    the active project.
    Typical condition is ":owner = owner OR projectkey_id IN (:projectKeys)"
  -->
  <filter-def name="ownedByOrInProject">
    <filter-param name="owner" type="int" />
    <filter-param name="projectKeys" type="int" />
  </filter-def>

  <!-- 
    Filter Shareable items on the item key and the active project 
    to only return items shared to the logged in user or to
    the active project.
    Typical condition is "(:owner != owner AND itemkey_id IN (:itemKeys)) OR projectkey_id IN (:projectKeys)"
  -->
  <filter-def name="sharedToOrInProject">
    <filter-param name="owner" type="int" />
    <filter-param name="itemKeys" type="int" />
    <filter-param name="projectKeys" type="int" />
  </filter-def>

  <!-- 
    Filter Shareable items on the owner, item key and the active project 
    to only return items owned by or shared to the logged in user, or shared to
    the active project.
    Typical condition is ":owner = owner OR itemkey_id IN (:itemKeys) OR projectkey_id IN (:projectKeys)"
  -->
  <filter-def name="ownedByOrSharedToOrInProject">
    <filter-param name="owner" type="int" />
    <filter-param name="itemKeys" type="int" />
    <filter-param name="projectKeys" type="int" />
  </filter-def>

  <!-- 
    Filter News on todays date.
    Typical condition is ":today >= start_date AND (:today <= end_date OR end_date IS NULL)"
  -->
  <filter-def name="todaysNews">
    <filter-param name="today" type="date" />
  </filter-def>
  
  <!-- 
    Filter annotations on annotation types. This is needed so that
    only annotations that a user has access to can be loaded.
    Typical condition is: "`annotationtype_id` IN (:annotationTypes)"
  -->
  <filter-def name="annotationTypes">
    <filter-param name="annotationTypes" type="int" />
  </filter-def>
</hibernate-mapping>