org.kuali.rice.kim.api.group

Interface GroupContract

All Superinterfaces:

GloballyUnique, Identifiable, Inactivatable, Versioned

All Known Subinterfaces:

GroupEbo

All Known Implementing Classes:

Group, Group.Builder, GroupBase, GroupBo

public interface GroupContract
extends Versioned, GloballyUnique, Inactivatable, Identifiable

This is the contract for a Group. A group is a collection of principals. It's membership consists of direct principal assignment and/or nested group membership. All groups are uniquely identified by a namespace code plus a name.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() This is a set of Attributes for a Group.
String	getDescription() This a description for the Group.
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.

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

getVersionNumber

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

getObjectId

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

getId

Method Detail

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

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

Returns:

name

getDescription

String getDescription()

This a description for the Group.

This is a description assigned to a Group.

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.

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.

Returns:

attributes