org.bimserver.models.store.UserSession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of PluginBase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
There is a newer version: 2.0.0
/**
 * Copyright (C) 2009-2014 BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.bimserver.models.store;

import java.util.Date;

import org.bimserver.emf.IdEObject;
import org.bimserver.models.log.AccessMethod;

/**
 * 
 * A representation of the model object 'User Session'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.UserSession#getUser User}
 *   {@link org.bimserver.models.store.UserSession#getUsername Username}
 *   {@link org.bimserver.models.store.UserSession#getName Name}
 *   {@link org.bimserver.models.store.UserSession#getType Type}
 *   {@link org.bimserver.models.store.UserSession#getRemoteAddress Remote Address}
 *   {@link org.bimserver.models.store.UserSession#getActiveSince Active Since}
 *   {@link org.bimserver.models.store.UserSession#getLastActive Last Active}
 *   {@link org.bimserver.models.store.UserSession#getAccessMethod Access Method}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getUserSession()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface UserSession extends IdEObject {
	/**
	 * Returns the value of the 'User' reference.
	 * 
	 * 
	 * If the meaning of the 'User' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User' reference.
	 * @see #setUser(User)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_User()
	 * @model
	 * @generated
	 */
	User getUser();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getUser User}' reference.
	 * 
	 * 
	 * @param value the new value of the 'User' reference.
	 * @see #getUser()
	 * @generated
	 */
	void setUser(User value);

	/**
	 * Returns the value of the 'Username' attribute.
	 * 
	 * 
	 * If the meaning of the 'Username' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Username' attribute.
	 * @see #setUsername(String)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_Username()
	 * @model
	 * @generated
	 */
	String getUsername();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getUsername Username}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Username' attribute.
	 * @see #getUsername()
	 * @generated
	 */
	void setUsername(String value);

	/**
	 * Returns the value of the 'Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Name' attribute.
	 * @see #setName(String)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_Name()
	 * @model
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getName Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Name' attribute.
	 * @see #getName()
	 * @generated
	 */
	void setName(String value);

	/**
	 * Returns the value of the 'Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.store.UserType}.
	 * 
	 * 
	 * If the meaning of the 'Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Type' attribute.
	 * @see org.bimserver.models.store.UserType
	 * @see #setType(UserType)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_Type()
	 * @model
	 * @generated
	 */
	UserType getType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getType Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Type' attribute.
	 * @see org.bimserver.models.store.UserType
	 * @see #getType()
	 * @generated
	 */
	void setType(UserType value);

	/**
	 * Returns the value of the 'Remote Address' attribute.
	 * 
	 * 
	 * If the meaning of the 'Remote Address' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Remote Address' attribute.
	 * @see #setRemoteAddress(String)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_RemoteAddress()
	 * @model
	 * @generated
	 */
	String getRemoteAddress();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getRemoteAddress Remote Address}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Remote Address' attribute.
	 * @see #getRemoteAddress()
	 * @generated
	 */
	void setRemoteAddress(String value);

	/**
	 * Returns the value of the 'Active Since' attribute.
	 * 
	 * 
	 * If the meaning of the 'Active Since' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Active Since' attribute.
	 * @see #setActiveSince(Date)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_ActiveSince()
	 * @model
	 * @generated
	 */
	Date getActiveSince();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getActiveSince Active Since}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Active Since' attribute.
	 * @see #getActiveSince()
	 * @generated
	 */
	void setActiveSince(Date value);

	/**
	 * Returns the value of the 'Last Active' attribute.
	 * 
	 * 
	 * If the meaning of the 'Last Active' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Last Active' attribute.
	 * @see #setLastActive(Date)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_LastActive()
	 * @model
	 * @generated
	 */
	Date getLastActive();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getLastActive Last Active}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Last Active' attribute.
	 * @see #getLastActive()
	 * @generated
	 */
	void setLastActive(Date value);

	/**
	 * Returns the value of the 'Access Method' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.log.AccessMethod}.
	 * 
	 * 
	 * If the meaning of the 'Access Method' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Access Method' attribute.
	 * @see org.bimserver.models.log.AccessMethod
	 * @see #setAccessMethod(AccessMethod)
	 * @see org.bimserver.models.store.StorePackage#getUserSession_AccessMethod()
	 * @model
	 * @generated
	 */
	AccessMethod getAccessMethod();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSession#getAccessMethod Access Method}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Access Method' attribute.
	 * @see org.bimserver.models.log.AccessMethod
	 * @see #getAccessMethod()
	 * @generated
	 */
	void setAccessMethod(AccessMethod value);

} // UserSession