001: package com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel;
002:
003: /**
004: * Entity object instance interface.
005: */
006: public interface Entity extends
007: com.metaboss.sdlctools.models.metabossmodel.ModelElement {
008: /**
009: * @return
010: */
011: public boolean isModifiable();
012:
013: /**
014: * @return
015: */
016: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.AssociationRole getOwnerReference();
017:
018: /**
019: * Returns all referenced roles in this entity and all subentities.
020: * @return Returns all referenced roles in this entity and all subentities.
021: */
022: public java.util.Collection getCombinedReferences();
023:
024: /**
025: * @return
026: */
027: public java.util.Collection getCombinedSubtypes();
028:
029: /**
030: * Returns all references, which are parts of many-to-many association and
031: * where this entity is the aggregator. Only concerned with this entity and
032: * not any super entities.
033: * @return Returns all references, which are parts of many-to-many association
034: * and where this entity is the aggregator. Only concerned with this entity
035: * and not any super entities.
036: */
037: public java.util.Collection getAgregatedManyToManyReferences();
038:
039: /**
040: * Retrieves read only collection of attributes which this entity can be orderd
041: * by. Includes only attributes from this entity and excludes all attributes
042: * from supertypes.
043: * @return Retrieves read only collection of attributes which this entity
044: * can be orderd by. Includes only attributes from this entity and excludes
045: * all attributes from supertypes.
046: */
047: public java.util.Collection getAttributesUsedForOrdering();
048:
049: /**
050: * Looks for the Attribute with the given name only in this Entity. Returns
051: * the Attribute or throws exception if none found.
052: * @param pAttributeName
053: * @return Looks for the Attribute with the given name only in this Entity.
054: * Returns the Attribute or throws exception if none found.
055: */
056: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Attribute getAttribute(
057: java.lang.String pAttributeName);
058:
059: /**
060: * Looks for the Attribute with the given name only in this Entity. Returns
061: * the Attribute or null if none found.
062: * @param pAttributeName
063: * @return Looks for the Attribute with the given name only in this Entity.
064: * Returns the Attribute or null if none found.
065: */
066: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Attribute findAttribute(
067: java.lang.String pAttributeName);
068:
069: /**
070: * Looks for the Attribute with the given name in this Entity and supertype
071: * Entities. Returns the Attribute or null if none found.
072: * @param pAttributeName
073: * @return Looks for the Attribute with the given name in this Entity and
074: * supertype Entities. Returns the Attribute or null if none found.
075: */
076: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Attribute findCombinedAttribute(
077: java.lang.String pAttributeName);
078:
079: /**
080: * Looks for the Selector with the given name only in this Entity. Returns
081: * the Selector or throws exception if none found.
082: * @param pSelectorName
083: * @return Looks for the Selector with the given name only in this Entity.
084: * Returns the Selector or throws exception if none found.
085: */
086: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Selector getSelector(
087: java.lang.String pSelectorName);
088:
089: /**
090: * Looks for the selector with the given name. Returns the selector or null
091: * if none found.
092: * @param pSelectorName
093: * @return Looks for the selector with the given name. Returns the selector
094: * or null if none found.
095: */
096: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Selector findSelector(
097: java.lang.String pSelectorName);
098:
099: /**
100: * Looks for the Selector with the given name in this Entity and supertype
101: * Entities. Returns the Selector or null if none found.
102: * @param pSelectorName
103: * @return Looks for the Selector with the given name in this Entity and supertype
104: * Entities. Returns the Selector or null if none found.
105: */
106: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Selector findCombinedSelector(
107: java.lang.String pSelectorName);
108:
109: /**
110: * @return
111: */
112: public java.util.Collection getCombinedAttributes();
113:
114: /**
115: * @return
116: */
117: public java.util.Collection getReferences();
118:
119: /**
120: * Returns all references, which are parts of many-to-many association and
121: * where this entity is the aggregator. Looks at this entity and any super
122: * entities.
123: * @return Returns all references, which are parts of many-to-many association
124: * and where this entity is the aggregator. Looks at this entity and any super
125: * entities.
126: */
127: public java.util.Collection getCombinedAgregatedManyToManyReferences();
128:
129: /**
130: * Retrieves read only collection of attributes which this entity can be orderd
131: * by. Includes attributes from this entity and all attributes from supertypes.
132: * @return Retrieves read only collection of attributes which this entity
133: * can be orderd by. Includes attributes from this entity and all attributes
134: * from supertypes.
135: */
136: public java.util.Collection getCombinedAttributesUsedForOrdering();
137:
138: /**
139: * Returns all roles played by this entity and all subentities.
140: * @return Returns all roles played by this entity and all subentities.
141: */
142: public java.util.Collection getCombinedRoles();
143:
144: /**
145: * Looks for the Reference with the given name only in this Entity. Returns
146: * the Reference or throws exception if none found.
147: * @param pReferenceName
148: * @return Looks for the Reference with the given name only in this Entity.
149: * Returns the Reference or throws exception if none found.
150: */
151: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.AssociationRole getReference(
152: java.lang.String pReferenceName);
153:
154: /**
155: * Looks for the Reference with the given name only in this Entity. Returns
156: * the Reference or null if none found.
157: * @param pReferenceName
158: * @return Looks for the Reference with the given name only in this Entity.
159: * Returns the Reference or null if none found.
160: */
161: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.AssociationRole findReference(
162: java.lang.String pReferenceName);
163:
164: /**
165: * Looks for the Reference with the given name in this Entity and supertype
166: * Entities. Returns the Reference or null if none found.
167: * @param pReferenceName
168: * @return Looks for the Reference with the given name in this Entity and
169: * supertype Entities. Returns the Reference or null if none found.
170: */
171: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.AssociationRole findCombinedReference(
172: java.lang.String pReferenceName);
173:
174: /**
175: * Looks for the Constraint with the given name only in this Entity. Returns
176: * the Constraint or null if none found.
177: * @param pConstraintName
178: * @return Looks for the Constraint with the given name only in this Entity.
179: * Returns the Constraint or null if none found.
180: */
181: public com.metaboss.sdlctools.models.metabossmodel.ModelElementConstraint findConstraint(
182: java.lang.String pConstraintName);
183:
184: /**
185: * Looks for the Constraint with the given name only in this Entity. Returns
186: * the Constraint or throws exception if none found.
187: * @param pConstraintName
188: * @return Looks for the Constraint with the given name only in this Entity.
189: * Returns the Constraint or throws exception if none found.
190: */
191: public com.metaboss.sdlctools.models.metabossmodel.ModelElementConstraint getConstraint(
192: java.lang.String pConstraintName);
193:
194: /**
195: * Returns all Constraints in this Entity and all subentities
196: * @return Returns all Constraints in this Entity and all subentities
197: */
198: public java.util.Collection getCombinedConstraints();
199:
200: /**
201: * Returns list of DataTypes, Structures and Messages used in the Entity.
202: * This includes owned and referenced elements.
203: * @return Returns list of DataTypes, Structures and Messages used in the
204: * Entity. This includes owned and referenced elements.
205: */
206: public java.util.Collection getCombinedTypes();
207:
208: /**
209: * Returns the value of attribute stereotype.
210: * @return Value of attribute stereotype.
211: */
212: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.EntityStereotype getStereotype();
213:
214: /**
215: * Sets the value of stereotype attribute. See {@link #getStereotype} for
216: * description on the attribute.
217: * @param newValue New value to be set.
218: */
219: public void setStereotype(
220: com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.EntityStereotype newValue);
221:
222: /**
223: * Returns the value of attribute isAbstract.
224: * @return Value of attribute isAbstract.
225: */
226: public boolean isAbstract();
227:
228: /**
229: * Sets the value of isAbstract attribute. See {@link #isAbstract} for description
230: * on the attribute.
231: * @param newValue New value to be set.
232: */
233: public void setAbstract(boolean newValue);
234:
235: /**
236: * Returns the value of attribute isFinal.
237: * @return Value of attribute isFinal.
238: */
239: public boolean isFinal();
240:
241: /**
242: * Sets the value of isFinal attribute. See {@link #isFinal} for description
243: * on the attribute.
244: * @param newValue New value to be set.
245: */
246: public void setFinal(boolean newValue);
247:
248: /**
249: * Returns the value of attribute pluralName.
250: * @return Value of attribute pluralName.
251: */
252: public java.lang.String getPluralName();
253:
254: /**
255: * Sets the value of pluralName attribute. See {@link #getPluralName} for
256: * description on the attribute.
257: * @param newValue New value to be set.
258: */
259: public void setPluralName(java.lang.String newValue);
260:
261: /**
262: * Returns the value of attribute instanceIdAttributeNameOverride.
263: * The customised name of the InstanceId attribute for this entity. Should
264: * only be set in rare cases when name 'InstanceId' is needed to name another
265: * attribute
266: * @return Value of attribute instanceIdAttributeNameOverride.
267: */
268: public java.lang.String getInstanceIdAttributeNameOverride();
269:
270: /**
271: * Sets the value of instanceIdAttributeNameOverride attribute. See {@link
272: * #getInstanceIdAttributeNameOverride} for description on the attribute.
273: * @param newValue New value to be set.
274: */
275: public void setInstanceIdAttributeNameOverride(
276: java.lang.String newValue);
277:
278: /**
279: * Returns the value of attribute versionIdAttributeNameOverride.
280: * The customised name of the VersionId attribute for this entity. Should
281: * only be set in rare cases when name 'VersionId' is needed to name another
282: * attribute
283: * @return Value of attribute versionIdAttributeNameOverride.
284: */
285: public java.lang.String getVersionIdAttributeNameOverride();
286:
287: /**
288: * Sets the value of versionIdAttributeNameOverride attribute. See {@link
289: * #getVersionIdAttributeNameOverride} for description on the attribute.
290: * @param newValue New value to be set.
291: */
292: public void setVersionIdAttributeNameOverride(
293: java.lang.String newValue);
294:
295: /**
296: * Returns the value of attribute stateAttributeNameOverride.
297: * The customised name of the State attribute for this entity. Should only
298: * be set in rare cases when name 'State' is needed to name another attribute
299: * @return Value of attribute stateAttributeNameOverride.
300: */
301: public java.lang.String getStateAttributeNameOverride();
302:
303: /**
304: * Sets the value of stateAttributeNameOverride attribute. See {@link #getStateAttributeNameOverride}
305: * for description on the attribute.
306: * @param newValue New value to be set.
307: */
308: public void setStateAttributeNameOverride(java.lang.String newValue);
309:
310: /**
311: * Returns the value of reference orderingInstructionDataType.
312: * @return Value of reference orderingInstructionDataType.
313: */
314: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getOrderingInstructionDataType();
315:
316: /**
317: * Sets the value of reference orderingInstructionDataType. See {@link #getOrderingInstructionDataType}
318: * for description on the reference.
319: * @param newValue New value to be set.
320: */
321: public void setOrderingInstructionDataType(
322: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
323:
324: /**
325: * Returns the value of reference versionIdDataType.
326: * @return Value of reference versionIdDataType.
327: */
328: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getVersionIdDataType();
329:
330: /**
331: * Sets the value of reference versionIdDataType. See {@link #getVersionIdDataType}
332: * for description on the reference.
333: * @param newValue New value to be set.
334: */
335: public void setVersionIdDataType(
336: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
337:
338: /**
339: * Returns the value of reference supertype.
340: * @return Value of reference supertype.
341: */
342: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Entity getSupertype();
343:
344: /**
345: * Sets the value of reference supertype. See {@link #getSupertype} for description
346: * on the reference.
347: * @param newValue New value to be set.
348: */
349: public void setSupertype(
350: com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Entity newValue);
351:
352: /**
353: * Returns the value of reference subtypes.
354: * @return Value of reference subtypes.
355: */
356: public java.util.Collection getSubtypes();
357:
358: /**
359: * Returns the value of reference attributes.
360: * @return Value of reference attributes.
361: */
362: public java.util.Collection getAttributes();
363:
364: /**
365: * Returns the value of reference collectionContainsFlagDataType.
366: * @return Value of reference collectionContainsFlagDataType.
367: */
368: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getCollectionContainsFlagDataType();
369:
370: /**
371: * Sets the value of reference collectionContainsFlagDataType. See {@link
372: * #getCollectionContainsFlagDataType} for description on the reference.
373: * @param newValue New value to be set.
374: */
375: public void setCollectionContainsFlagDataType(
376: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
377:
378: /**
379: * Returns the value of reference relationalTableDefinitions.
380: * @return Value of reference relationalTableDefinitions.
381: */
382: public java.util.Collection getRelationalTableDefinitions();
383:
384: /**
385: * Returns the value of reference stateDataType.
386: * @return Value of reference stateDataType.
387: */
388: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getStateDataType();
389:
390: /**
391: * Sets the value of reference stateDataType. See {@link #getStateDataType}
392: * for description on the reference.
393: * @param newValue New value to be set.
394: */
395: public void setStateDataType(
396: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
397:
398: /**
399: * Returns the value of reference selectors.
400: * @return Value of reference selectors.
401: */
402: public java.util.Collection getSelectors();
403:
404: /**
405: * Returns the value of reference roles.
406: * @return Value of reference roles.
407: */
408: public java.util.Collection getRoles();
409:
410: /**
411: * Returns the value of reference collectionEmptyFlagDataType.
412: * @return Value of reference collectionEmptyFlagDataType.
413: */
414: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getCollectionEmptyFlagDataType();
415:
416: /**
417: * Sets the value of reference collectionEmptyFlagDataType. See {@link #getCollectionEmptyFlagDataType}
418: * for description on the reference.
419: * @param newValue New value to be set.
420: */
421: public void setCollectionEmptyFlagDataType(
422: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
423:
424: /**
425: * Returns the value of reference constraints.
426: * @return Value of reference constraints.
427: */
428: public java.util.List getConstraints();
429:
430: /**
431: * Returns the value of reference primaryKeyElements.
432: * @return Value of reference primaryKeyElements.
433: */
434: public java.util.Collection getPrimaryKeyElements();
435:
436: /**
437: * Returns the value of reference subsetSizeDataType.
438: * @return Value of reference subsetSizeDataType.
439: */
440: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getSubsetSizeDataType();
441:
442: /**
443: * Sets the value of reference subsetSizeDataType. See {@link #getSubsetSizeDataType}
444: * for description on the reference.
445: * @param newValue New value to be set.
446: */
447: public void setSubsetSizeDataType(
448: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
449:
450: /**
451: * Returns the value of reference reportOutputsUsingEntity.
452: * @return Value of reference reportOutputsUsingEntity.
453: */
454: public java.util.Collection getReportOutputsUsingEntity();
455:
456: /**
457: * Returns the value of reference stateMachine.
458: * @return Value of reference stateMachine.
459: */
460: public com.metaboss.sdlctools.models.metabossmodel.statemachinemodel.StateMachine getStateMachine();
461:
462: /**
463: * Sets the value of reference stateMachine. See {@link #getStateMachine}
464: * for description on the reference.
465: * @param newValue New value to be set.
466: */
467: public void setStateMachine(
468: com.metaboss.sdlctools.models.metabossmodel.statemachinemodel.StateMachine newValue);
469:
470: /**
471: * Returns the value of reference collectionOffsetDataType.
472: * @return Value of reference collectionOffsetDataType.
473: */
474: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getCollectionOffsetDataType();
475:
476: /**
477: * Sets the value of reference collectionOffsetDataType. See {@link #getCollectionOffsetDataType}
478: * for description on the reference.
479: * @param newValue New value to be set.
480: */
481: public void setCollectionOffsetDataType(
482: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
483:
484: /**
485: * Returns the value of reference collectionSizeDataType.
486: * @return Value of reference collectionSizeDataType.
487: */
488: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getCollectionSizeDataType();
489:
490: /**
491: * Sets the value of reference collectionSizeDataType. See {@link #getCollectionSizeDataType}
492: * for description on the reference.
493: * @param newValue New value to be set.
494: */
495: public void setCollectionSizeDataType(
496: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
497:
498: /**
499: * Returns the value of reference domain.
500: * @return Value of reference domain.
501: */
502: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Domain getDomain();
503:
504: /**
505: * Sets the value of reference domain. See {@link #getDomain} for description
506: * on the reference.
507: * @param newValue New value to be set.
508: */
509: public void setDomain(
510: com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.systemimplementationmodel.Domain newValue);
511:
512: /**
513: * Returns the value of reference instanceIdDataType.
514: * @return Value of reference instanceIdDataType.
515: */
516: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getInstanceIdDataType();
517:
518: /**
519: * Sets the value of reference instanceIdDataType. See {@link #getInstanceIdDataType}
520: * for description on the reference.
521: * @param newValue New value to be set.
522: */
523: public void setInstanceIdDataType(
524: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType newValue);
525:
526: /**
527: * Returns the value of reference entityStateDiagrams.
528: * @return Value of reference entityStateDiagrams.
529: */
530: public java.util.Collection getEntityStateDiagrams();
531: }
|