org.bimserver.models.store.Checkout 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.CheckoutRelated;
import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Checkout'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.Checkout#getUser User}
 *   {@link org.bimserver.models.store.Checkout#getRevision Revision}
 *   {@link org.bimserver.models.store.Checkout#getProject Project}
 *   {@link org.bimserver.models.store.Checkout#getDate Date}
 *   {@link org.bimserver.models.store.Checkout#getCheckin Checkin}
 *   {@link org.bimserver.models.store.Checkout#getActive Active}
 *   {@link org.bimserver.models.store.Checkout#getLogs Logs}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getCheckout()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface Checkout 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#getCheckout_User()
	 * @model
	 * @generated
	 */
	User getUser();

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

	/**
	 * Returns the value of the 'Revision' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.Revision#getCheckouts Checkouts}'.
	 * 
	 * 
	 * If the meaning of the 'Revision' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Revision' reference.
	 * @see #setRevision(Revision)
	 * @see org.bimserver.models.store.StorePackage#getCheckout_Revision()
	 * @see org.bimserver.models.store.Revision#getCheckouts
	 * @model opposite="checkouts"
	 * @generated
	 */
	Revision getRevision();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.Checkout#getRevision Revision}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Revision' reference.
	 * @see #getRevision()
	 * @generated
	 */
	void setRevision(Revision value);

	/**
	 * Returns the value of the 'Project' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.Project#getCheckouts Checkouts}'.
	 * 
	 * 
	 * If the meaning of the 'Project' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Project' reference.
	 * @see #setProject(Project)
	 * @see org.bimserver.models.store.StorePackage#getCheckout_Project()
	 * @see org.bimserver.models.store.Project#getCheckouts
	 * @model opposite="checkouts"
	 * @generated
	 */
	Project getProject();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.Checkout#getProject Project}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Project' reference.
	 * @see #getProject()
	 * @generated
	 */
	void setProject(Project value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.Checkout#getDate Date}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Date' attribute.
	 * @see #getDate()
	 * @generated
	 */
	void setDate(Date value);

	/**
	 * Returns the value of the 'Checkin' reference.
	 * 
	 * 
	 * If the meaning of the 'Checkin' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Checkin' reference.
	 * @see #setCheckin(Revision)
	 * @see org.bimserver.models.store.StorePackage#getCheckout_Checkin()
	 * @model
	 * @generated
	 */
	Revision getCheckin();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.Checkout#getCheckin Checkin}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Checkin' reference.
	 * @see #getCheckin()
	 * @generated
	 */
	void setCheckin(Revision value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.Checkout#getActive Active}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Active' attribute.
	 * @see #getActive()
	 * @generated
	 */
	void setActive(Boolean value);

	/**
	 * Returns the value of the 'Logs' reference list.
	 * The list contents are of type {@link org.bimserver.models.log.CheckoutRelated}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.log.CheckoutRelated#getCheckout Checkout}'.
	 * 
	 * 
	 * If the meaning of the 'Logs' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Logs' reference list.
	 * @see org.bimserver.models.store.StorePackage#getCheckout_Logs()
	 * @see org.bimserver.models.log.CheckoutRelated#getCheckout
	 * @model opposite="checkout"
	 * @generated
	 */
	EList getLogs();

} // Checkout