trunk/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ProtectedItem.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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. 
 *  
 */
package org.apache.directory.api.ldap.aci;


import org.apache.directory.api.ldap.aci.protectedItem.AllUserAttributeTypesAndValuesItem;
import org.apache.directory.api.ldap.aci.protectedItem.AllUserAttributeTypesItem;
import org.apache.directory.api.ldap.aci.protectedItem.EntryItem;


/**
 * Defines the items to which the access controls apply.  It's one of the
 * following elements :
 * <ul>
 * <li>AllAttributeValuesItem</li>
 * <li>AllUserAttributeTypesAndValuesItem</li>
 * <li>AllUserAttributeTypesItem</li>
 * <li>AttributeTypeItem</li>
 * <li>AttributeValueItem</li>
 * <li>ClassesItem</li>
 * <li>EntryItem</li>
 * <li>MaxImmSubItem</li>
 * <li>MaxValueCountItem</li>
 * <li>RangeOfValuesItem</li>
 * <li>RestrictedByItem</li>
 * <li>SelfValueItem</li>
 * </ul>
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public abstract class ProtectedItem
{
    /**
     * The entry contents as a whole. In case of a family member, it also means
     * the entry content of each subordinate family member within the same
     * compound attribute. It does not necessarily include the information in
     * these entries. This element shall be ignored if the classes element is
     * present, since this latter element selects protected entries (and
     * subordinate family members) on the basis of their object class.
     */
    public static final EntryItem ENTRY = new EntryItem();

    /**
     * All user attribute type information associated with the entry, but not
     * values associated with those attributes.
     */
    public static final AllUserAttributeTypesItem ALL_USER_ATTRIBUTE_TYPES = new AllUserAttributeTypesItem();

    /**
     * All user attribute information associated with the entry, including all
     * values of all user attributes.
     */
    public static final AllUserAttributeTypesAndValuesItem ALL_USER_ATTRIBUTE_TYPES_AND_VALUES = new AllUserAttributeTypesAndValuesItem();


    /**
     * Creates a new instance.
     */
    protected ProtectedItem()
    {
    }
}