com.sap.security.api
Interface IPrincipalSet

All Superinterfaces:

IPrincipal, IPrincipalMaint, java.io.Serializable

All Known Subinterfaces:

IGroup, IRole

public interface IPrincipalSet

extends IPrincipalMaint

This interface provides read and write access to attributes and the state of an IPrincipalSet object. IPrincipalSet extends IPrincipalMaint.

Version:

1.0

Field Summary

static java.lang.String

VERSIONSTRING

Fields inherited from interface com.sap.security.api.IPrincipal

BYTE_TYPE, DEFAULT_NAMESPACE, DEFAULT_RELATION_NAMESPACE, DESCRIPTION, DISPLAYNAME, PRINCIPAL_CREATION_DATE, PRINCIPAL_MODIFY_DATE, PRINCIPAL_RELATION_MEMBER_ATTRIBUTE, PRINCIPAL_RELATION_PARENT_ATTRIBUTE, STRING_TYPE, TRANSIENT_NAMESPACE, UNIQUE_NAME

Method Summary

boolean	addMember(java.lang.String newMember) Add the specified member to the collection.
java.util.Iterator	getMembers(boolean getChildMembers) Returns principals belonging to this collection
boolean	isMember(java.lang.String uniqueIdOfPrincipal, boolean recursive) Returns true if the passed principal is a member of the collection.
boolean	removeMember(java.lang.String oldMember) Remove the specified member from the collection.

Methods inherited from interface com.sap.security.api.IPrincipalMaint

commit, isModified, rollback, save, setAttribute, setBinaryAttribute, setDisplayName

Methods inherited from interface com.sap.security.api.IPrincipal

created, equals, getAttribute, getAttributeNames, getAttributeNamespaces, getAttributeType, getBinaryAttribute, getDisplayName, getParents, getUniqueID, hashCode, isExistenceChecked, isMutable, lastModified, refresh

Field Detail

VERSIONSTRING

public static final java.lang.String VERSIONSTRING

Method Detail

getMembers

public java.util.Iterator getMembers(boolean getChildMembers)

Returns principals belonging to this collection

Parameters:

getChildMembers: - This method does a recursive search if the parameter getChildMembers is set to true.

Returns:

iterator of Strings of uniqueIds of this principal set

isMember

public boolean isMember(java.lang.String uniqueIdOfPrincipal,
                        boolean recursive)

Returns true if the passed principal is a member of the collection. This method does a recursive search if parameter recursive is set to true. If a principal belongs to a collection which is a member of this collection, true is returned.

Parameters:

uniqueIdOfPrincipal - - the uniqueId of the principal whose membership is to be checked.

recursive. - If set to true a recursive search is done.

Returns:

true if the principal is a member of this collection, false otherwise.

addMember

public boolean addMember(java.lang.String newMember)
                  throws UMException

Add the specified member to the collection. After setting the appropriate data this object must be commited to the principal store via IPrincipalMaint.commit().

Parameters:

newMember - - the uniqueId of the object to add to this collection.

Returns:

:true if the member was successfully added.

Throws:

UMException - if an error occurs

removeMember

public boolean removeMember(java.lang.String oldMember)
                     throws UMException

Remove the specified member from the collection. After setting the appropriate data this object must be commited to the user store via IPrincipalMaint.commit().

Parameters:

oldMember - - the uniqueId of the object to remove from this collection.

Returns:

:true if the member was successfully removed

Throws:

UMException - if an error occurs