Package org.kuali.rice.kim.framework.group

Interface GroupEbo

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.kim.api.group.GroupContract, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.ModelObjectBasic, Serializable, org.kuali.rice.core.api.mo.common.Versioned
public interface GroupEbo extends org.kuali.rice.kim.api.group.GroupContract, 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
    Map<String,String>
    getAttributes()
    This is a set of Attributes for a Group.
    String
    getDescription()
    This a description for the Group.
    String
    getId()
    The unique identifier for an object.
    String
    getKimTypeId()
    This a Kim Type Id for the Group.
    String
    getName()
    This is the name for the Group.
    String
    getNamespaceCode()
    This is the namespace code for the Group.
    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()
      This is the namespace code for the Group.

      This is a namespace code assigned to a Group. Together with name, it makes up another unique identifier for Group

      Specified by:
      getNamespaceCode in interface org.kuali.rice.kim.api.group.GroupContract
      Returns:
      namespaceCode

    • getName

      String getName()
      This is the name for the Group.

      This is a name assigned to a Group. Together with NamespaceCode, it makes up another unique identifier for Group

      Specified by:
      getName in interface org.kuali.rice.kim.api.group.GroupContract
      Returns:
      name

    • getDescription

      String getDescription()
      This a description for the Group.

      This is a description assigned to a Group.

      Specified by:
      getDescription in interface org.kuali.rice.kim.api.group.GroupContract
      Returns:
      description

    • getKimTypeId

      String getKimTypeId()
      This a Kim Type Id for the Group.

      This links a Kim Type to the Group to allow custom types of Groups.

      Specified by:
      getKimTypeId in interface org.kuali.rice.kim.api.group.GroupContract
      Returns:
      description

    • getAttributes

      Map<String,String> getAttributes()
      This is a set of Attributes for a Group.

      This is a set of attributes which are key-label pairs that are defined by the Group's Kim Type.

      Specified by:
      getAttributes in interface org.kuali.rice.kim.api.group.GroupContract
      Returns:
      attributes

    • 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

    • 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

    • 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

    • 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.