001: // THIS SOFTWARE IS PROVIDED BY SOFTARIS PTY.LTD. AND OTHER METABOSS
002: // CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
003: // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
004: // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTARIS PTY.LTD.
005: // OR OTHER METABOSS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
006: // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
007: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
008: // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
009: // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
010: // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
011: // EVEN IF SOFTARIS PTY.LTD. OR OTHER METABOSS CONTRIBUTORS ARE ADVISED OF THE
012: // POSSIBILITY OF SUCH DAMAGE.
013: //
014: // Copyright 2000-2005 © Softaris Pty.Ltd. All Rights Reserved.
015: package com.metaboss.sdlctools.domains.storagemodel;
016:
017: import com.metaboss.enterprise.bo.BOException;
018: import com.metaboss.sdlctools.types.storagemodel.NameConversionType;
019:
020: public interface BORelationalStorageTechnology extends
021: BOStorageTechnology {
022: /** Getter for the maximum length of the table name */
023: public int getMaxTableNameLength() throws BOException;
024:
025: /** Getter for the name conversion algorithm type for the association table */
026: public NameConversionType getAssociationTableNameConversionType()
027: throws BOException;
028:
029: /** Getter for the association table prefix. It gets prepended to the association name from the model after name conversion argorithm is invoked */
030: public String getAssociationTableNamePrefix() throws BOException;
031:
032: /** Getter for the association table suffix. It gets appended to the association name from the model after name conversion argorithm is invoked */
033: public String getAssociationTableNameSuffix() throws BOException;
034:
035: /** Getter for the name conversion algorithm type for the entity table */
036: public NameConversionType getEntityTableNameConversionType()
037: throws BOException;
038:
039: /** Getter for the entity table prefix. It gets prepended to the association name from the model after name conversion argorithm is invoked */
040: public String getEntityTableNamePrefix() throws BOException;
041:
042: /** Getter for the entity table suffix. It gets appended to the association name from the model after name conversion argorithm is invoked */
043: public String getEntityTableNameSuffix() throws BOException;
044:
045: /** Getter for the name conversion algorithm type for the reference table */
046: public NameConversionType getReferenceTableNameConversionType()
047: throws BOException;
048:
049: /** Getter for the reference table prefix. It gets prepended to the association name from the model after name conversion argorithm is invoked */
050: public String getReferenceTableNamePrefix() throws BOException;
051:
052: /** Getter for the reference table suffix. It gets appended to the association name from the model after name conversion argorithm is invoked */
053: public String getReferenceTableNameSuffix() throws BOException;
054:
055: /** Getter for the maximum length of the column name */
056: public int getMaxColumnNameLength() throws BOException;
057:
058: /** Getter for the name conversion algorithm type for the attribute column */
059: public NameConversionType getAttributeColumnNameConversionType()
060: throws BOException;
061:
062: /** Getter for the attribute column name prefix. It gets prepended to the attribute name from the model after name conversion argorithm is invoked */
063: public String getAttributeColumnNamePrefix() throws BOException;
064:
065: /** Getter for the attribute column name suffix. It gets appended to the attribute name from the model after name conversion argorithm is invoked */
066: public String getAttributeColumnNameSuffix() throws BOException;
067:
068: /** Getter for the name conversion algorithm type for the association role column */
069: public NameConversionType getAssociationRoleColumnNameConversionType()
070: throws BOException;
071:
072: /** Getter for the association role column name prefix. It gets prepended to the association role name from the model after name conversion argorithm is invoked */
073: public String getAssociationRoleColumnNamePrefix()
074: throws BOException;
075:
076: /** Getter for the association role column name suffix. It gets apppended to the association role name from the model after name conversion argorithm is invoked */
077: public String getAssociationRoleColumnNameSuffix()
078: throws BOException;
079:
080: /** Getter for the name of the column to store entity instance id */
081: public String getEntityInstanceIdColumnName() throws BOException;
082:
083: /** Getter for the name of the column to store entity version id */
084: public String getEntityVersionIdColumnName() throws BOException;
085:
086: /** Getter for the name of the column to store entity state */
087: public String getEntityStateColumnName() throws BOException;
088:
089: /** Getter for the name of the column to store enumnerable value name */
090: public String getReferenceValueColumnName() throws BOException;
091:
092: /** Getter for the name of the column to store enumnerable value description */
093: public String getReferenceDescriptionColumnName()
094: throws BOException;
095:
096: /** Getter for the name of the column to store enumnerable value weight */
097: public String getReferenceWeightColumnName() throws BOException;
098:
099: /** Retrieves relational domain storage definitions for this storage technology */
100: public BORelationalStorageTechnologyDomainStorageList getRelationalDomainStorages()
101: throws BOException;
102:
103: /** Getter for the maximum length of the constraint name */
104: public int getMaxConstraintNameLength() throws BOException;
105:
106: /** Getter for the name conversion algorithm type for the association role referential integrity constraints.
107: * The concatenated association + role name string will be passed to this algorithm */
108: public NameConversionType getAssociationRoleReferentialConstraintNameConversionType()
109: throws BOException;
110:
111: /** Getter for the association role referential integrity constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
112: public String getAssociationRoleReferentialConstraintNamePrefix()
113: throws BOException;
114:
115: /** Getter for the association role referential integrity constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
116: public String getAssociationRoleReferentialConstraintNameSuffix()
117: throws BOException;
118:
119: /** Getter for the name conversion algorithm type for the association primary key constraints.
120: * The association name string will be passed to this algorithm */
121: public NameConversionType getAssociationPrimaryKeyConstraintNameConversionType()
122: throws BOException;
123:
124: /** Getter for the association primary key constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
125: public String getAssociationPrimaryKeyConstraintNamePrefix()
126: throws BOException;
127:
128: /** Getter for the association primary key constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
129: public String getAssociationPrimaryKeyConstraintNameSuffix()
130: throws BOException;
131:
132: /** Getter for the name conversion algorithm type for the entity primary key constraints.
133: * The entity name string will be passed to this algorithm */
134: public NameConversionType getEntityPrimaryKeyConstraintNameConversionType()
135: throws BOException;
136:
137: /** Getter for the entity primary key constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
138: public String getEntityPrimaryKeyConstraintNamePrefix()
139: throws BOException;
140:
141: /** Getter for the entity primary key constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
142: public String getEntityPrimaryKeyConstraintNameSuffix()
143: throws BOException;
144:
145: /** Getter for the name conversion algorithm type for the entity natural primary key constraints.
146: * The entity name string will be passed to this algorithm */
147: public NameConversionType getEntityNaturalPrimaryKeyConstraintNameConversionType()
148: throws BOException;
149:
150: /** Getter for the entity natural primary key constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
151: public String getEntityNaturalPrimaryKeyConstraintNamePrefix()
152: throws BOException;
153:
154: /** Getter for the entity natural primary key constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
155: public String getEntityNaturalPrimaryKeyConstraintNameSuffix()
156: throws BOException;
157:
158: /** Getter for the name conversion algorithm type for the attribute referential constraints.
159: * The entity name string will be passed to this algorithm */
160: public NameConversionType getEntityAttributeRefConstraintNameConversionType()
161: throws BOException;
162:
163: /** Getter for the attribute referential constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
164: public String getEntityAttributeRefConstraintNamePrefix()
165: throws BOException;
166:
167: /** Getter for the attribute referential constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
168: public String getEntityAttributeRefConstraintNameSuffix()
169: throws BOException;
170:
171: /** Getter for the name conversion algorithm type for the enumerable datatype primary key constraints.
172: * The datatype reference string will be passed to this algorithm */
173: public NameConversionType getReferencePrimaryKeyConstraintNameConversionType()
174: throws BOException;
175:
176: /** Getter for the enumerable datatype primary key constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
177: public String getReferencePrimaryKeyConstraintNamePrefix()
178: throws BOException;
179:
180: /** Getter for the enumerable datatype primary key constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
181: public String getReferencePrimaryKeyConstraintNameSuffix()
182: throws BOException;
183:
184: /** Getter for the name conversion algorithm type for the enumerable datatype weight column constraints.
185: * The datatype reference string will be passed to this algorithm */
186: public NameConversionType getReferenceWeightConstraintNameConversionType()
187: throws BOException;
188:
189: /** Getter for the enumerable datatype weight constraint name prefix. It gets prepended to the name after name conversion argorithm is invoked. */
190: public String getReferenceWeightConstraintNamePrefix()
191: throws BOException;
192:
193: /** Getter for the enumerable datatype weight constraint name suffix. It gets appended to the name after name conversion argorithm is invoked. */
194: public String getReferenceWeightConstraintNameSuffix()
195: throws BOException;
196: }
|