/**
* Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright ownership. Apereo
* licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the License at the
* following location:
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>Unless required by applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apereo.portal.portlets.swapper;
import java.util.Set;
import org.jasig.services.persondir.IPersonAttributes;
import org.springframework.webflow.context.ExternalContext;
/**
* Defines helper methods for the attribute-swapper flow.
*
*/
public interface IAttributeSwapperHelper {
/**
* Portlet preference name to use to specify a List of attributes that will be displayed for the
* user to work with.
*/
public static final String ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES =
"attribute-swapper.attributesForm.swappableAttributes";
/**
* Portlet preference name to use to specify a List of attributes that will be displayed for the
* user to work with.
*/
public static final String ATTRIBUTE_SWAPPER_ATTRIBUTES_FORM_SWAPPABLE_ATTRIBUTES_EXCLUDES =
"attribute-swapper.attributesForm.swappableAttributes.exclude";
/**
* Gets the Set of attributes to allow the user to swap values for.
*
* @param externalContext The {@link ExternalContext} to get the flows's configuration from
* @return Set of attributes that can be swapped
*/
public Set<String> getSwappableAttributes(ExternalContext externalContext);
/**
* Get the base attributes for a person, this bypasses the overwriting dao.
*
* @param uid The user name of the user to get the attributes for.
* @return The original (non overwritten) attributes.
*/
public IPersonAttributes getOriginalUserAttributes(String uid);
/**
* Initialize the command object used for the swapper form.
*
* @param externalContext The {@link ExternalContext} to get the flows's configuration from
* @param attributeSwapRequest The command object to initialize
*/
public void populateSwapRequest(
ExternalContext externalContext, AttributeSwapRequest attributeSwapRequest);
/**
* Perform the attribute swap request.
*
* @param externalContext The {@link ExternalContext} to get the current user from
* @param attributeSwapRequest The swap request with the new attributes
*/
public void swapAttributes(
ExternalContext externalContext, AttributeSwapRequest attributeSwapRequest);
/**
* Removes the swapped attributes for the specified user
*
* @param externalContext The {@link ExternalContext} to get the current user from
*/
public void resetAttributes(ExternalContext externalContext);
}