01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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:
17: package org.compass.spring.web.mvc;
18:
19: /**
20: * The command object which instructs the
21: * {@link org.compass.spring.web.mvc.CompassIndexController} to perform
22: * <code>CompassGps</code> index operation.
23: * <p>
24: * Since the index operation might result in heavy performance effects (re-index
25: * all of <code>CompassGps</code>), the command proeprty <code>doIndex</code>
26: * must be set to true in order to perform it.
27: *
28: * @author kimchy
29: */
30: public class CompassIndexCommand {
31:
32: private String doIndex;
33:
34: /**
35: * Returns the <code>doIndex</code> commnand property, which instructs the
36: * {@link CompassIndexController} to performs the index operation.
37: *
38: * @return <code>true</code> if the index operation should be performed
39: */
40: public String getDoIndex() {
41: return doIndex;
42: }
43:
44: /**
45: * Sets the <code>doIndex</code> commnand property, which instructs the
46: * {@link CompassIndexController} to performs the index operation.
47: *
48: * @param doIndex <code>true</code> if the index operation should be performed
49: */
50: public void setDoIndex(String doIndex) {
51: this.doIndex = doIndex;
52: }
53: }
|