001: package com.metaboss.sdlctools.models.metabossmodel.enterprisemodel;
002:
003: /**
004: * Servicemodule object instance interface.
005: */
006: public interface Servicemodule extends
007: com.metaboss.sdlctools.models.metabossmodel.ModelElement {
008: /**
009: * Looks for the Service with the given name in this Servicemodule. Returns
010: * found Service or null if none found
011: * @param pServiceName
012: * @return Looks for the Service with the given name in this Servicemodule.
013: * Returns found Service or null if none found
014: */
015: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Service findService(
016: java.lang.String pServiceName);
017:
018: /**
019: * Looks for the Service with the given name in this Servicemodule. Returns
020: * the Service or throws exception if none found.
021: * @param pServiceName
022: * @return Looks for the Service with the given name in this Servicemodule.
023: * Returns the Service or throws exception if none found.
024: */
025: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Service getService(
026: java.lang.String pServiceName);
027:
028: /**
029: * Looks for the Structure with the given name in this Servicemodule. Returns
030: * found Structure or null if none found
031: * @param pStructureName
032: * @return Looks for the Structure with the given name in this Servicemodule.
033: * Returns found Structure or null if none found
034: */
035: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.Structure findStructure(
036: java.lang.String pStructureName);
037:
038: /**
039: * Looks for the Structure with the given name in this Servicemodule. Returns
040: * the Structure or throws exception if none found.
041: * @param pStructureName
042: * @return Looks for the Structure with the given name in this Servicemodule.
043: * Returns the Structure or throws exception if none found.
044: */
045: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.Structure getStructure(
046: java.lang.String pStructureName);
047:
048: /**
049: * Looks for the Message with the given name in this Servicemodule. Returns
050: * found Message or null if none found
051: * @param pMessageName
052: * @return Looks for the Message with the given name in this Servicemodule.
053: * Returns found Message or null if none found
054: */
055: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Message findMessage(
056: java.lang.String pMessageName);
057:
058: /**
059: * Looks for the Message with the given name in this Servicemodule. Returns
060: * the Message or throws exception if none found.
061: * @param pMessageName
062: * @return Looks for the Message with the given name in this Servicemodule.
063: * Returns the Message or throws exception if none found.
064: */
065: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Message getMessage(
066: java.lang.String pMessageName);
067:
068: /**
069: * Returns read only collection of Servicemodules referenced from this one.
070: * The reference occurs when structure has a field which is a structure from
071: * some other servicemodule. It can also occur when operation uses mesages
072: * from some other servicemodule.
073: * @return Returns read only collection of Servicemodules referenced from
074: * this one. The reference occurs when structure has a field which is a structure
075: * from some other servicemodule. It can also occur when operation uses mesages
076: * from some other servicemodule.
077: */
078: public java.util.Collection getReferencedServicemodules();
079:
080: /**
081: * Returns list of DataTypes, Structures and Messages used in the Servicemodule.
082: * This includes owned and referenced elements.
083: * @return Returns list of DataTypes, Structures and Messages used in the
084: * Servicemodule. This includes owned and referenced elements.
085: */
086: public java.util.Collection getCombinedTypes();
087:
088: /**
089: * Returns ordered collection of of Structures owned by this Servicemodule
090: * in the dependency order. Dependency order means that a Structure does not
091: * depend on any Structures located further down the list from where it is
092: * located.
093: * @return Returns ordered collection of of Structures owned by this Servicemodule
094: * in the dependency order. Dependency order means that a Structure does not
095: * depend on any Structures located further down the list from where it is
096: * located.
097: */
098: public java.util.List getStructuresInDependencyOrder();
099:
100: /**
101: * Returns read-only collection of referenced datadictionaries. The referenced
102: * datadictionaries are all owner datadictionaries of the DataTypes and Structurers
103: * used in this Servicemodule.
104: * @return Returns read-only collection of referenced datadictionaries. The
105: * referenced datadictionaries are all owner datadictionaries of the DataTypes
106: * and Structurers used in this Servicemodule.
107: */
108: public java.util.Collection getReferencedDataDictionaries();
109:
110: /**
111: * Looks for the EventSubscription with the given name in this Servicemodule.
112: * Returns found EventSusbscription or null if none found
113: * @param pEventSubscriptionName
114: * @return Looks for the EventSubscription with the given name in this Servicemodule.
115: * Returns found EventSusbscription or null if none found
116: */
117: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.EventSubscription findEventSubscription(
118: java.lang.String pEventSubscriptionName);
119:
120: /**
121: * Looks for the EventSubscription with the given name in this Servicemodule.
122: * Returns the EventSubscription or throws exception if none found.
123: * @param pEventSubscriptionName
124: * @return Looks for the EventSubscription with the given name in this Servicemodule.
125: * Returns the EventSubscription or throws exception if none found.
126: */
127: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.EventSubscription getEventSubscription(
128: java.lang.String pEventSubscriptionName);
129:
130: /**
131: * Returns the value of reference servicemoduleStructuresDiagrams.
132: * @return Value of reference servicemoduleStructuresDiagrams.
133: */
134: public java.util.Collection getServicemoduleStructuresDiagrams();
135:
136: /**
137: * Returns the value of reference services.
138: * @return Value of reference services.
139: */
140: public java.util.Collection getServices();
141:
142: /**
143: * Returns the value of reference structures.
144: * @return Value of reference structures.
145: */
146: public java.util.Collection getStructures();
147:
148: /**
149: * Returns the value of reference messages.
150: * @return Value of reference messages.
151: */
152: public java.util.Collection getMessages();
153:
154: /**
155: * Returns the value of reference system.
156: * @return Value of reference system.
157: */
158: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.System getSystem();
159:
160: /**
161: * Sets the value of reference system. See {@link #getSystem} for description
162: * on the reference.
163: * @param newValue New value to be set.
164: */
165: public void setSystem(
166: com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.System newValue);
167:
168: /**
169: * Returns the value of reference eventSubscriptions.
170: * @return Value of reference eventSubscriptions.
171: */
172: public java.util.Collection getEventSubscriptions();
173: }
|