001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: IFilteredMembership.java,v 1.3 2008/06/25 05:41:45 qcheng Exp $
026 *
027 */
028
029package com.iplanet.ums;
030
031/**
032 * Interface that would be implemented by roles that control membership based on
033 * a filter.
034 *
035 * @supported.all.api
036 */
037public interface IFilteredMembership extends IMembership {
038    /**
039     * Sets the filter that controls the membership.
040     * 
041     * @param filter
042     *            an LDAP filter that controls the membership
043     * @throws UMSException
044     *             in case of any error
045     */
046    public void setFilter(String filter) throws UMSException;
047
048    /**
049     * Gets the filter that controls the membership.
050     * 
051     * @return the LDAP filter that controls the membership
052     * @throws UMSException
053     *             in case of any error
054     */
055    public String getFilter() throws UMSException;
056}