KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > directory > ldapstudio > browser > core > events > SearchUpdateEvent


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  *
19  */
20
21 package org.apache.directory.ldapstudio.browser.core.events;
22
23
24 import org.apache.directory.ldapstudio.browser.core.model.ISearch;
25
26
27 /**
28  * An SearchUpdateEvent indicates that an {@link ISearch} was updated.
29  *
30  * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
31  * @version $Rev$, $Date$
32  */
33 public class SearchUpdateEvent
34 {
35
36     /**
37      * Contains constants to specify the event detail.
38      */
39     public enum EventDetail
40     {
41
42         /** Indicates that the search was added. */
43         SEARCH_ADDED,
44
45         /** Indicates that the search was removed. */
46         SEARCH_REMOVED,
47
48         /** Indicates that the search was performed. */
49         SEARCH_PERFORMED,
50
51         /**
52          * Indicates that the search parameters were updated.
53          * Note: This event detail doesn't include the renaming of a search!
54          */
55         SEARCH_PARAMETER_UPDATED,
56
57         /** Indicates that the search was renamed. */
58         SEARCH_RENAMED
59     }
60
61     /** The event detail. */
62     private EventDetail detail;
63
64     /** The updated search. */
65     private ISearch search;
66
67
68     /**
69      * Creates a new instance of SearchUpdateEvent.
70      *
71      * @param search the updated search
72      * @param detail the event detail
73      */
74     public SearchUpdateEvent( ISearch search, EventDetail detail )
75     {
76         this.search = search;
77         this.detail = detail;
78     }
79
80
81     /**
82      * Gets the updated search.
83      *
84      * @return the updated search
85      */
86     public ISearch getSearch()
87     {
88         return search;
89     }
90
91
92     /**
93      * Gets the event detail.
94      *
95      * @return the event detail
96      */
97     public EventDetail getDetail()
98     {
99         return detail;
100     }
101
102 }
103
Popular Tags