1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.connector.meta.jdbc;
25
26 import java.sql.DatabaseMetaData;
27
28 /**
29 * Container for column-level metadata. The fields in this class roughly parallel the information returned from the
30 * {@link DatabaseMetaData#getProcedures(String, String, String)} method.
31 */
32 public class ProcedureMetadata {
33
34 private final String name;
35 private final String description;
36 private final int type;
37
38 public ProcedureMetadata( String name,
39 String description,
40 int type ) {
41 super();
42 this.name = name;
43 this.description = description;
44 this.type = type;
45 }
46
47 /**
48 * @return the procedure name (PROCEDURE_NAME in the {@link DatabaseMetaData#getProcedures(String, String, String)} result
49 * set).
50 */
51 public String getName() {
52 return name;
53 }
54
55 /**
56 * @return the procedure description (REMARKS in the {@link DatabaseMetaData#getProcedures(String, String, String)} result
57 * set).
58 */
59 public String getDescription() {
60 return description;
61 }
62
63 /**
64 * @return the kind of procedure (PROCEDURE_TYPE in the {@link DatabaseMetaData#getProcedures(String, String, String)} result
65 * set).
66 */
67 public int getType() {
68 return type;
69 }
70
71 }