org.bimserver.models.store.Project Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of PluginBase Show documentation
Show all versions of PluginBase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
/**
* 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
* The following features are supported:
*
*
* - {@link org.bimserver.models.store.Project#getId Id}
* - {@link org.bimserver.models.store.Project#getName Name}
* - {@link org.bimserver.models.store.Project#getHasAuthorizedUsers Has Authorized Users}
* - {@link org.bimserver.models.store.Project#getConcreteRevisions Concrete Revisions}
* - {@link org.bimserver.models.store.Project#getRevisions Revisions}
* - {@link org.bimserver.models.store.Project#getLastConcreteRevision Last Concrete Revision}
* - {@link org.bimserver.models.store.Project#getLastRevision Last Revision}
* - {@link org.bimserver.models.store.Project#getCheckouts Checkouts}
* - {@link org.bimserver.models.store.Project#getState State}
* - {@link org.bimserver.models.store.Project#getCreatedDate Created Date}
* - {@link org.bimserver.models.store.Project#getCreatedBy Created By}
* - {@link org.bimserver.models.store.Project#getGeoTag Geo Tag}
* - {@link org.bimserver.models.store.Project#getSubProjects Sub Projects}
* - {@link org.bimserver.models.store.Project#getParent Parent}
* - {@link org.bimserver.models.store.Project#getDescription Description}
* - {@link org.bimserver.models.store.Project#getExportLengthMeasurePrefix Export Length Measure Prefix}
* - {@link org.bimserver.models.store.Project#getExtendedData Extended Data}
* - {@link org.bimserver.models.store.Project#getServices Services}
* - {@link org.bimserver.models.store.Project#getLogs Logs}
* - {@link org.bimserver.models.store.Project#getModelCheckers Model Checkers}
* - {@link org.bimserver.models.store.Project#getSchema Schema}
* - {@link org.bimserver.models.store.Project#isSendEmailOnNewRevision Send Email On New Revision}
*
*
* @see org.bimserver.models.store.StorePackage#getProject()
* @model
* @extends IdEObject
* @generated
*/
public interface Project extends IdEObject {
/**
* Returns the value of the 'Id' attribute.
*
*
* If the meaning of the 'Id' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Id' attribute.
* @see #setId(Integer)
* @see org.bimserver.models.store.StorePackage#getProject_Id()
* @model
* @generated
*/
Integer getId();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getId Id}' attribute.
*
*
* @param value the new value of the 'Id' attribute.
* @see #getId()
* @generated
*/
void setId(Integer 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#getProject_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getName Name}' attribute.
*
*
* @param value the new value of the 'Name' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Returns the value of the 'Has Authorized Users' reference list.
* The list contents are of type {@link org.bimserver.models.store.User}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.User#getHasRightsOn Has Rights On}'.
*
*
* If the meaning of the 'Has Authorized Users' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Has Authorized Users' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_HasAuthorizedUsers()
* @see org.bimserver.models.store.User#getHasRightsOn
* @model opposite="hasRightsOn"
* @generated
*/
EList getHasAuthorizedUsers();
/**
* Returns the value of the 'Concrete Revisions' reference list.
* The list contents are of type {@link org.bimserver.models.store.ConcreteRevision}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.ConcreteRevision#getProject Project}'.
*
*
* If the meaning of the 'Concrete Revisions' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Concrete Revisions' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_ConcreteRevisions()
* @see org.bimserver.models.store.ConcreteRevision#getProject
* @model opposite="project"
* @generated
*/
EList getConcreteRevisions();
/**
* Returns the value of the 'Revisions' reference list.
* The list contents are of type {@link org.bimserver.models.store.Revision}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.Revision#getProject Project}'.
*
*
* If the meaning of the 'Revisions' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Revisions' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_Revisions()
* @see org.bimserver.models.store.Revision#getProject
* @model opposite="project"
* @generated
*/
EList getRevisions();
/**
* Returns the value of the 'Last Concrete Revision' reference.
*
*
* If the meaning of the 'Last Concrete Revision' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Last Concrete Revision' reference.
* @see #setLastConcreteRevision(ConcreteRevision)
* @see org.bimserver.models.store.StorePackage#getProject_LastConcreteRevision()
* @model
* @generated
*/
ConcreteRevision getLastConcreteRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getLastConcreteRevision Last Concrete Revision}' reference.
*
*
* @param value the new value of the 'Last Concrete Revision' reference.
* @see #getLastConcreteRevision()
* @generated
*/
void setLastConcreteRevision(ConcreteRevision value);
/**
* Returns the value of the 'Last Revision' reference.
*
*
* If the meaning of the 'Last Revision' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Last Revision' reference.
* @see #setLastRevision(Revision)
* @see org.bimserver.models.store.StorePackage#getProject_LastRevision()
* @model
* @generated
*/
Revision getLastRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getLastRevision Last Revision}' reference.
*
*
* @param value the new value of the 'Last Revision' reference.
* @see #getLastRevision()
* @generated
*/
void setLastRevision(Revision value);
/**
* Returns the value of the 'Checkouts' reference list.
* The list contents are of type {@link org.bimserver.models.store.Checkout}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.Checkout#getProject Project}'.
*
*
* If the meaning of the 'Checkouts' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Checkouts' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_Checkouts()
* @see org.bimserver.models.store.Checkout#getProject
* @model opposite="project"
* @generated
*/
EList getCheckouts();
/**
* 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#getProject_State()
* @model
* @generated
*/
ObjectState getState();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#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 'Created Date' attribute.
*
*
* If the meaning of the 'Created Date' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Created Date' attribute.
* @see #setCreatedDate(Date)
* @see org.bimserver.models.store.StorePackage#getProject_CreatedDate()
* @model
* @generated
*/
Date getCreatedDate();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getCreatedDate Created Date}' attribute.
*
*
* @param value the new value of the 'Created Date' attribute.
* @see #getCreatedDate()
* @generated
*/
void setCreatedDate(Date value);
/**
* Returns the value of the 'Created By' reference.
*
*
* If the meaning of the 'Created By' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Created By' reference.
* @see #setCreatedBy(User)
* @see org.bimserver.models.store.StorePackage#getProject_CreatedBy()
* @model
* @generated
*/
User getCreatedBy();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getCreatedBy Created By}' reference.
*
*
* @param value the new value of the 'Created By' reference.
* @see #getCreatedBy()
* @generated
*/
void setCreatedBy(User value);
/**
* Returns the value of the 'Geo Tag' reference.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.GeoTag#getProjects Projects}'.
*
*
* If the meaning of the 'Geo Tag' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Geo Tag' reference.
* @see #setGeoTag(GeoTag)
* @see org.bimserver.models.store.StorePackage#getProject_GeoTag()
* @see org.bimserver.models.store.GeoTag#getProjects
* @model opposite="projects"
* @generated
*/
GeoTag getGeoTag();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getGeoTag Geo Tag}' reference.
*
*
* @param value the new value of the 'Geo Tag' reference.
* @see #getGeoTag()
* @generated
*/
void setGeoTag(GeoTag value);
/**
* Returns the value of the 'Sub Projects' reference list.
* The list contents are of type {@link org.bimserver.models.store.Project}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.Project#getParent Parent}'.
*
*
* If the meaning of the 'Sub Projects' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Sub Projects' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_SubProjects()
* @see org.bimserver.models.store.Project#getParent
* @model opposite="parent"
* @generated
*/
EList getSubProjects();
/**
* Returns the value of the 'Parent' reference.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.Project#getSubProjects Sub Projects}'.
*
*
* If the meaning of the 'Parent' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Parent' reference.
* @see #setParent(Project)
* @see org.bimserver.models.store.StorePackage#getProject_Parent()
* @see org.bimserver.models.store.Project#getSubProjects
* @model opposite="subProjects"
* @generated
*/
Project getParent();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getParent Parent}' reference.
*
*
* @param value the new value of the 'Parent' reference.
* @see #getParent()
* @generated
*/
void setParent(Project value);
/**
* Returns the value of the 'Description' attribute.
*
*
* If the meaning of the 'Description' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Description' attribute.
* @see #setDescription(String)
* @see org.bimserver.models.store.StorePackage#getProject_Description()
* @model
* @generated
*/
String getDescription();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getDescription Description}' attribute.
*
*
* @param value the new value of the 'Description' attribute.
* @see #getDescription()
* @generated
*/
void setDescription(String value);
/**
* Returns the value of the 'Export Length Measure Prefix' attribute.
* The literals are from the enumeration {@link org.bimserver.models.store.SIPrefix}.
*
*
* If the meaning of the 'Export Length Measure Prefix' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Export Length Measure Prefix' attribute.
* @see org.bimserver.models.store.SIPrefix
* @see #setExportLengthMeasurePrefix(SIPrefix)
* @see org.bimserver.models.store.StorePackage#getProject_ExportLengthMeasurePrefix()
* @model
* @generated
*/
SIPrefix getExportLengthMeasurePrefix();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getExportLengthMeasurePrefix Export Length Measure Prefix}' attribute.
*
*
* @param value the new value of the 'Export Length Measure Prefix' attribute.
* @see org.bimserver.models.store.SIPrefix
* @see #getExportLengthMeasurePrefix()
* @generated
*/
void setExportLengthMeasurePrefix(SIPrefix value);
/**
* Returns the value of the 'Extended Data' reference list.
* The list contents are of type {@link org.bimserver.models.store.ExtendedData}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.ExtendedData#getProject Project}'.
*
*
* If the meaning of the 'Extended Data' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Extended Data' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_ExtendedData()
* @see org.bimserver.models.store.ExtendedData#getProject
* @model opposite="project"
* @generated
*/
EList getExtendedData();
/**
* Returns the value of the 'Services' reference list.
* The list contents are of type {@link org.bimserver.models.store.Service}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.store.Service#getProject Project}'.
*
*
* If the meaning of the 'Services' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Services' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_Services()
* @see org.bimserver.models.store.Service#getProject
* @model opposite="project"
* @generated
*/
EList getServices();
/**
* Returns the value of the 'Logs' reference list.
* The list contents are of type {@link org.bimserver.models.log.ProjectRelated}.
* It is bidirectional and its opposite is '{@link org.bimserver.models.log.ProjectRelated#getProject Project}'.
*
*
* 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#getProject_Logs()
* @see org.bimserver.models.log.ProjectRelated#getProject
* @model opposite="project"
* @generated
*/
EList getLogs();
/**
* Returns the value of the 'Model Checkers' reference list.
* The list contents are of type {@link org.bimserver.models.store.ModelCheckerInstance}.
*
*
* If the meaning of the 'Model Checkers' reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Model Checkers' reference list.
* @see org.bimserver.models.store.StorePackage#getProject_ModelCheckers()
* @model
* @generated
*/
EList getModelCheckers();
/**
* 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#getProject_Schema()
* @model
* @generated
*/
String getSchema();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#getSchema Schema}' attribute.
*
*
* @param value the new value of the 'Schema' attribute.
* @see #getSchema()
* @generated
*/
void setSchema(String value);
/**
* Returns the value of the 'Send Email On New Revision' attribute.
*
*
* If the meaning of the 'Send Email On New Revision' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Send Email On New Revision' attribute.
* @see #setSendEmailOnNewRevision(boolean)
* @see org.bimserver.models.store.StorePackage#getProject_SendEmailOnNewRevision()
* @model
* @generated
*/
boolean isSendEmailOnNewRevision();
/**
* Sets the value of the '{@link org.bimserver.models.store.Project#isSendEmailOnNewRevision Send Email On New Revision}' attribute.
*
*
* @param value the new value of the 'Send Email On New Revision' attribute.
* @see #isSendEmailOnNewRevision()
* @generated
*/
void setSendEmailOnNewRevision(boolean value);
} // Project
© 2015 - 2025 Weber Informatics LLC | Privacy Policy