rapture.common.api.UserApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.version.ApiVersion;
import rapture.common.model.RaptureUser;


@SuppressWarnings("all")
public interface UserApi {
     /**
     * Returns account information for the current user.
     * 
     */
     RaptureUser getWhoAmI(CallingContext context);

     /**
     * Logs out the active user and terminates the current session.
     * 
     */
     void logoutUser(CallingContext context);

     /**
     * Stores application preferences for the current user.
     * 
     */
     void storePreference(CallingContext context, String category, String name, String content);

     /**
     * Retrieves application preferences for the current user.
     * 
     */
     String getPreference(CallingContext context, String category, String name);

     /**
     * Removes a previously stored preference.
     * 
     */
     void removePreference(CallingContext context, String category, String name);

     /**
     * This method will list the categories of preferences available for a user.
     * 
     */
     List getPreferenceCategories(CallingContext context);

     /**
     * This method will list the preference documents in a category.
     * 
     */
     List getPreferencesInCategory(CallingContext context, String category);

     /**
     * Updates the description for the current user.
     * 
     */
     RaptureUser updateMyDescription(CallingContext context, String description);

     /**
     * Changes the password for the current user.
     * 
     */
     RaptureUser changeMyPassword(CallingContext context, String oldHashPassword, String newHashPassword);

     /**
     * Changes the email for the current user.
     * 
     */
     RaptureUser changeMyEmail(CallingContext context, String newAddress);

     /**
     * Retrieves the API version currently in use.
     * 
     */
     ApiVersion getServerApiVersion(CallingContext context);

     /**
     * A method to check whether the current user is allowed to make the API call. Useful
     * for the UI so that it can determine whether or not to show a particular item.
     * 
     */
     Boolean isPermitted(CallingContext context, String apiCall, String callParam);

}