com.helger.photon.basic.object

Class AbstractBaseObject

java.lang.Object

com.helger.photon.basic.object.AbstractBaseObject

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.type.IHasType, com.helger.commons.type.ITypedObject<String>, com.helger.datetime.IHasCreationDateTime, com.helger.datetime.IHasDeletionDateTime, com.helger.datetime.IHasLastModificationDateTime, IHasCreationInfo, IHasDeletionInfo, IHasLastModificationInfo, IObject

Direct Known Subclasses:

AbstractAccountingAreaObject, AbstractAccountingAreaOptionalObject, AbstractClientObject, AbstractObject

@Immutable
public abstract class AbstractBaseObject
extends Object
implements IObject

Abstract base implementation of IObject that handles everything except IHasType.getTypeID(), Object.equals(Object) and Object.hashCode().

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractBaseObject(IObject aObject)
AbstractBaseObject(String sID, org.joda.time.DateTime aCreationDT, String sCreationUserID, org.joda.time.DateTime aLastModificationDT, String sLastModificationUserID, org.joda.time.DateTime aDeletionDT, String sDeletionUserID)

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	getCreationDateTime()
String	getCreationUserID()
org.joda.time.DateTime	getDeletionDateTime()
String	getDeletionUserID()
String	getID()
org.joda.time.DateTime	getLastModificationDateTime()
String	getLastModificationUserID()
boolean	isDeleted()
boolean	isDeleted(org.joda.time.DateTime aDT) Check if the object was deleted at the specified date time.
boolean	isDeleted(org.joda.time.LocalDateTime aDT) Check if the object was deleted at the specified local date time.
com.helger.commons.state.EChange	setDeletion(org.joda.time.DateTime aDeletionDT, String sDeletionUserID)
com.helger.commons.state.EChange	setDeletionNow()
void	setLastModification(org.joda.time.DateTime aLastModificationDT, String sLastModificationUserID)
void	setLastModificationNow()
com.helger.commons.state.EChange	setUndeletion(org.joda.time.DateTime aUndeletionDT, String sUndeletionUserID)
com.helger.commons.state.EChange	setUndeletionNow()
String	toString()

Methods inherited from class java.lang.Object

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

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

getTypeID

Constructor Detail

AbstractBaseObject

public AbstractBaseObject(@Nonnull
                  IObject aObject)

AbstractBaseObject

public AbstractBaseObject(@Nonnull@Nonempty
                  String sID,
                  @Nullable
                  org.joda.time.DateTime aCreationDT,
                  @Nullable
                  String sCreationUserID,
                  @Nullable
                  org.joda.time.DateTime aLastModificationDT,
                  @Nullable
                  String sLastModificationUserID,
                  @Nullable
                  org.joda.time.DateTime aDeletionDT,
                  @Nullable
                  String sDeletionUserID)

Method Detail

getID

@Nonnull
@Nonempty
public final String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getCreationDateTime

@Nullable
public final org.joda.time.DateTime getCreationDateTime()

Specified by:

getCreationDateTime in interface com.helger.datetime.IHasCreationDateTime

Specified by:

getCreationDateTime in interface IObject

Returns:

The null-able creation date time of the object

getCreationUserID

@Nullable
public final String getCreationUserID()

Specified by:

getCreationUserID in interface IHasCreationInfo

Specified by:

getCreationUserID in interface IObject

Returns:

The user ID who created the object. May be null in case of migrated content.

getLastModificationDateTime

@Nullable
public final org.joda.time.DateTime getLastModificationDateTime()

Specified by:

getLastModificationDateTime in interface com.helger.datetime.IHasLastModificationDateTime

getLastModificationUserID

@Nullable
public final String getLastModificationUserID()

Specified by:

getLastModificationUserID in interface IHasLastModificationInfo

Returns:

The user ID who last modified the object or null if this object has not yet been modified.

setLastModificationNow

public final void setLastModificationNow()

setLastModification

public final void setLastModification(@Nonnull
                       org.joda.time.DateTime aLastModificationDT,
                       @Nonnull@Nonempty
                       String sLastModificationUserID)

getDeletionDateTime

@Nullable
public final org.joda.time.DateTime getDeletionDateTime()

Specified by:

getDeletionDateTime in interface com.helger.datetime.IHasDeletionDateTime

getDeletionUserID

@Nullable
public final String getDeletionUserID()

Specified by:

getDeletionUserID in interface IHasDeletionInfo

Returns:

The user ID who deleted the object or null if this object has not yet been deleted.

setDeletionNow

@Nonnull
public final com.helger.commons.state.EChange setDeletionNow()

setDeletion

@Nonnull
public final com.helger.commons.state.EChange setDeletion(@Nonnull
                                                   org.joda.time.DateTime aDeletionDT,
                                                   @Nonnull@Nonempty
                                                   String sDeletionUserID)

setUndeletionNow

@Nonnull
public final com.helger.commons.state.EChange setUndeletionNow()

setUndeletion

@Nonnull
public final com.helger.commons.state.EChange setUndeletion(@Nonnull
                                                     org.joda.time.DateTime aUndeletionDT,
                                                     @Nonnull@Nonempty
                                                     String sUndeletionUserID)

isDeleted

public final boolean isDeleted()

Specified by:

isDeleted in interface IObject

Returns:

true if this object is deleted, false if not.

isDeleted

public final boolean isDeleted(@Nonnull
                org.joda.time.DateTime aDT)

Description copied from interface: IObject

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

Specified by:

isDeleted in interface IObject

Parameters:

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

Returns:

true if this object was deleted, false if not.

isDeleted

public final boolean isDeleted(@Nonnull
                org.joda.time.LocalDateTime aDT)

Description copied from interface: IObject

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:

isDeleted in interface IObject

Parameters:

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

Returns:

true if this object was deleted, false if not.

toString

public String toString()

Overrides:

toString in class Object