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: IDynamicMembership.java,v 1.4 2008/06/25 05:41:45 qcheng Exp $
026 *
027 */
028
029package com.iplanet.ums;
030
031/**
032 * Represents a container interface common to groups and roles. It extends
033 * IMembership by adding support for adding and removing members.
034 * 
035 * @see com.iplanet.ums.IMembership
036 * @supported.api
037 */
038public interface IDynamicMembership extends IMembership {
039
040    /**
041     * Sets the search filter used to evaluate this dynamic group.
042     * 
043     * @param filter
044     *            search filter for evaluating members of the group
045     *
046     * @supported.api
047     */
048    public void setSearchFilter(String filter);
049
050    /**
051     * Gets the search filter used to evaluate this dynamic group.
052     * 
053     * @return search filter for evaluating members of the group
054     *
055     * @supported.api
056     */
057    public String getSearchFilter();
058
059    /**
060     * Sets the search base used to evaluate this dynamic group.
061     * 
062     * @param baseGuid Search base for evaluating members of the group.
063     *
064     * @supported.api
065     */
066    public void setSearchBase(Guid baseGuid);
067
068    /**
069     * Gets the search base used to evaluate this dynamic group.
070     * 
071     * @return search base for evaluating members of the group
072     *
073     * @supported.api
074     */
075    public Guid getSearchBase();
076
077    /**
078     * Sets the search scope used to evaluate this dynamic group.
079     * 
080     * @param scope Search scope for evaluating members of the group. Use one of
081     *        the <code>LDAPv2</code> scopes: <code>SCOPE_BASE</code>,
082     *        <code>SCOPE_ONE</code>, or <code>SCOPE_SUB</code>.
083     *
084     * @supported.api
085     */
086    public void setSearchScope(int scope);
087
088    /**
089     * Gets the search scope used to evaluate this dynamic group.
090     * 
091     * @return search scope for evaluating members of the group
092     *
093     * @supported.api
094     */
095    public int getSearchScope();
096}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.