1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.jetspeed.decoration;
18
19 /***
20 * PageEditAccess representing current Page edit state.
21 *
22 * @author <href a="mailto:ate@douma.nu">Ate Douma</a>
23 * @version $Id$
24 */
25 public interface PageEditAccess
26 {
27 /***
28 * @return true if page editing is allowed
29 */
30 boolean isEditAllowed();
31
32 /***
33 * @return true if page in edit mode
34 */
35 boolean isEditing();
36
37 /***
38 * Switch the Page edit state.
39 * @param editing intended Page edit state
40 * @throws SecurityException when trying to set edit state while not allowed
41 */
42 void setEditing(boolean editing) throws SecurityException;
43 }