public interface Group extends Authorizable
Authorizable
s.Modifier and Type | Method and Description |
---|---|
boolean |
addMember(@NotNull Authorizable authorizable)
Add a member to this Group.
|
@NotNull java.util.Set<java.lang.String> |
addMembers(java.lang.String... memberIds)
Add one or more member(s) to this Group.
|
@NotNull java.util.Iterator<Authorizable> |
getDeclaredMembers() |
@NotNull java.util.Iterator<Authorizable> |
getMembers() |
boolean |
isDeclaredMember(@NotNull Authorizable authorizable)
Test whether an
Authorizable is a declared member of this group. |
boolean |
isMember(@NotNull Authorizable authorizable) |
boolean |
removeMember(@NotNull Authorizable authorizable)
Remove a member from this Group.
|
@NotNull java.util.Set<java.lang.String> |
removeMembers(java.lang.String... memberIds)
Remove one or several members from this Group.
|
declaredMemberOf, getID, getPath, getPrincipal, getProperty, getPropertyNames, getPropertyNames, hasProperty, isGroup, memberOf, remove, removeProperty, setProperty, setProperty
@NotNull @NotNull java.util.Iterator<Authorizable> getDeclaredMembers() throws RepositoryException
Authorizable
s which are declared
members of this Group.RepositoryException
- If an error occurs.@NotNull @NotNull java.util.Iterator<Authorizable> getMembers() throws RepositoryException
Authorizable
s which are members of
this Group. This includes both declared members and all authorizables
that are indirect group members.RepositoryException
- If an error occurs.boolean isDeclaredMember(@NotNull @NotNull Authorizable authorizable) throws RepositoryException
Authorizable
is a declared member of this group.authorizable
- The Authorizable
to test.true
if the Authorizable to test is a direct memberRepositoryException
- If an error occurs.boolean isMember(@NotNull @NotNull Authorizable authorizable) throws RepositoryException
authorizable
- The Authorizable
to test.RepositoryException
- If an error occurs.boolean addMember(@NotNull @NotNull Authorizable authorizable) throws RepositoryException
authorizable
- The Authorizable
to be added as
member to this group.Authorizable
has successfully been added
to this Group, false otherwise (e.g. unknown implementation
or if it already is a member or if the passed authorizable is this
group itself or for some implementation specific constraint).RepositoryException
- If an error occurs.@NotNull @NotNull java.util.Set<java.lang.String> addMembers(@NotNull java.lang.String... memberIds) throws RepositoryException
Authorizable
s as new members. Also an implementation may choose to
(partially) postpone validation/verification util Session.save()
.memberIds
- The Id
s of the authorizables to be added as
members to this group.memberIds
that could not be added or an
empty set of all ids have been successfully processed. The former may include
those cases where a given id cannot be resolved to an existing authorizable,
one that is already member or if adding the member would create a
cyclic group membership.RepositoryException
- If one of the specified memberIds is invalid or
if some other error occurs.boolean removeMember(@NotNull @NotNull Authorizable authorizable) throws RepositoryException
authorizable
- The Authorizable
to be removed from
the list of group members.RepositoryException
- If an error occurs.@NotNull @NotNull java.util.Set<java.lang.String> removeMembers(@NotNull java.lang.String... memberIds) throws RepositoryException
Session.save()
.memberIds
- The Id
s of the authorizables to be removed
from the members of this group.memberIds
that could not be removed or an
empty set if all ids have been successfully processed. The former may include
those cases where a given id cannot be resolved to an existing authorizable.RepositoryException
- If one of the specified memberIds is invalid
or if some other error occurs.Copyright © 2010 - 2020 Adobe. All Rights Reserved