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: IMembership.java,v 1.3 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.
033 *
034 * @supported.all.api
035 */
036public interface IMembership {
037    /**
038     * Gets the members of the group.
039     * 
040     * @return Iterator for unique identifiers in the group
041     *        
042     */
043    public SearchResults getMemberIDs() throws UMSException;
044
045    /**
046     * Gets the member count of the group.
047     * 
048     * @return number of members in the group
049     */
050    public int getMemberCount() throws UMSException;
051
052    /**
053     * Gets a member.
054     * 
055     * @return the guid unique identifier for a member
056     */
057    public Guid getMemberIDAt(int index) throws UMSException;
058
059    /**
060     * Checks if a given identifier is a member of the group.
061     * 
062     * @param guid
063     *            identity of member to be checked for membership
064     * @return <code>true </code>if it is a member
065     * @exception UMSException
066     *                on failure to evaluate membership
067     */
068    public boolean hasMember(Guid guid) throws UMSException;
069}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.