org.bimserver.models.store.ProjectSmall 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 org.bimserver.emf.IdEObject;

/**
 * 
 * A representation of the model object 'Project Small'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.ProjectSmall#getName Name}
 *   {@link org.bimserver.models.store.ProjectSmall#getParentId Parent Id}
 *   {@link org.bimserver.models.store.ProjectSmall#getState State}
 *   {@link org.bimserver.models.store.ProjectSmall#getNrRevisions Nr Revisions}
 *   {@link org.bimserver.models.store.ProjectSmall#getNrSubProjects Nr Sub Projects}
 *   {@link org.bimserver.models.store.ProjectSmall#isHasCheckinRights Has Checkin Rights}
 *   {@link org.bimserver.models.store.ProjectSmall#getLastRevisionId Last Revision Id}
 *   {@link org.bimserver.models.store.ProjectSmall#getSchema Schema}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getProjectSmall()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface ProjectSmall extends IdEObject {
	/**
	 * 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#getProjectSmall_Name()
	 * @model
	 * @generated
	 */
	String getName();

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

	/**
	 * Returns the value of the 'Parent Id' attribute.
	 * 
	 * 
	 * If the meaning of the 'Parent Id' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Parent Id' attribute.
	 * @see #setParentId(long)
	 * @see org.bimserver.models.store.StorePackage#getProjectSmall_ParentId()
	 * @model
	 * @generated
	 */
	long getParentId();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#getParentId Parent Id}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Parent Id' attribute.
	 * @see #getParentId()
	 * @generated
	 */
	void setParentId(long value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#getState State}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'State' attribute.
	 * @see org.bimserver.models.store.ObjectState
	 * @see #getState()
	 * @generated
	 */
	void setState(ObjectState value);

	/**
	 * Returns the value of the 'Nr Revisions' attribute.
	 * 
	 * 
	 * If the meaning of the 'Nr Revisions' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Nr Revisions' attribute.
	 * @see #setNrRevisions(int)
	 * @see org.bimserver.models.store.StorePackage#getProjectSmall_NrRevisions()
	 * @model
	 * @generated
	 */
	int getNrRevisions();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#getNrRevisions Nr Revisions}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Nr Revisions' attribute.
	 * @see #getNrRevisions()
	 * @generated
	 */
	void setNrRevisions(int value);

	/**
	 * Returns the value of the 'Nr Sub Projects' attribute.
	 * 
	 * 
	 * If the meaning of the 'Nr Sub Projects' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Nr Sub Projects' attribute.
	 * @see #setNrSubProjects(int)
	 * @see org.bimserver.models.store.StorePackage#getProjectSmall_NrSubProjects()
	 * @model
	 * @generated
	 */
	int getNrSubProjects();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#getNrSubProjects Nr Sub Projects}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Nr Sub Projects' attribute.
	 * @see #getNrSubProjects()
	 * @generated
	 */
	void setNrSubProjects(int value);

	/**
	 * Returns the value of the 'Has Checkin Rights' attribute.
	 * 
	 * 
	 * If the meaning of the 'Has Checkin Rights' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Checkin Rights' attribute.
	 * @see #setHasCheckinRights(boolean)
	 * @see org.bimserver.models.store.StorePackage#getProjectSmall_HasCheckinRights()
	 * @model
	 * @generated
	 */
	boolean isHasCheckinRights();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#isHasCheckinRights Has Checkin Rights}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Has Checkin Rights' attribute.
	 * @see #isHasCheckinRights()
	 * @generated
	 */
	void setHasCheckinRights(boolean value);

	/**
	 * Returns the value of the 'Last Revision Id' attribute.
	 * 
	 * 
	 * If the meaning of the 'Last Revision Id' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Last Revision Id' attribute.
	 * @see #setLastRevisionId(long)
	 * @see org.bimserver.models.store.StorePackage#getProjectSmall_LastRevisionId()
	 * @model
	 * @generated
	 */
	long getLastRevisionId();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#getLastRevisionId Last Revision Id}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Last Revision Id' attribute.
	 * @see #getLastRevisionId()
	 * @generated
	 */
	void setLastRevisionId(long value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ProjectSmall#getSchema Schema}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Schema' attribute.
	 * @see #getSchema()
	 * @generated
	 */
	void setSchema(String value);

} // ProjectSmall