com.belladati.sdk.user.UserInfo Maven / Gradle / Ivy

Go to download
package com.belladati.sdk.user;

import com.belladati.sdk.exception.server.InvalidStreamException;
import com.belladati.sdk.util.ResourceInfo;

/**
 * Information object about a BellaDati user. To retrieve user details, call
 * {@link #loadDetails()}.
 * 
 * @author Chris Hennigfeld
 */
public interface UserInfo extends ResourceInfo {

	/**
	 * Returns the user's full display name.
	 * 
	 * @return the user's full display name
	 */
	String getName();

	/**
	 * Loads the associated user's profile image. The Java type of the image
	 * being returned depends on the implementation.
	 * 
	 * @return the associated user's profile image
	 * @throws InvalidStreamException if no image exists or it cannot be loaded
	 */
	Object loadImage() throws InvalidStreamException;

	/**
	 * Loads the current active status of the user from BellaDati.
	 * 
	 * @return the current active status of the user
	 */
	String loadStatus();

	/**
	 * Posts the new active status of the user to BellaDati.
	 * 
	 * @param status the new active status of the user
	 */
	void postStatus(String status);

}