001: package com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel;
002:
003: /**
004: * AbstractNamespace object instance interface.
005: */
006: public interface AbstractNamespace extends
007: com.metaboss.sdlctools.models.metabossmodel.ModelElement {
008: /**
009: * Returns read-only collection of all data types contained in this namespace
010: * and all subnamespaces
011: * @return Returns read-only collection of all data types contained in this
012: * namespace and all subnamespaces
013: */
014: public java.util.Collection getCombinedDataTypes();
015:
016: /**
017: * Returns read-only collection of all structures contained in this namespace
018: * and all subnamespaces
019: * @return Returns read-only collection of all structures contained in this
020: * namespace and all subnamespaces
021: */
022: public java.util.Collection getCombinedStructures();
023:
024: /**
025: * Returns read-only collection of all type templates contained in this namespace
026: * and all subnamespaces
027: * @return Returns read-only collection of all type templates contained in
028: * this namespace and all subnamespaces
029: */
030: public java.util.Collection getCombinedTypeTemplates();
031:
032: /**
033: * Returns read-only collection of all namespaces contained in this namespace
034: * and all subnamespaces
035: * @return Returns read-only collection of all namespaces contained in this
036: * namespace and all subnamespaces
037: */
038: public java.util.Collection getCombinedSubNamespaces();
039:
040: /**
041: * Finds subnamespace with the given name or returns null if not found
042: * @param pNamespaceName
043: * @return Finds subnamespace with the given name or returns null if not found
044: */
045: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.Namespace findSubNamespace(
046: java.lang.String pNamespaceName);
047:
048: /**
049: * Finds subnamespace with the given name or throws exception if not found
050: * @param pNamespaceName
051: * @return Finds subnamespace with the given name or throws exception if not
052: * found
053: */
054: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.Namespace getSubNamespace(
055: java.lang.String pNamespaceName);
056:
057: /**
058: * Finds type template with the given name or returns null if not found
059: * @param pTypeTemplateName
060: * @return Finds type template with the given name or returns null if not
061: * found
062: */
063: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.TypeTemplate findTypeTemplate(
064: java.lang.String pTypeTemplateName);
065:
066: /**
067: * Finds type template with the given name or throws exception if not found
068: * @param pTypeTemplateName
069: * @return Finds type template with the given name or throws exception if
070: * not found
071: */
072: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.TypeTemplate getTypeTemplate(
073: java.lang.String pTypeTemplateName);
074:
075: /**
076: * Finds data type with the given name or returns null if not found
077: * @param pDataTypeName
078: * @return Finds data type with the given name or returns null if not found
079: */
080: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType findDataType(
081: java.lang.String pDataTypeName);
082:
083: /**
084: * Finds data type with the given name or throws exception if not found
085: * @param pDataTypeName
086: * @return Finds data type with the given name or throws exception if not
087: * found
088: */
089: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataType getDataType(
090: java.lang.String pDataTypeName);
091:
092: /**
093: * Returns list containing chain of owner namespaces including this namespace
094: * itself. DataDictionary is always at the list position zero and this namespace
095: * is always at the last position. If this abstract namespace itself is a
096: * DataDictionary - the returned list has only one element.
097: * @return Returns list containing chain of owner namespaces including this
098: * namespace itself. DataDictionary is always at the list position zero and
099: * this namespace is always at the last position. If this abstract namespace
100: * itself is a DataDictionary - the returned list has only one element.
101: */
102: public java.util.List getPathWithDictionary();
103:
104: /**
105: * Returns list containing chain of owner namespaces including this namespace
106: * itself. DataDictionary is always excluded and this namespace is always
107: * at the last position. If this abstract namespace itself is a DataDictionary
108: * - the returned list is empty.
109: * @return Returns list containing chain of owner namespaces including this
110: * namespace itself. DataDictionary is always excluded and this namespace
111: * is always at the last position. If this abstract namespace itself is a
112: * DataDictionary - the returned list is empty.
113: */
114: public java.util.List getPathWithoutDictionary();
115:
116: /**
117: * Finds structure with the given name or returns null if not found
118: * @param pStructureName
119: * @return Finds structure with the given name or returns null if not found
120: */
121: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.Structure findStructure(
122: java.lang.String pStructureName);
123:
124: /**
125: * Finds structure with the given name or throws exception if not found
126: * @param pStructureName
127: * @return Finds structure with the given name or throws exception if not
128: * found
129: */
130: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.Structure getStructure(
131: java.lang.String pStructureName);
132:
133: /**
134: * Returns list of DataTypes, Structures and Messages used in the Namespace.
135: * This includes owned and referenced elements.
136: * @return Returns list of DataTypes, Structures and Messages used in the
137: * Namespace. This includes owned and referenced elements.
138: */
139: public java.util.Collection getCombinedTypes();
140:
141: /**
142: * Returns ordered collection of of Structures owned by this namespace in
143: * the dependency order. Dependency order means that a Structure does not
144: * depend on any Structures located further down the list from where it is
145: * located.
146: * @return Returns ordered collection of of Structures owned by this namespace
147: * in the dependency order. Dependency order means that a Structure does not
148: * depend on any Structures located further down the list from where it is
149: * located.
150: */
151: public java.util.List getStructuresInDependencyOrder();
152:
153: /**
154: * Returns read-only collection of all messages contained in this namespace
155: * and all subnamespaces
156: * @return Returns read-only collection of all messages contained in this
157: * namespace and all subnamespaces
158: */
159: public java.util.Collection getCombinedMessages();
160:
161: /**
162: * Finds message with the given name or returns null if not found
163: * @param pMessageName
164: * @return Finds message with the given name or returns null if not found
165: */
166: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Message findMessage(
167: java.lang.String pMessageName);
168:
169: /**
170: * Finds message with the given name or throws exception if not found
171: * @param pMessageName
172: * @return Finds message with the given name or throws exception if not found
173: */
174: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Message getMessage(
175: java.lang.String pMessageName);
176:
177: /**
178: * Returns the value of reference subNamespaces.
179: * @return Value of reference subNamespaces.
180: */
181: public java.util.Collection getSubNamespaces();
182:
183: /**
184: * Returns the value of reference structures.
185: * @return Value of reference structures.
186: */
187: public java.util.Collection getStructures();
188:
189: /**
190: * Returns the value of reference messages.
191: * @return Value of reference messages.
192: */
193: public java.util.Collection getMessages();
194:
195: /**
196: * Returns the value of reference dataTypes.
197: * @return Value of reference dataTypes.
198: */
199: public java.util.Collection getDataTypes();
200:
201: /**
202: * Returns the value of reference typeTemplates.
203: * @return Value of reference typeTemplates.
204: */
205: public java.util.Collection getTypeTemplates();
206: }
|