01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/search/tags/sakai_2-4-1/search-api/api/src/java/org/sakaiproject/search/model/SearchWriterLock.java $
03: * $Id: SearchWriterLock.java 9109 2006-05-08 14:44:04Z ian@caret.cam.ac.uk $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.search.model;
21:
22: import java.util.Date;
23:
24: /**
25: * @author ieb
26: */
27: public interface SearchWriterLock {
28: String getId();
29:
30: void setId(String id);
31:
32: /**
33: * the name of the node holding the lock
34: *
35: * @return
36: */
37: String getNodename();
38:
39: /**
40: * the name of the node holding the lock
41: *
42: * @param nodeName
43: */
44: void setNodename(String nodeName);
45:
46: /**
47: * The name of the lock
48: *
49: * @param lockkey
50: */
51: void setLockkey(String lockkey);
52:
53: /**
54: * The name of the lock
55: *
56: * @return
57: */
58: String getLockkey();
59:
60: /**
61: * The date when the lock will expire
62: * @param exopiry
63: */
64: void setExpires(Date expires);
65:
66: /**
67: * The date when the lock will expire
68: * @return
69: */
70: Date getExpires();
71:
72: }
|