Package org.kuali.rice.kim.api.role

Interface RoleContract

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:
Role, Role.Builder
public interface RoleContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.GloballyUnique
Contract for a Role. Role is a basic abstraction over a role assignable to a principal within KIM.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    A full textual description of this role.
    String
    getKimTypeId()
    Provides the associated KimType identifier for this role.
    String
    getName()
    The human readable name for this role.
    String
    getNamespaceCode()
    A namespace for this role.

    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()
      A namespace for this role. A namespace for a role identifies the system/module to which this role applies.
      Returns:
      Namespace for the role.

    • getName

      String getName()
      The human readable name for this role.
      Returns:
      Human readable role name.

    • getDescription

      String getDescription()
      A full textual description of this role. This String should provide a verbose description of the role, what it is meant to provide to principals assigned to it, and what permissions it implies.
      Returns:
      Description of the role.

    • getKimTypeId

      String getKimTypeId()
      Provides the associated KimType identifier for this role. This controls what additional attributes are available.
      Returns:
      KimType Id