Package com.helger.tenancy

Interface IBusinessObject

All Superinterfaces:

com.helger.datetime.domain.IHasCreationDateTime, IHasCreationInfo, com.helger.datetime.domain.IHasDeletionDateTime, IHasDeletionInfo, com.helger.commons.id.IHasID<String>, com.helger.datetime.domain.IHasLastModificationDateTime, IHasLastModificationInfo, com.helger.commons.type.IHasObjectType, com.helger.commons.type.ITypedObject<String>, Serializable

All Known Subinterfaces:

IAccountingArea, IAccountingAreaObject, ITenant, ITenantObject

All Known Implementing Classes:

AbstractAccountingArea, AbstractBusinessObject, AbstractTenantObject

public interface IBusinessObject
extends com.helger.commons.type.ITypedObject<String>, IHasCreationInfo, IHasLastModificationInfo, IHasDeletionInfo, Serializable

Base interface for all business objects. Has a creation, last modification and deletion user ID and date time.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
com.helger.commons.collection.attr.IStringMap	attrs()
default LocalDateTime	getLastChangeDateTime()
default boolean	isDeleted()
default boolean	isDeletedAt(LocalDateTime aDT)	Check if the object was deleted at the specified local date time.
default boolean	isLastChangeAfter(LocalDateTime aDT)	Check if the last change date is after the provider date time.
default boolean	isNotDeleted()

Methods inherited from interface com.helger.datetime.domain.IHasCreationDateTime

getCreationDate, getCreationDateTime, getCreationTime, hasCreationDateTime, isCreatedAt

Methods inherited from interface com.helger.tenancy.datetime.IHasCreationInfo

getCreationUserID, hasCreationUserID

Methods inherited from interface com.helger.datetime.domain.IHasDeletionDateTime

getDeletionDate, getDeletionDateTime, getDeletionTime, hasDeletionDateTime

Methods inherited from interface com.helger.tenancy.datetime.IHasDeletionInfo

getDeletionUserID, hasDeletionUserID

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.datetime.domain.IHasLastModificationDateTime

getLastModificationDate, getLastModificationDateTime, getLastModificationTime, hasLastModificationDateTime, isLastModifiedAt

Methods inherited from interface com.helger.tenancy.datetime.IHasLastModificationInfo

getLastModificationUserID, hasLastModificationUserID

Methods inherited from interface com.helger.commons.type.IHasObjectType

getObjectType, getObjectTypeName, hasObjectType

Method Detail

getLastChangeDateTime

@Nullable
default LocalDateTime getLastChangeDateTime()

Returns:

The latest date time that something changed. This is the latest date time from IHasCreationDateTime.getCreationDateTime(), IHasLastModificationDateTime.getLastModificationDateTime() and IHasDeletionDateTime.getDeletionDateTime(). It may be null if no time is defined at all.

isLastChangeAfter

default boolean isLastChangeAfter(@Nonnull
                                  LocalDateTime aDT)

Check if the last change date is after the provider date time.

Parameters:

aDT - The date time to check against. May not be null.

Returns:

true if a last change date time is present and is after the provided date time.

See Also:

getLastChangeDateTime()

isDeleted

default boolean isDeleted()

Returns:

true if this object is deleted, false if not.

See Also:

isNotDeleted()

isNotDeleted

default boolean isNotDeleted()

Returns:

true if this object is not deleted, false if it is deleted.

Since:

6.1.1

See Also:

isDeleted()

isDeletedAt

default boolean isDeletedAt(@Nonnull
                            LocalDateTime aDT)

Check if the object was deleted at the specified local date time. This is true, if the deletion time is ≤ than the specified local date time.

Specified by:

isDeletedAt in interface com.helger.datetime.domain.IHasDeletionDateTime

Parameters:

aDT - The time to check for deletion. May not be null.

Returns:

true if this object was deleted, false if not.

attrs

@Nonnull
@ReturnsMutableObject
com.helger.commons.collection.attr.IStringMap attrs()

Returns:

Custom attributes. Never null.