com.atlassian.jira.association
Interface UserAssociationStore

All Known Implementing Classes:

UserAssociationStoreImpl

public interface UserAssociationStore

This Store is used to work with relationships between Users and other objects.

Since:

v4.3

Method Summary

boolean	associationExists(String associationType, com.atlassian.crowd.embedded.api.User user, org.ofbiz.core.entity.GenericValue sink) Tests if the given association exists.
boolean	associationExists(String associationType, com.atlassian.crowd.embedded.api.User user, String sinkNodeEntity, Long sinkNodeId) Tests if the given association exists.
void	createAssociation(String associationType, String userName, String sinkNodeEntity, Long sinkNodeId) Creates an association between a user and a sink node.
void	createAssociation(String associationType, com.atlassian.crowd.embedded.api.User user, org.ofbiz.core.entity.GenericValue sink) Creates an association between a user and a sink node.
List<org.ofbiz.core.entity.GenericValue>	getSinksFromUser(String associationType, com.atlassian.crowd.embedded.api.User user, String sinkNodeEntity) Returns all the sinks that are associated with the given User.
List<String>	getUsernamesFromSink(String associationType, org.ofbiz.core.entity.GenericValue sink) Finds and returns a list of usernames associated with a given sink.
List<com.atlassian.crowd.embedded.api.User>	getUsersFromSink(String associationType, org.ofbiz.core.entity.GenericValue sink) Finds and returns a list of Users associated with a given sink.
void	removeAssociation(String associationType, String username, org.ofbiz.core.entity.GenericValue sink) Removes an association between a user and a sink node.
void	removeAssociation(String associationType, com.atlassian.crowd.embedded.api.User user, org.ofbiz.core.entity.GenericValue sink) Removes an association between a user and a sink node.
void	removeUserAssociationsFromUser(String associationType, com.atlassian.crowd.embedded.api.User user, String sinkNodeEntity) Removes all User Associations for this User of the given associationType

Method Detail

associationExists

boolean associationExists(String associationType,
                          com.atlassian.crowd.embedded.api.User user,
                          org.ofbiz.core.entity.GenericValue sink)

Tests if the given association exists.

Parameters:

associationType - the Association type

user - the User

sink - the sink node

Returns:

true if the given association exists.

associationExists

boolean associationExists(String associationType,
                          com.atlassian.crowd.embedded.api.User user,
                          String sinkNodeEntity,
                          Long sinkNodeId)

Tests if the given association exists.

Parameters:

associationType - the Association type

user - the User

sinkNodeEntity - The entity name of the sink node (eg "Issue").

sinkNodeId - The id of the sink node.

Returns:

true if the given association exists.

getUsernamesFromSink

List<String> getUsernamesFromSink(String associationType,
                                  org.ofbiz.core.entity.GenericValue sink)

Finds and returns a list of usernames associated with a given sink.

Parameters:

associationType - the Association type

sink - the sink node

Returns:

a list of associated usernames (never null)

getSinksFromUser

List<org.ofbiz.core.entity.GenericValue> getSinksFromUser(String associationType,
                                                          com.atlassian.crowd.embedded.api.User user,
                                                          String sinkNodeEntity)

Returns all the sinks that are associated with the given User.

Parameters:

associationType - the Association type

user - the User

sinkNodeEntity - The entity name of the sink node (eg "Issue").

Returns:

all the sinks that are associated with the given User.

getUsersFromSink

List<com.atlassian.crowd.embedded.api.User> getUsersFromSink(String associationType,
                                                             org.ofbiz.core.entity.GenericValue sink)

Finds and returns a list of Users associated with a given sink.

Parameters:

associationType - the Association type

sink - the sink node

Returns:

a list of associated Users (never null)

createAssociation

void createAssociation(String associationType,
                       com.atlassian.crowd.embedded.api.User user,
                       org.ofbiz.core.entity.GenericValue sink)

Creates an association between a user and a sink node.

Parameters:

associationType - the Association type

user - the user to associate with the sink node.

sink - the sink node

createAssociation

void createAssociation(String associationType,
                       String userName,
                       String sinkNodeEntity,
                       Long sinkNodeId)

Creates an association between a user and a sink node.

Parameters:

associationType - the Association type

userName - the user name to associate with the sink node.

sinkNodeEntity - the entity name of the sink node

sinkNodeId - the id of the sink node entity

removeAssociation

void removeAssociation(String associationType,
                       String username,
                       org.ofbiz.core.entity.GenericValue sink)

Removes an association between a user and a sink node.

Parameters:

associationType - the Association type

username - the user to associate with the sink node.

sink - the sink node

removeAssociation

void removeAssociation(String associationType,
                       com.atlassian.crowd.embedded.api.User user,
                       org.ofbiz.core.entity.GenericValue sink)

Removes an association between a user and a sink node.

Parameters:

associationType - the Association type

user - the user to associate with the sink node.

sink - the sink node

removeUserAssociationsFromUser

void removeUserAssociationsFromUser(String associationType,
                                    com.atlassian.crowd.embedded.api.User user,
                                    String sinkNodeEntity)

Removes all User Associations for this User of the given associationType

Parameters:

associationType - the Association type

user - the User

sinkNodeEntity - The entity name of the sink node (eg "Issue").