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

/**
 * 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.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Long Action State'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.LongActionState#getStart Start}
 *   {@link org.bimserver.models.store.LongActionState#getEnd End}
 *   {@link org.bimserver.models.store.LongActionState#getProgress Progress}
 *   {@link org.bimserver.models.store.LongActionState#getState State}
 *   {@link org.bimserver.models.store.LongActionState#getTitle Title}
 *   {@link org.bimserver.models.store.LongActionState#getStage Stage}
 *   {@link org.bimserver.models.store.LongActionState#getErrors Errors}
 *   {@link org.bimserver.models.store.LongActionState#getWarnings Warnings}
 *   {@link org.bimserver.models.store.LongActionState#getInfos Infos}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getLongActionState()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface LongActionState extends IdEObject {
	/**
	 * Returns the value of the 'Start' attribute.
	 * 
	 * 
	 * If the meaning of the 'Start' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Start' attribute.
	 * @see #setStart(Date)
	 * @see org.bimserver.models.store.StorePackage#getLongActionState_Start()
	 * @model
	 * @generated
	 */
	Date getStart();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.LongActionState#getStart Start}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Start' attribute.
	 * @see #getStart()
	 * @generated
	 */
	void setStart(Date value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.LongActionState#getEnd End}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'End' attribute.
	 * @see #getEnd()
	 * @generated
	 */
	void setEnd(Date value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.LongActionState#getProgress Progress}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Progress' attribute.
	 * @see #getProgress()
	 * @generated
	 */
	void setProgress(Integer value);

	/**
	 * Returns the value of the 'State' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.store.ActionState}.
	 * 
	 * 
	 * 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.ActionState
	 * @see #setState(ActionState)
	 * @see org.bimserver.models.store.StorePackage#getLongActionState_State()
	 * @model
	 * @generated
	 */
	ActionState getState();

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

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.LongActionState#getTitle Title}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Title' attribute.
	 * @see #getTitle()
	 * @generated
	 */
	void setTitle(String value);

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

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.LongActionState#getStage Stage}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Stage' attribute.
	 * @see #getStage()
	 * @generated
	 */
	void setStage(int value);

	/**
	 * Returns the value of the 'Errors' attribute list.
	 * The list contents are of type {@link java.lang.String}.
	 * 
	 * 
	 * If the meaning of the 'Errors' attribute list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Errors' attribute list.
	 * @see org.bimserver.models.store.StorePackage#getLongActionState_Errors()
	 * @model
	 * @generated
	 */
	EList getErrors();

	/**
	 * Returns the value of the 'Warnings' attribute list.
	 * The list contents are of type {@link java.lang.String}.
	 * 
	 * 
	 * If the meaning of the 'Warnings' attribute list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Warnings' attribute list.
	 * @see org.bimserver.models.store.StorePackage#getLongActionState_Warnings()
	 * @model
	 * @generated
	 */
	EList getWarnings();

	/**
	 * Returns the value of the 'Infos' attribute list.
	 * The list contents are of type {@link java.lang.String}.
	 * 
	 * 
	 * If the meaning of the 'Infos' attribute list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Infos' attribute list.
	 * @see org.bimserver.models.store.StorePackage#getLongActionState_Infos()
	 * @model
	 * @generated
	 */
	EList getInfos();

} // LongActionState