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.IHasObjectType, com.helger.commons.type.ITypedObject<String>, com.helger.datetime.domain.IHasCreationDateTime, com.helger.datetime.domain.IHasDeletionDateTime, com.helger.datetime.domain.IHasLastModificationDateTime, IHasCreationInfo, IHasDeletionInfo, IHasLastModificationInfo, IObject, Serializable

Direct Known Subclasses:

AbstractBaseObjectWithCustomAttrs, AbstractObject

@Immutable
public abstract class AbstractBaseObject
extends Object
implements IObject

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

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.joda.time.LocalDateTime	getCreationDateTime()
String	getCreationUserID()
org.joda.time.LocalDateTime	getDeletionDateTime()
String	getDeletionUserID()
String	getID()
org.joda.time.LocalDateTime	getLastModificationDateTime()
String	getLastModificationUserID()
boolean	isDeleted()
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.LocalDateTime aDeletionDT, String sDeletionUserID)
void	setLastModification(org.joda.time.LocalDateTime aLastModificationDT, String sLastModificationUserID)
com.helger.commons.state.EChange	setUndeletion(org.joda.time.LocalDateTime aUndeletionDT, String sUndeletionUserID)
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.IHasObjectType

getObjectType

Constructor Detail

AbstractBaseObject

public AbstractBaseObject(@Nonnull
                          IObject aObject)

AbstractBaseObject

public AbstractBaseObject(@Nonnull @Nonempty
                          String sID,
                          @Nullable
                          org.joda.time.LocalDateTime aCreationDT,
                          @Nullable
                          String sCreationUserID,
                          @Nullable
                          org.joda.time.LocalDateTime aLastModificationDT,
                          @Nullable
                          String sLastModificationUserID,
                          @Nullable
                          org.joda.time.LocalDateTime 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.LocalDateTime getCreationDateTime()

Specified by:

getCreationDateTime in interface com.helger.datetime.domain.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.LocalDateTime getLastModificationDateTime()

Specified by:

getLastModificationDateTime in interface com.helger.datetime.domain.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.

setLastModification

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

getDeletionDateTime

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

Specified by:

getDeletionDateTime in interface com.helger.datetime.domain.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.

setDeletion

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

setUndeletion

@Nonnull
public final com.helger.commons.state.EChange setUndeletion(@Nonnull
                                                                      org.joda.time.LocalDateTime 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.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