01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/authz/tags/sakai_2-4-1/authz-api/api/src/java/org/sakaiproject/authz/api/PermissionsHelper.java $
03: * $Id: PermissionsHelper.java 9989 2006-05-25 20:10:55Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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.authz.api;
21:
22: /**
23: * <p>
24: * PermissionsHelper describes the contract (API) between the client tool and the permissions helper tool.
25: * </p>
26: */
27: public interface PermissionsHelper {
28: /** Set this tool state attribute with the prefix for the permission functions to consider for editing (i.e. "content.") */
29: static final String PREFIX = "sakaiproject.permissions.prefix";
30:
31: /** Set this tool state attribute with descriptive text for the editor. */
32: static final String DESCRIPTION = "sakaiproject.permissions.description";
33:
34: /** Set this tool state attribute to the entity reference of the entity whose AuthzGroup is to be edited. */
35: static final String TARGET_REF = "sakaiproject.permissions.targetRef";
36:
37: /** Set this tool state attribute to the entity reference of the entity which controls the role definitions, if different than the target_ref (leave it unset if target_ref has the roles needed). */
38: static final String ROLES_REF = "sakaiproject.permissions.rolesRef";
39: }
|