org.kuali.rice.kns.bo
Class InactivatableFromToImpl

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.bo.InactivatableFromToImpl

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, ModelObjectBasic, BusinessObject, Inactivateable, InactivateableFromTo, PersistableBusinessObject

Direct Known Subclasses:

KimAbstractMemberImpl, TravelAccountUseRate

@MappedSuperclass
public abstract class InactivatableFromToImpl
extends PersistableBusinessObjectBase
implements InactivateableFromTo

Author:

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

See Also:

Serialized Form

Field Summary

protected Timestamp	activeAsOfDate
protected Timestamp	activeFromDate
protected Timestamp	activeToDate
protected boolean	current

Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

InactivatableFromToImpl()

Method Summary

Timestamp	getActiveAsOfDate() Gets the date for which the record is being compared to in determining active/inactive
Timestamp	getActiveFromDate() Gets the date for which the record become active
Timestamp	getActiveToDate() Gets the date for which the record become inactive
boolean	isActive() Returns active if the getActiveAsOfDate() (current time used if not set) is between the from and to dates.
boolean	isCurrent()
void	setActive(boolean active) Sets the record to active or inactive.
void	setActiveAsOfDate(Timestamp activeAsOfDate) Sets the date for which the record should be compared to in determining active/inactive, if not set then the current date will be used
void	setActiveFromDate(Timestamp from) Sets the date for which record will be active
void	setActiveToDate(Timestamp to) Sets the date for which record will be active to
void	setCurrent(boolean current)

Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase

prepareForWorkflow, toString, toStringBuilder, toStringMapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

toString

Field Detail

activeFromDate

protected Timestamp activeFromDate

activeToDate

protected Timestamp activeToDate

activeAsOfDate

protected Timestamp activeAsOfDate

current

protected boolean current

Constructor Detail

InactivatableFromToImpl

public InactivatableFromToImpl()

Method Detail

isActive

public boolean isActive()

Returns active if the getActiveAsOfDate() (current time used if not set) is between the from and to dates. Null dates are considered to indicate an open range.

Specified by:

isActive in interface Inactivateable

setActive

public void setActive(boolean active)

Description copied from interface: Inactivateable

Sets the record to active or inactive.

Specified by:

setActive in interface Inactivateable

setActiveFromDate

public void setActiveFromDate(Timestamp from)

Description copied from interface: InactivateableFromTo

Sets the date for which record will be active

Specified by:

setActiveFromDate in interface InactivateableFromTo

Parameters:

from - - Timestamp value to set

setActiveToDate

public void setActiveToDate(Timestamp to)

Description copied from interface: InactivateableFromTo

Sets the date for which record will be active to

Specified by:

setActiveToDate in interface InactivateableFromTo

getActiveFromDate

public Timestamp getActiveFromDate()

Description copied from interface: InactivateableFromTo

Gets the date for which the record become active

Specified by:

getActiveFromDate in interface InactivateableFromTo

Returns:

Timestamp

getActiveToDate

public Timestamp getActiveToDate()

Description copied from interface: InactivateableFromTo

Gets the date for which the record become inactive

Specified by:

getActiveToDate in interface InactivateableFromTo

Returns:

Timestamp

getActiveAsOfDate

public Timestamp getActiveAsOfDate()

Description copied from interface: InactivateableFromTo

Gets the date for which the record is being compared to in determining active/inactive

Specified by:

getActiveAsOfDate in interface InactivateableFromTo

Returns:

Timestamp

setActiveAsOfDate

public void setActiveAsOfDate(Timestamp activeAsOfDate)

Description copied from interface: InactivateableFromTo

Sets the date for which the record should be compared to in determining active/inactive, if not set then the current date will be used

Specified by:

setActiveAsOfDate in interface InactivateableFromTo

Parameters:

activeAsOfDate - - Timestamp value to set

isCurrent

public boolean isCurrent()

setCurrent

public void setCurrent(boolean current)