com.atlassian.jira.security.roles
Interface DefaultRoleActors

All Known Subinterfaces:
ProjectRoleActors
All Known Implementing Classes:
DefaultRoleActorsImpl, ProjectRoleActorsImpl

@PublicApi
public interface DefaultRoleActors

This interface defines the association between a ProjectRole and a collection of default Actors. Actors associated with a ProjectRole in this way will be used to populate the ProjectRoleActors association when a new project is created within JIRA.

Note: implementations must be immutable.


Method Summary
 DefaultRoleActors addRoleActor(RoleActor roleActor)
          Add the RoleActor to the contained set of RoleActors and return a new DefaultRoleActors with the modified set
 DefaultRoleActors addRoleActors(Collection<RoleActor> roleActors)
          Add the collection of RoleActors to the contained set of RoleActors and return a new DefaultRoleActors with the modified set
 boolean contains(com.atlassian.crowd.embedded.api.User user)
          Does the collection of RoleActor instances contain the specified user.
 Long getProjectRoleId()
           
 Set<RoleActor> getRoleActors()
           
 Set<RoleActor> getRoleActorsByType(String type)
           
 Set<com.atlassian.crowd.embedded.api.User> getUsers()
           
 DefaultRoleActors removeRoleActor(RoleActor roleActor)
          Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set
 DefaultRoleActors removeRoleActors(Collection<RoleActor> roleActors)
          Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set
 

Method Detail

getUsers

Set<com.atlassian.crowd.embedded.api.User> getUsers()

getRoleActors

Set<RoleActor> getRoleActors()

getProjectRoleId

Long getProjectRoleId()

getRoleActorsByType

Set<RoleActor> getRoleActorsByType(String type)

contains

boolean contains(com.atlassian.crowd.embedded.api.User user)
Does the collection of RoleActor instances contain the specified user.

Parameters:
user - the user to check if they are contained
Returns:
true if the user is matched by this RoleActor

addRoleActor

DefaultRoleActors addRoleActor(RoleActor roleActor)
Add the RoleActor to the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters:
roleActor - the RoleActor to add
Returns:
a copy of this DefaultRoleActors with the added RoleActor in its set of RoleActors

addRoleActors

DefaultRoleActors addRoleActors(Collection<RoleActor> roleActors)
Add the collection of RoleActors to the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters:
roleActors - the collection RoleActor to add
Returns:
a copy of this DefaultRoleActors with the added RoleActors in its set of RoleActors

removeRoleActor

DefaultRoleActors removeRoleActor(RoleActor roleActor)
Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters:
roleActor - the RoleActor to remove
Returns:
a copy of this DefaultRoleActors with the removed RoleActor in its set of RoleActors, may be this if unchanged

removeRoleActors

DefaultRoleActors removeRoleActors(Collection<RoleActor> roleActors)
Remove the RoleActor from the contained set of RoleActors and return a new DefaultRoleActors with the modified set

Parameters:
roleActors - the RoleActor to add
Returns:
a copy of this DefaultRoleActors with the removed RoleActors in its set of RoleActors, may be this if unchanged.


Copyright © 2002-2013 Atlassian. All Rights Reserved.