01: /* Copyright 2001, 2004 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal.groups;
07:
08: /**
09: * A GroupsException describes a problem in the groups structure or in
10: * the groups store. An example of a structural problem is an attempt
11: * to create a circular reference. If the problem arises retrieving or
12: * updating the groups store, the GroupsException should wrap an Exception
13: * specific to the store, probably a java.sql.SQLException or a
14: * javax.naming.NamingException.
15: *
16: * @author Dan Ellentuck
17: * @version $Revision: 35418 $ $Date: 2005-03-07 13:09:07 -0700 (Mon, 07 Mar 2005) $
18: */
19: public class GroupsException extends org.jasig.portal.PortalException {
20:
21: /**
22: * Instantiate a bare GroupsException.
23: * Deprecated because it would be so much more helpful to use a contructor
24: * that includes a descriptive message.
25: * @deprecated use a more informative constructor
26: */
27: public GroupsException() {
28: super ();
29: }
30:
31: /**
32: * Instantiate a GroupsException with the given cause.
33: * @param cause Throwable that caused the problem
34: */
35: public GroupsException(Throwable cause) {
36: super (cause);
37: }
38:
39: /**
40: * Instantiate a GroupsException with the given message.
41: * @param msg message describing problem
42: */
43: public GroupsException(String msg) {
44: super (msg);
45: }
46:
47: /**
48: * Instantiate a GroupsException with the given message and underlying cause.
49: * @param msg message describing problem
50: * @param cause underlying cause
51: */
52: public GroupsException(String msg, Throwable cause) {
53: super (msg, cause);
54: }
55:
56: /**
57: * Always returns zero.
58: * @return 0
59: * @deprecated
60: */
61: public int getExceptionCode() {
62: return 0;
63: }
64: }
|