KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > buchuki > ensmer > prevayler > queries > GetAreaUserPositionQuery


1 /*
2  * Copyright 2004 Dusty Phillips
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */

16 package com.buchuki.ensmer.prevayler.queries;
17 import java.util.Date JavaDoc;
18 import com.buchuki.ensmer.prevayler.*;
19
20 import org.prevayler.*;
21
22 /**
23  * Query to retrieve the user's position in a particular area
24  *
25  * @author Dusty Phillips [dusty@buchuki.com]
26  */

27 public class GetAreaUserPositionQuery implements Query {
28
29     /**
30      * Construct the Query with a reference to the identifier that needs to be
31      * queried.
32      *
33      * @param id the identifier of the area that we want to determine the user
34      * position for
35      */

36     public GetAreaUserPositionQuery(long id) {
37         this.id = id;
38     }
39
40     /**
41      * Execute the query
42      *
43      * @param system the EnsmerPrevayler to interact with
44      * @param ignored the date the item is executed, ignored in this case
45      * @return the query's result
46      */

47     public Object JavaDoc query(Object JavaDoc system, Date JavaDoc ignored) {
48         return ((EnsmerPrevayler) system).getAreaPrevayler().getUserPosition(id);
49     }
50
51     /**
52      * The identifier of the Area that we want to determine the user position for.
53      */

54     private long id;
55 }
56
57
Popular Tags