001: package com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel;
002:
003: /**
004: * Structure object instance interface.
005: */
006: public interface Structure extends
007: com.metaboss.sdlctools.models.metabossmodel.ModelElement {
008: /**
009: * if this Structure is owned by DataDictionary - this method will return
010: * it. Otherwise null is returned
011: * @return if this Structure is owned by DataDictionary - this method will
012: * return it. Otherwise null is returned
013: */
014: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.DataDictionary getOwnerDataDictionary();
015:
016: /**
017: * @param pFieldName
018: * @return
019: */
020: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.StructureField findField(
021: java.lang.String pFieldName);
022:
023: /**
024: * @param pFieldName
025: * @return
026: */
027: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.StructureField getField(
028: java.lang.String pFieldName);
029:
030: /**
031: * Returns collection of all DataTypes and Structures used in this Structure
032: * and all its fields to any depth.
033: * @return Returns collection of all DataTypes and Structures used in this
034: * Structure and all its fields to any depth.
035: */
036: public java.util.Collection getCombinedTypes();
037:
038: /**
039: * Looks for the Constraint with the given name in this Structure. Returns
040: * the Constraint or throws exception if none found.
041: * @param pConstraintName
042: * @return Looks for the Constraint with the given name in this Structure.
043: * Returns the Constraint or throws exception if none found.
044: */
045: public com.metaboss.sdlctools.models.metabossmodel.ModelElementConstraint getConstraint(
046: java.lang.String pConstraintName);
047:
048: /**
049: * Looks for the Constraint with the given name in this Structure. Returns
050: * the Constraint or null if none found.
051: * @param pConstraintName
052: * @return Looks for the Constraint with the given name in this Structure.
053: * Returns the Constraint or null if none found.
054: */
055: public com.metaboss.sdlctools.models.metabossmodel.ModelElementConstraint findConstraint(
056: java.lang.String pConstraintName);
057:
058: /**
059: * Returns the value of reference constraints.
060: * @return Value of reference constraints.
061: */
062: public java.util.List getConstraints();
063:
064: /**
065: * Returns the value of reference dataFieldsOfType.
066: * @return Value of reference dataFieldsOfType.
067: */
068: public java.util.Collection getDataFieldsOfType();
069:
070: /**
071: * Returns the value of reference fields.
072: * @return Value of reference fields.
073: */
074: public java.util.List getFields();
075:
076: /**
077: * Returns the value of reference namespace.
078: * @return Value of reference namespace.
079: */
080: public com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.AbstractNamespace getNamespace();
081:
082: /**
083: * Sets the value of reference namespace. See {@link #getNamespace} for description
084: * on the reference.
085: * @param newValue New value to be set.
086: */
087: public void setNamespace(
088: com.metaboss.sdlctools.models.metabossmodel.datadictionarymodel.AbstractNamespace newValue);
089:
090: /**
091: * Returns the value of reference servicemodule.
092: * @return Value of reference servicemodule.
093: */
094: public com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Servicemodule getServicemodule();
095:
096: /**
097: * Sets the value of reference servicemodule. See {@link #getServicemodule}
098: * for description on the reference.
099: * @param newValue New value to be set.
100: */
101: public void setServicemodule(
102: com.metaboss.sdlctools.models.metabossmodel.enterprisemodel.Servicemodule newValue);
103: }
|