org.bedework.calsvci

Interface UsersI

All Superinterfaces:

Serializable

public interface UsersI
extends Serializable

Interface for handling bedework user objects.

Author:

Mike Douglass

Method Summary

Modifier and Type	Method and Description
void	add(String account) Add an entry for the user.
BwPrincipal	getAlways(String val) Find the user with the given account name.
BwPrincipal	getPrincipal(String val) Find the principal with the given account path.
List<String>	getPrincipalHrefs(int start, int count) Get a partial list of principal hrefs.
BwPrincipal	getPublicUser()
BwPrincipal	getUser(String val) Find the user with the given account name.
void	initPrincipal(BwPrincipal principal) Set up collections and principal home.
void	logon(BwPrincipal val) Can be called after init to flag the arrival of a user.
void	remove(BwPrincipal pr) Remove a principal.
void	update(BwPrincipal principal) Update a principal.

Method Detail

getUser

BwPrincipal getUser(String val)
             throws CalFacadeException

Find the user with the given account name.

Parameters:

val - String user id

Returns:

User principal or null if not there

Throws:

CalFacadeException

getAlways

BwPrincipal getAlways(String val)
               throws CalFacadeException

Find the user with the given account name. Create if not there.

Parameters:

val - String user id

Returns:

BwUser representing the user

Throws:

CalFacadeException

getPrincipal

BwPrincipal getPrincipal(String val)
                  throws CalFacadeException

Find the principal with the given account path.

Parameters:

val - String principal hierarchy path

Returns:

BwPrincipal representing the principal or null if not there

Throws:

CalFacadeException

add

void add(String account)
  throws CalFacadeException

Add an entry for the user.

Parameters:

account -

Throws:

CalFacadeException

update

void update(BwPrincipal principal)
     throws CalFacadeException

Update a principal.

Parameters:

principal -

Throws:

CalFacadeException

remove

void remove(BwPrincipal pr)
     throws CalFacadeException

Remove a principal. This will delete all traces of the principal from the system.

Parameters:

pr -

Throws:

CalFacadeException

logon

void logon(BwPrincipal val)
    throws CalFacadeException

Can be called after init to flag the arrival of a user.

Parameters:

val - principal logging on

Throws:

CalFacadeException

initPrincipal

void initPrincipal(BwPrincipal principal)
            throws CalFacadeException

Set up collections and principal home.

Parameters:

principal -

Throws:

CalFacadeException

getPublicUser

BwPrincipal getPublicUser()

Returns:

public entity owner

getPrincipalHrefs

List<String> getPrincipalHrefs(int start,
                               int count)
                        throws CalFacadeException

Get a partial list of principal hrefs.

Parameters:

start - Position to start

count - Number we want

Returns:

list of hrefs - null for no more

Throws:

CalFacadeException