org.jasig.portal.portlets.swapper
Interface IAttributeSwapperHelper

All Known Implementing Classes:

AttributeSwapperHelperImpl

public interface IAttributeSwapperHelper

Defines helper methods for the attribute-swapper flow.

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

static String	ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES Portlet preference name to use to specify a List of attributes that will be displayed for the user to work with.
static String	ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES_EXCLUDES Portlet preference name to use to specify a List of attributes that will be displayed for the user to work with.

Method Summary

org.jasig.services.persondir.IPersonAttributes	getOriginalUserAttributes(String uid) Get the base attributes for a person, this bypasses the overwriting dao.
Set<String>	getSwappableAttributes(org.springframework.webflow.context.ExternalContext externalContext) Gets the Set of attribtues to allow the user to swap values for.
void	populateSwapRequest(org.springframework.webflow.context.ExternalContext externalContext, AttributeSwapRequest attributeSwapRequest) Initialize the command object used for the swapper form.
void	resetAttributes(org.springframework.webflow.context.ExternalContext externalContext) Removes the swapped attributes for the specified user
void	swapAttributes(org.springframework.webflow.context.ExternalContext externalContext, AttributeSwapRequest attributeSwapRequest) Perform the attribute swap request.

Field Detail

ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES

static final String ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES

Portlet preference name to use to specify a List of attributes that will be displayed for the user to work with.

See Also:

Constant Field Values

ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES_EXCLUDES

static final String ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES_EXCLUDES

Portlet preference name to use to specify a List of attributes that will be displayed for the user to work with.

See Also:

Constant Field Values

Method Detail

getSwappableAttributes

Set<String> getSwappableAttributes(org.springframework.webflow.context.ExternalContext externalContext)

Gets the Set of attribtues to allow the user to swap values for.

Parameters:

externalContext - The ExternalContext to get the flows's configuration from

Returns:

Set of attributes that can be swapped

getOriginalUserAttributes

org.jasig.services.persondir.IPersonAttributes getOriginalUserAttributes(String uid)

Get the base attributes for a person, this bypasses the overwriting dao.

Parameters:

uid - The user name of the user to get the attributes for.

Returns:

The original (non overwritten) attributes.

populateSwapRequest

void populateSwapRequest(org.springframework.webflow.context.ExternalContext externalContext,
                         AttributeSwapRequest attributeSwapRequest)

Initialize the command object used for the swapper form.

Parameters:

externalContext - The ExternalContext to get the flows's configuration from

attributeSwapRequest - The command object to initialize

swapAttributes

void swapAttributes(org.springframework.webflow.context.ExternalContext externalContext,
                    AttributeSwapRequest attributeSwapRequest)

Perform the attribute swap request.

Parameters:

externalContext - The ExternalContext to get the current user from

attributeSwapRequest - The swap request with the new attributes

resetAttributes

void resetAttributes(org.springframework.webflow.context.ExternalContext externalContext)

Removes the swapped attributes for the specified user

Parameters:

externalContext - The ExternalContext to get the current user from