added some events, utility code, container handling and testint code
[Evergreen.git] / Open-ILS / src / extras / ils_events.xml
1 <ils_events>
2         <notes>
3                 This file describes the event codes that an ILS method might return.  Not all
4                 methods will return event codes and it is up to each method to define which
5                 types of events it may return.  The standard event procedure is to return an
6                 object (JSON hash) with a field called "ilsevent" which contains the event code
7                 below.
8
9                 If events need to be placed into groups for any reason, the segregation shall
10                 be defined below with the accompanying events.
11         </notes>
12
13         <event code='0' textcode='SUCCESS'>
14                 <desc>No errors or unexpected events occurred</desc>
15         </event>
16
17         <event code='1000' textcode='LOGIN_FAILED'>
18                 <desc>
19                         User login failed.  Why the login failed is not specified.
20                 </desc>
21         </event>
22
23         <event code='1001' textcode='NO_SESSION'>
24                 <desc>
25                         User login session has either timed out or does not exist.
26                 </desc>
27         </event>
28
29         <event code='1002' textcode='USER_NOT_FOUND'>
30                 <desc>
31                         Someone attempted to retrieve a user from the system and the user
32                         was not found.
33                 </desc>
34         </event>
35
36         <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
37                 <desc>
38                         Someone attempted to retrieve a circulation object from the system and 
39                         the object was not found.
40                 </desc>
41         </event>
42
43         <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
44                 <desc>
45                         Someone attempted to retrieve a biblio record entry object from the 
46                         system and the object was not found.
47                 </desc>
48         </event>
49
50         <event code='1502' textcode='COPY_NOT_FOUND'>
51                 <desc>
52                         Someone attempted to retrieve a copy object from the 
53                         system and the object was not found.
54                 </desc>
55         </event>
56
57         <event code='1503' textcode='HOLD_NOT_FOUND'>
58                 <desc>
59                         Someone attempted to retrieve a hold object from the 
60                         system and the object was not found.
61                 </desc>
62         </event>
63
64         <event code='1503' textcode='TRANSIT_NOT_FOUND'>
65                 <desc>
66                         Someone attempted to retrieve a transit object from the 
67                         system and the object was not found.
68                 </desc>
69         </event>
70
71         <event code='1503' textcode='BILLING_NOT_FOUND'>
72                 <desc>
73                         Someone attempted to retrieve a transit object from the 
74                         system and the object was not found.
75                 </desc>
76         </event>
77
78         <event code='1504' textcode='CONTAINER_NOT_FOUND'>
79                 <desc>
80                         Someone attempted to retrieve a container object from the 
81                         system and the object was not found.
82                 </desc>
83         </event>
84
85         <event code='1505' textcode='CONTAINER_ITEM_NOT_FOUND'>
86                 <desc>
87                         Someone attempted to retrieve a container item object from the 
88                         system and the object was not found.
89                 </desc>
90         </event>
91
92
93
94         <event code='1700' textcode='ROUTE_COPY'>
95                 <desc>
96                         A copy needs to be routed to a different location       
97                 </desc>
98         </event>
99
100
101         <event code='2000' textcode='BAD_PARAMS'>
102                 <desc>
103                         Invalid parameters were encountered in a method
104                 </desc>
105         </event>
106
107         <event code='5000' textcode='PERM_FAILURE'>
108                 <desc> 
109                         Permission Error.  * The object returning this code shall also 
110                         contain a field "ilsperm" containing the name of the permission which failed 
111                         and a field called "ilspermloc" defining the location at which the permission
112                         failed if available.
113                 </desc>
114         </event>
115 </ils_events>
116
117
118
119