org.kuali.rice.core.api.mo.common.active
Interface InactivatableFromTo

All Superinterfaces:
Inactivatable
All Known Subinterfaces:
DelegateMemberContract, GroupMemberContract, RoleMemberContract
All Known Implementing Classes:
DelegateMember, DelegateMember.Builder, GroupMember, GroupMember.Builder, RoleMember, RoleMember.Builder

public interface InactivatableFromTo
extends Inactivatable

This interface can be used to identify a model object which has an "active range" such that an object is only active with a certain temporal range.

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

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.
 boolean isActive(org.joda.time.DateTime activeAsOfDate)
          Returns if the record is active for a given Time.
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable
isActive
 

Method Detail

getActiveFromDate

org.joda.time.DateTime getActiveFromDate()
Gets the date for which the record become active. Can be null.

Returns:
Timestamp of active from date

getActiveToDate

org.joda.time.DateTime getActiveToDate()
Gets the date for which the record become inactive. Can be null.

Returns:
Timestamp of active to date

isActive

boolean isActive(org.joda.time.DateTime activeAsOfDate)
Returns if the record is active for a given Time. If the activeAsOfDate is null will return null.

Returns:
true if active false if not


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.