Package org.kuali.rice.kim.api.permission

Interface PermissionContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
Permission, Permission.Builder
public interface PermissionContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Identifiable
This is the contract for a Permission. Represents a single permission within the system. Permissions are attached to roles. All authorization checks should be done against permissions, never against roles or groups.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getAttributes()
    Attributes for a Permission.
    String
    getDescription()
    The description of the Permission.
    String
    getName()
    The name of the Permission.
    String
    getNamespaceCode()
    The namespace code that this Permission belongs too.
    TemplateContract
    getTemplate()
    The Template referenced by the Permission.

    Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

    getObjectId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

    getId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Method Details

    • getNamespaceCode

      String getNamespaceCode()
      The namespace code that this Permission belongs too.
      Returns:
      namespaceCode

    • getName

      String getName()
      The name of the Permission.
      Returns:
      name

    • getDescription

      String getDescription()
      The description of the Permission.
      Returns:
      description

    • getTemplate

      TemplateContract getTemplate()
      The Template referenced by the Permission.
      Returns:
      templateId

    • getAttributes

      Map<String,String> getAttributes()
      Attributes for a Permission.
      Returns:
      attributes