Package org.kuali.rice.kim.framework.role

Interface RoleEbo

All Superinterfaces:
org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.ExternalizableBusinessObject, 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.ModelObjectBasic, org.kuali.rice.kim.api.role.RoleContract, Serializable, org.kuali.rice.core.api.mo.common.Versioned
public interface RoleEbo extends org.kuali.rice.kim.api.role.RoleContract, org.kuali.rice.krad.bo.ExternalizableBusinessObject
TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    A full textual description of this role.
    String
    getId()
    The unique identifier for an object.
    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.
    String
    getObjectId()
    Return the globally unique object id of this object.
    Long
    getVersionNumber()
    Returns the version number for this object.
    boolean
    isActive()
    The active indicator for an object.

    Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

    refresh

    Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

    toString

  • Method Details

    • getNamespaceCode

      String getNamespaceCode()
      A namespace for this role. A namespace for a role identifies the system/module to which this role applies.
      Specified by:
      getNamespaceCode in interface org.kuali.rice.kim.api.role.RoleContract
      Returns:
      Namespace for the role.

    • getName

      String getName()
      The human readable name for this role.
      Specified by:
      getName in interface org.kuali.rice.kim.api.role.RoleContract
      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.
      Specified by:
      getDescription in interface org.kuali.rice.kim.api.role.RoleContract
      Returns:
      Description of the role.

    • getKimTypeId

      String getKimTypeId()
      Provides the associated KimType identifier for this role. This controls what additional attributes are available.
      Specified by:
      getKimTypeId in interface org.kuali.rice.kim.api.role.RoleContract
      Returns:
      KimType Id

    • getVersionNumber

      Long getVersionNumber()
      Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.
      Specified by:
      getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned
      Returns:
      the version number, or null if one has not been assigned yet

    • getId

      String getId()
      The unique identifier for an object. This can be null.
      Specified by:
      getId in interface org.kuali.rice.core.api.mo.common.Identifiable
      Returns:
      the id

    • isActive

      boolean isActive()
      The active indicator for an object.
      Specified by:
      isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable
      Returns:
      true if active false if not.

    • getObjectId

      String getObjectId()
      Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.
      Specified by:
      getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique
      Returns:
      the objectId of this object, or null if it has not been set yet