edu.cornell.mannlib.vitro.webapp.dao

Interface UserAccountsDao

All Known Implementing Classes:

UserAccountsDaoFiltering, UserAccountsDaoJena

public interface UserAccountsDao

Methods for dealing with UserAccount and PermissionSet objects in the User Accounts model.

Method Summary

Modifier and Type	Method and Description
void	deleteUserAccount(String userAccountUri) Remove the UserAccount with this URI from the model.
Collection<PermissionSet>	getAllPermissionSets() Get all of the PermissionSets in the model, sorted by URI.
Collection<UserAccount>	getAllUserAccounts() Get all of the UserAccounts in the model.
PermissionSet	getPermissionSetByUri(String uri) Get the PermissionSet for this URI.
UserAccount	getUserAccountByEmail(String emailAddress) Get the UserAccount for this Email address.
UserAccount	getUserAccountByExternalAuthId(String externalAuthId) Get the UserAccount for this External Authentication ID
UserAccount	getUserAccountByUri(String uri) Get the UserAccount for this URI.
Collection<UserAccount>	getUserAccountsWhoProxyForPage(String profilePageUri) Get any UserAccounts who act as proxy editors for this profile page.
String	insertUserAccount(UserAccount userAccount) Create a new UserAccount in the model.
void	setProxyAccountsOnProfile(String profilePageUri, Collection<String> userAccountUris) Set so that these UserAccounts, and only these, are authorized as proxies on this profile page.
void	updateUserAccount(UserAccount userAccount) Update the values on a UserAccount that already exists in the model.

Method Detail

getAllUserAccounts

Collection<UserAccount> getAllUserAccounts()

Get all of the UserAccounts in the model.

getUserAccountByUri

UserAccount getUserAccountByUri(String uri)

Get the UserAccount for this URI.

Returns:

null if the URI is null, or if there is no such UserAccount

getUserAccountByEmail

UserAccount getUserAccountByEmail(String emailAddress)

Get the UserAccount for this Email address.

Returns:

null if the Email address is null, or if there is no such UserAccount

getUserAccountByExternalAuthId

UserAccount getUserAccountByExternalAuthId(String externalAuthId)

Get the UserAccount for this External Authentication ID

Returns:

null if the ID is null, or if there is no such UserAccount

getUserAccountsWhoProxyForPage

Collection<UserAccount> getUserAccountsWhoProxyForPage(String profilePageUri)

Get any UserAccounts who act as proxy editors for this profile page.

insertUserAccount

String insertUserAccount(UserAccount userAccount)

Create a new UserAccount in the model. On entry, the URI of the UserAccount should be empty. On exit, the URI which was created for this UserAccount will be stored in the UserAccount, as well as being returned by the method. Does not confirm that PermissionSet objects already exist for the PermissionSet URIs referenced by the UserAcocunt.

Throws:

NullPointerException - if the UserAccount is null.

IllegalArgumentException - if the URI of the UserAccount is not empty.

updateUserAccount

void updateUserAccount(UserAccount userAccount)

Update the values on a UserAccount that already exists in the model. Does not confirm that PermissionSet objects already exist for the PermissionSet URIs referenced by the UserAcocunt.

Throws:

NullPointerException - if the UserAccount is null.

IllegalArgumentException - if a UserAccount with this URI does not already exist in the model.

deleteUserAccount

void deleteUserAccount(String userAccountUri)

Remove the UserAccount with this URI from the model. If the URI is null, or if no UserAccount with this URI is found in the model, no action is taken.

setProxyAccountsOnProfile

void setProxyAccountsOnProfile(String profilePageUri,
                               Collection<String> userAccountUris)

Set so that these UserAccounts, and only these, are authorized as proxies on this profile page.

getPermissionSetByUri

PermissionSet getPermissionSetByUri(String uri)

Get the PermissionSet for this URI.

Returns:

null if the URI is null, or if there is no such PermissionSet.

getAllPermissionSets

Collection<PermissionSet> getAllPermissionSets()

Get all of the PermissionSets in the model, sorted by URI.

Returns:

a collection which might be empty, but is never null.