com.atlassian.crowd.model.role
Interface RoleMembershipDAO

All Superinterfaces:

ObjectDao

All Known Implementing Classes:

RoleMembershipDAOHibernate

public interface RoleMembershipDAO
extends ObjectDao

Persistance methods necessary to modify an InternalDirectory membership.

Method Summary

RemoteRoleMembership	add(RemoteRoleMembership membership) Add the membership to the database.
BatchResult<RemoteRoleMembership>	addAll(java.util.Set<RemoteRoleMembership> memberships) Add a collection of memberships.
RemoteRoleMembership	findMembership(RemoteRole role, RemotePrincipal principal) Finds the membership (if any) for the specified role and principal.
java.util.List<RemoteRoleMembership>	findMemberships(RemotePrincipal principal) Finds all the memberships for the specified principal.
java.util.List<RemoteRoleMembership>	findMemberships(RemoteRole role) Finds all the memberships for the specified role.
void	remove(RemoteRoleMembership membership) Remove the role-principal membership.
void	removeAll(RemotePrincipal principal) Remove all the role membersips from a principal.
void	removeAll(RemoteRole role) Remove all the principal members from a role.

Methods inherited from interface com.atlassian.crowd.util.persistence.hibernate.ObjectDao

getPersistentClass, load, remove, save, update

Method Detail

findMemberships

java.util.List<RemoteRoleMembership> findMemberships(RemoteRole role)

Finds all the memberships for the specified role.

Parameters:

role - role's memberships to find.

Returns:

memberships for the role.

findMemberships

java.util.List<RemoteRoleMembership> findMemberships(RemotePrincipal principal)

Finds all the memberships for the specified principal.

Parameters:

principal - principal's memberships to find.

Returns:

memberships for the role.

findMembership

RemoteRoleMembership findMembership(RemoteRole role,
                                    RemotePrincipal principal)
                                    throws ObjectNotFoundException

Finds the membership (if any) for the specified role and principal.

Parameters:

role - role forming membership.

principal - principal forming memebership.

Returns:

memberhsip object representing the role-principal membership.

Throws:

ObjectNotFoundException - if the principal is not a member of the role.

add

RemoteRoleMembership add(RemoteRoleMembership membership)

Add the membership to the database. If a membership already exists, no error is reported.

Parameters:

membership - role-principal membership.

Returns:

memberhsip object representing the role-principal membership.

remove

void remove(RemoteRoleMembership membership)

Remove the role-principal membership.

Parameters:

membership - object representing the role-principal membership.

removeAll

void removeAll(RemoteRole role)

Remove all the principal members from a role.

Parameters:

role - role to clear memberships from.

removeAll

void removeAll(RemotePrincipal principal)

Remove all the role membersips from a principal.

Parameters:

principal - principal to clear memberships from.

addAll

BatchResult<RemoteRoleMembership> addAll(java.util.Set<RemoteRoleMembership> memberships)

Add a collection of memberships. If a membership already exists, no error is reported.

Parameters:

memberships - memberships to add.

Returns:

a batch result indicating the memberships that failed to be added.