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

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

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Historical, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, GroupContract, GroupHistoryContract

public final class GroupHistory
extends AbstractDataTransferObject
implements GroupHistoryContract

See Also:

Serialized Form

Nested Class Summary

static class	GroupHistory.Builder A builder which can be used to construct GroupHistory instances.
static class	GroupHistory.Cache

Method Summary

org.joda.time.DateTime	getActiveFromDate() Gets the date for which the record become active.
org.joda.time.DateTime	getActiveToDate() Gets the date for which the record become inactive.
Map<String,String>	getAttributes() This is a set of Attributes for a Group.
String	getDescription() This a description for the Group.
Long	getHistoryId()
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.
boolean	isActive(org.joda.time.DateTime activeAsOf) Returns if the record is active for a given Time.
boolean	isActiveNow()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

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

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

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

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

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

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.

isActiveNow

public boolean isActiveNow()

Specified by:

isActiveNow in interface Historical

isActive

public boolean isActive(org.joda.time.DateTime activeAsOf)

Description copied from interface: InactivatableFromTo

Returns if the record is active for a given Time. If the activeAsOfDate is null will return null.

Specified by:

isActive in interface InactivatableFromTo

Returns:

true if active false if not

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

getHistoryId

public Long getHistoryId()

Specified by:

getHistoryId in interface Historical

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become active. Can be null.

Specified by:

getActiveFromDate in interface InactivatableFromTo

Returns:

Timestamp of active from date

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become inactive. Can be null.

Specified by:

getActiveToDate in interface InactivatableFromTo

Returns:

Timestamp of active to date