001 /**
002 * Copyright 2005-2013 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.kuali.rice.kim.api.responsibility;
017
018
019 import org.kuali.rice.core.api.mo.common.GloballyUnique;
020 import org.kuali.rice.core.api.mo.common.Identifiable;
021 import org.kuali.rice.core.api.mo.common.Versioned;
022 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
023 import org.kuali.rice.kim.api.common.template.TemplateContract;
024
025 import java.util.Map;
026
027 /**
028 * This is the contract for a Responsibility. Represents a single Responsibility within the system.
029 *
030 * Responsibilities are attached to roles. All authorization checks should be done against Responsibilities,
031 * never against roles or groups.
032 *
033 */
034 public interface ResponsibilityContract extends Versioned, GloballyUnique, Inactivatable, Identifiable{;
035
036 /**
037 * The namespace code that this Responsibility belongs too.
038 *
039 * @return namespaceCode
040 */
041 String getNamespaceCode();
042
043 /**
044 * The name of the Responsibility.
045 *
046 * @return name
047 */
048 String getName();
049
050 /**
051 * The description of the Responsibility.
052 *
053 * @return description
054 */
055 String getDescription();
056
057 /**
058 * The Template referenced by the Responsibility.
059 *
060 * @return templateId
061 */
062 TemplateContract getTemplate();
063
064 /**
065 * Attributes for a Responsibility.
066 *
067 * @return attributes
068 */
069 Map<String, String> getAttributes();
070 }