org.kuali.rice.kim.api.group
Class Group

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.group.Group

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, GroupContract

public final class Group
extends AbstractDataTransferObject
implements GroupContract

See Also:

Serialized Form

Nested Class Summary

static class	Group.Builder This builder constructs an Group enforcing the constraints of the GroupContract.
static class	Group.Cache

Constructor Summary

Group(Group.Builder builder)

Method Summary

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 class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group(Group.Builder builder)

Method Detail

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: GroupContract

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 GroupContract

Returns:

namespaceCode

getName

public String getName()

Description copied from interface: GroupContract

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 GroupContract

Returns:

name

getDescription

public String getDescription()

Description copied from interface: GroupContract

This a description for the Group.

This is a description assigned to a Group.

Specified by:

getDescription in interface GroupContract

Returns:

description

getKimTypeId

public String getKimTypeId()

Description copied from interface: GroupContract

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 GroupContract

Returns:

description

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: GroupContract

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 GroupContract

Returns:

attributes

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

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 Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

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 GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet