KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > iapi > sql > dictionary > ConsInfo


1 /*
2
3    Derby - Class org.apache.derby.iapi.sql.dictionary.ConsInfo
4
5    Licensed to the Apache Software Foundation (ASF) under one or more
6    contributor license agreements. See the NOTICE file distributed with
7    this work for additional information regarding copyright ownership.
8    The ASF licenses this file to you under the Apache License, Version 2.0
9    (the "License"); you may not use this file except in compliance with
10    the License. You may obtain a copy of the License at
11
12       http://www.apache.org/licenses/LICENSE-2.0
13
14    Unless required by applicable law or agreed to in writing, software
15    distributed under the License is distributed on an "AS IS" BASIS,
16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17    See the License for the specific language governing permissions and
18    limitations under the License.
19
20  */
21
22 package org.apache.derby.iapi.sql.dictionary;
23
24 import org.apache.derby.iapi.services.io.Formatable;
25
26 import org.apache.derby.iapi.error.StandardException;
27
28 /**
29  * This interface describes the columns in a referenced constraint. Added
30  * to be the protocol version of ConstraintInfo.
31  *
32  * @version 0.1
33  * @author Rick Hillegas
34  */
35
36 public interface ConsInfo extends Formatable
37 {
38     /**
39       * This ConsInfo describes columns in a referenced table. What is
40       * the schema that the referenced table lives in?
41       *
42       * @param dd data dictionary to search for schema
43       *
44       * @return schema that referenced table lives in
45       * @exception StandardException thrown on oops
46       */
47     public SchemaDescriptor getReferencedTableSchemaDescriptor(DataDictionary dd)
48         throws StandardException;
49
50     /**
51       * This ConsInfo describes columns in a referenced table. What is
52       * that table?
53       *
54       * @param dd data dictionary to search for table
55       *
56       * @return referenced table
57       * @exception StandardException thrown on oops
58       */
59     public TableDescriptor getReferencedTableDescriptor(DataDictionary dd)
60         throws StandardException;
61
62     /**
63       * This ConsInfo describes columns in a referenced table. What are
64       * their names?
65       *
66       * @return array of referenced column names
67       */
68     public String JavaDoc[] getReferencedColumnNames();
69
70     /**
71       * Get the name of the table that these column live in.
72       *
73       * @return referenced table name
74       */
75     public String JavaDoc getReferencedTableName();
76
77
78     /**
79       * Get the referential Action for an Update.
80       *
81       * @return referential Action for update
82       */
83
84     public int getReferentialActionUpdateRule();
85     
86     /**
87       * Get the referential Action for a Delete.
88       *
89       * @return referential Action Delete rule
90       */
91     public int getReferentialActionDeleteRule();
92
93 }
94
95
96
97
Popular Tags