Package com.proxemo.todo4.bom

Class ToDoVersionedIdentifiable

java.lang.Object

com.proxemo.todo4.bom.ToDoVersionedIdentifiable

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ToDoAttachment, ToDoAttachmentProxy, ToDoContact, ToDoEventLog, ToDoForm, ToDoFormField, ToDoGroupPermission, ToDoInquiry, ToDoLabel, ToDoMailAttachment, ToDoMailbox, ToDoMembership, ToDoOutgoingMail, ToDoProperty, ToDoRoutingHistory, ToDoRPCBackend, ToDoScheduledScriptJob, ToDoSmsFetcher, ToDoTask, ToDoTaskChain, ToDoUser, ToDoUserPushSubscription, ToDoWorkGroup

public abstract class ToDoVersionedIdentifiable
extends java.lang.Object
implements java.io.Serializable

The base class for all business objects in todo4teams. It implements optimistic locking via the version attribute, an OR-Mapping via the id attribute and logic deletion with the active flag.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ToDoVersionedIdentifiable()

Method Summary

Modifier and Type	Method	Description
abstract void	anonymize()
Image	getActiveAsIcon()
java.lang.String	getAnonymizeString()
java.lang.String	getCanonicalId()	Method returning a system wide canonical id consisting of the canonical class name of the object and the id.
abstract java.lang.Long	getId()	Method returning a canonical id of the object.
abstract java.lang.Integer	getVersion()	Method returning the version of the instance
abstract java.lang.Boolean	isActive()	Method that returns whether the instance is active or not (means: logically deleted)
boolean	isTransient()	Method that returns whether the instance has already been stored in the database.
abstract void	setActive(java.lang.Boolean active)	Method setting the active flag.
abstract void	setId(java.lang.Long id)	Method setting the canonical id of the object.
abstract void	setInactive()	Method to delete an object logically.
abstract void	setToActive()	Method to undelete an object logically.
void	setToTransient()
abstract void	setVersion(java.lang.Integer version)	Method setting the version of the instance, Should under normal circumstances not be manually invoked.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ToDoVersionedIdentifiable

public ToDoVersionedIdentifiable()

Method Detail

getId

public abstract java.lang.Long getId()

Method returning a canonical id of the object. Transient objects return -1;

Returns:

id the id of the object. Id is canonical for all instances of a class.

setId

public abstract void setId(java.lang.Long id)

Method setting the canonical id of the object. Should under normal circumstances not be manually invoked.

Parameters:

id - id of the object

getVersion

public abstract java.lang.Integer getVersion()

Method returning the version of the instance

Returns:

the version

setVersion

public abstract void setVersion(java.lang.Integer version)

Method setting the version of the instance, Should under normal circumstances not be manually invoked.

Parameters:

version - of the object

isTransient

public boolean isTransient()

Method that returns whether the instance has already been stored in the database.

Returns:

boolean whether the object is transient

setToTransient

public void setToTransient()

isActive

public abstract java.lang.Boolean isActive()

Method that returns whether the instance is active or not (means: logically deleted)

Returns:

boolean whether the object is active

setActive

public abstract void setActive(java.lang.Boolean active)

Method setting the active flag. Invoking this method with false logically deletes the instance in the database.

Parameters:

active - is the object active or not

setToActive

public abstract void setToActive()

Method to undelete an object logically.

setInactive

public abstract void setInactive()

Method to delete an object logically.

getCanonicalId

public java.lang.String getCanonicalId()

Method returning a system wide canonical id consisting of the canonical class name of the object and the id.

Returns:

system wide canonical id

anonymize

public abstract void anonymize()

getAnonymizeString

public java.lang.String getAnonymizeString()

getActiveAsIcon

public Image getActiveAsIcon()