BasicUser.java

/**
 * 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:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.jasig.portlet.blackboardvcportlet.data;

import java.io.Serializable;
import java.util.Set;

public interface BasicUser extends Serializable {
    /**
     * Globally unique identifier for the user in the portal, if this
     * field is null the user is external
     */
    String getUniqueId();

    /**
     * Email address to use for notifications for the user
     */
    String getEmail();
    
    /**
     * Additional email addresses the user has been invited to sessions with
     */
    Set<String> getAdditionalEmails();
    
    /**
     * Name displayed in the UI and in BlackBoard
     */
    String getDisplayName();
}