org.ogce.purse.api
Interface RegistrationModule

public interface RegistrationModule

This interface provides a way for additional accounting systems to plug into the PURSe portlets.

Version:

$Revision: 1.1.1.1 $

Author:

Marcus Christie

Field Summary

static int	STATUS_ACCOUNT_NONE User does not have this sub account.
static int	STATUS_ACCOUNT_OK User successfully has this sub account.
static int	STATUS_ACCOUNT_PENDING User is waiting on getting this sub account.

Method Summary

java.lang.String	getName()
int	getStatus(org.globus.purse.registration.UserData userData) Return one of the status codes for this user.
void	init(javax.servlet.ServletContext servletContext)
void	onEvent(PurseEvent event) Handle a PURSe lifecycle event.

Field Detail

STATUS_ACCOUNT_OK

static final int STATUS_ACCOUNT_OK

User successfully has this sub account.

See Also:

Constant Field Values

STATUS_ACCOUNT_NONE

static final int STATUS_ACCOUNT_NONE

User does not have this sub account.

See Also:

Constant Field Values

STATUS_ACCOUNT_PENDING

static final int STATUS_ACCOUNT_PENDING

User is waiting on getting this sub account.

See Also:

Constant Field Values

Method Detail

init

void init(javax.servlet.ServletContext servletContext)

onEvent

void onEvent(PurseEvent event)
             throws PurseEventException

Handle a PURSe lifecycle event. This is where the main guts of the registration module resides.

Parameters:

event - A PURSe lifecycle event.

Throws:

PurseEventException

getName

java.lang.String getName()

Returns:

A descriptive, user-visible name for this registration module.

getStatus

int getStatus(org.globus.purse.registration.UserData userData)

Return one of the status codes for this user.

Parameters:

userData - The PURSe UserData object.

Returns:

status code