001 /**
002 * <copyright>
003 * </copyright>
004 *
005 * $Id$
006 */
007 package com.hammurapi.review;
008
009 import org.eclipse.emf.common.util.EList;
010 import org.eclipse.emf.ecore.EObject;
011
012 import com.hammurapi.config.Factory;
013 import com.hammurapi.config.Path;
014
015 /**
016 * <!-- begin-user-doc -->
017 * A representation of the model object '<em><b>Module</b></em>'.
018 * <!-- end-user-doc -->
019 *
020 * <!-- begin-model-doc -->
021 * Module defines a set of source and inspector sets to use on these sources.
022 * <!-- end-model-doc -->
023 *
024 * <p>
025 * The following features are supported:
026 * <ul>
027 * <li>{@link com.hammurapi.review.Module#getInspectorSet <em>Inspector Set</em>}</li>
028 * <li>{@link com.hammurapi.review.Module#getName <em>Name</em>}</li>
029 * <li>{@link com.hammurapi.review.Module#getDescription <em>Description</em>}</li>
030 * <li>{@link com.hammurapi.review.Module#getSource <em>Source</em>}</li>
031 * <li>{@link com.hammurapi.review.Module#getClassPath <em>Class Path</em>}</li>
032 * <li>{@link com.hammurapi.review.Module#getModel <em>Model</em>}</li>
033 * </ul>
034 * </p>
035 *
036 * @see com.hammurapi.review.ReviewPackage#getModule()
037 * @model
038 * @generated
039 */
040 public interface Module extends EObject {
041 /**
042 * Returns the value of the '<em><b>Inspector Set</b></em>' reference list.
043 * The list contents are of type {@link com.hammurapi.review.InspectorSet}.
044 * <!-- begin-user-doc -->
045 * <!-- end-user-doc -->
046 * <!-- begin-model-doc -->
047 * Module is reviewed by one or more inspector sets.
048 * <!-- end-model-doc -->
049 * @return the value of the '<em>Inspector Set</em>' reference list.
050 * @see com.hammurapi.review.ReviewPackage#getModule_InspectorSet()
051 * @model required="true"
052 * @generated
053 */
054 EList<InspectorSet> getInspectorSet();
055
056 /**
057 * Returns the value of the '<em><b>Name</b></em>' attribute.
058 * <!-- begin-user-doc -->
059 * <p>
060 * If the meaning of the '<em>Name</em>' attribute isn't clear,
061 * there really should be more of a description here...
062 * </p>
063 * <!-- end-user-doc -->
064 * @return the value of the '<em>Name</em>' attribute.
065 * @see #setName(String)
066 * @see com.hammurapi.review.ReviewPackage#getModule_Name()
067 * @model
068 * @generated
069 */
070 String getName();
071
072 /**
073 * Sets the value of the '{@link com.hammurapi.review.Module#getName <em>Name</em>}' attribute.
074 * <!-- begin-user-doc -->
075 * <!-- end-user-doc -->
076 * @param value the new value of the '<em>Name</em>' attribute.
077 * @see #getName()
078 * @generated
079 */
080 void setName(String value);
081
082 /**
083 * Returns the value of the '<em><b>Description</b></em>' attribute.
084 * <!-- begin-user-doc -->
085 * <p>
086 * If the meaning of the '<em>Description</em>' attribute isn't clear,
087 * there really should be more of a description here...
088 * </p>
089 * <!-- end-user-doc -->
090 * @return the value of the '<em>Description</em>' attribute.
091 * @see #setDescription(String)
092 * @see com.hammurapi.review.ReviewPackage#getModule_Description()
093 * @model
094 * @generated
095 */
096 String getDescription();
097
098 /**
099 * Sets the value of the '{@link com.hammurapi.review.Module#getDescription <em>Description</em>}' attribute.
100 * <!-- begin-user-doc -->
101 * <!-- end-user-doc -->
102 * @param value the new value of the '<em>Description</em>' attribute.
103 * @see #getDescription()
104 * @generated
105 */
106 void setDescription(String value);
107
108 /**
109 * Returns the value of the '<em><b>Source</b></em>' containment reference list.
110 * The list contents are of type {@link com.hammurapi.config.Factory}.
111 * <!-- begin-user-doc -->
112 * <!-- end-user-doc -->
113 * <!-- begin-model-doc -->
114 * Module consists of several source definitions.
115 * <!-- end-model-doc -->
116 * @return the value of the '<em>Source</em>' containment reference list.
117 * @see com.hammurapi.review.ReviewPackage#getModule_Source()
118 * @model containment="true" required="true"
119 * @generated
120 */
121 EList<Factory> getSource();
122
123 /**
124 * Returns the value of the '<em><b>Class Path</b></em>' containment reference list.
125 * The list contents are of type {@link com.hammurapi.config.Path}.
126 * <!-- begin-user-doc -->
127 * <p>
128 * If the meaning of the '<em>Class Path</em>' containment reference list isn't clear,
129 * there really should be more of a description here...
130 * </p>
131 * <!-- end-user-doc -->
132 * @return the value of the '<em>Class Path</em>' containment reference list.
133 * @see com.hammurapi.review.ReviewPackage#getModule_ClassPath()
134 * @model containment="true"
135 * @generated
136 */
137 EList<Path> getClassPath();
138
139 /**
140 * Returns the value of the '<em><b>Model</b></em>' attribute list.
141 * The list contents are of type {@link java.lang.Object}.
142 * <!-- begin-user-doc -->
143 * <!-- end-user-doc -->
144 * <!-- begin-model-doc -->
145 * Review driver sets this attribute after instantiation of the model from the source.
146 * <!-- end-model-doc -->
147 * @return the value of the '<em>Model</em>' attribute list.
148 * @see com.hammurapi.review.ReviewPackage#getModule_Model()
149 * @model
150 * @generated
151 */
152 EList<Object> getModel();
153
154
155 } // Module