UserLoggedInEvent.java

/*
 * Copyright (c) 2009 Lockheed Martin Corporation
 *
 * Licensed 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
 *
 *      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.eurekastreams.web.client.events;

import org.eurekastreams.server.domain.Person;

/**
 * Triggered when the client finds out who the current user is. 
 */
public class UserLoggedInEvent
{
    /**
     * Gets an instance of the event.
     * @return the event.
     */
    public static UserLoggedInEvent getEvent()
    {
        return new UserLoggedInEvent(null);
    }
    
    /**
     * The current user. 
     */
    private Person currentUser;
    
    /**
     * @param inUser the current user
     */
    public UserLoggedInEvent(final Person inUser)
    {
        currentUser = inUser;
    }

    /**
     * @return the current user
     */
    public Person getCurrentUser()
    {
        return currentUser;
    }
}