Package com.storedobject.core

Class UserActionLog

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.UserActionLog

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class UserActionLog
extends StoredObject

Represents a log of actions performed by users on specific objects.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
UserActionLog()	Constructor.

Method Summary

Modifier and Type	Method	Description
static void	columns(Columns columns)	Configures the column definitions for the associated entity by adding mappings of property names to their database column types.
Timestamp	getActedAt()	Retrieves the timestamp indicating when the action was performed.
StoredObject	getObject()	Retrieves the associated StoredObject instance related to the objectId field.
Id	getObjectId()	Retrieves the identifier of the referenced object associated with this instance.
UserAction	getUserAction()	Retrieves the UserAction associated with this UserActionLog.
Id	getUserActionId()	Retrieves the unique identifier associated with the user's action.
static void	indices(Indices indices)	Adds index configurations to the specified Indices by including the columns "Object" and "UserAction" in the index.
static void	save(StoredObject object, String action)	Saves the provided stored object with the specified action.
void	setActedAt(Timestamp actedAt)	Updates the timestamp for when an action was performed.
void	setObject(Id objectId)	Updates the object identifier while ensuring certain conditions are met.
void	setObject(StoredObject object)	Sets the object associated with this log entry.
void	setObject(BigDecimal idValue)	Sets the object ID by wrapping the provided BigDecimal value into an Id instance.
void	setUserAction(Id userActionId)	Sets the user action identifier for the current instance.
void	setUserAction(UserAction userAction)	Sets the user action for the current object by extracting the ID from the provided UserAction instance.
void	setUserAction(BigDecimal idValue)	Sets the user action by creating and assigning an instance of Id based on the provided id value.
void	validateData(TransactionManager tm)	Validates the data of the current object and its properties.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserActionLog

public UserActionLog()

Constructor.

Method Details

columns

public static void columns(Columns columns)

Configures the column definitions for the associated entity by adding mappings of property names to their database column types.

Parameters:

columns - the Columns object to which the column definitions are to be added

indices

public static void indices(Indices indices)

Adds index configurations to the specified Indices by including the columns "Object" and "UserAction" in the index.

Parameters:

indices - An instance of Indices to which index configurations will be added.

setObject

public void setObject(Id objectId)

Updates the object identifier while ensuring certain conditions are met.

Parameters:

objectId - The new identifier to set for the object. Must be a valid Id and meet the restrictions imposed by the method. If the object is currently loading or the new identifier is the same as the existing one, the operation will proceed. Otherwise, an exception is thrown.

Throws:

Set_Not_Allowed - If the object is not in a valid state to allow the update.

setObject

public void setObject(BigDecimal idValue)

Sets the object ID by wrapping the provided BigDecimal value into an Id instance.

Parameters:

idValue - The BigDecimal value representing the object ID to be set.

setObject

public void setObject(StoredObject object)

Sets the object associated with this log entry. If the provided object is null, the associated object ID is set to null. Otherwise, the object ID is set to the ID of the provided object.

Parameters:

object - The StoredObject to associate with this log entry, or null to disassociate any previously associated object.

getObjectId

@SetNotAllowed
@Column(style="(any)",
        order=100)
public Id getObjectId()

Retrieves the identifier of the referenced object associated with this instance.

Returns:

the identifier of the referenced object as an Id.

getObject

public StoredObject getObject()

Retrieves the associated StoredObject instance related to the objectId field.

Returns:

The StoredObject instance corresponding to the objectId, or null if no such association exists.

setUserAction

public void setUserAction(Id userActionId)

Sets the user action identifier for the current instance. This method updates the user action ID only if the instance is not in a loading state and the given user action ID differs from the current one. If the conditions are not met, an exception is thrown to indicate the operation is not allowed.

Parameters:

userActionId - the identifier of the user action to be set

Throws:

Set_Not_Allowed - if the user action ID cannot be updated due to invalid conditions

setUserAction

public void setUserAction(BigDecimal idValue)

Sets the user action by creating and assigning an instance of Id based on the provided id value.

Parameters:

idValue - the unique identifier value used to represent a user action, as a BigDecimal

setUserAction

public void setUserAction(UserAction userAction)

Sets the user action for the current object by extracting the ID from the provided UserAction instance.

Parameters:

userAction - An instance of UserAction. If null, the user action will be set to null. If not null, the ID of the provided UserAction will be used.

getUserActionId

@SetNotAllowed
@Column(order=200)
public Id getUserActionId()

Retrieves the unique identifier associated with the user's action.

Returns:

the ID representing the user's action as an instance of Id.

getUserAction

public UserAction getUserAction()

Retrieves the UserAction associated with this UserActionLog.

Returns:

the UserAction object linked to this UserActionLog, based on the userActionId.

setActedAt

public void setActedAt(Timestamp actedAt)

Updates the timestamp for when an action was performed.

Parameters:

actedAt - the Timestamp object representing the new "acted at" time. Cannot be set if the provided timestamp matches the existing one, unless the object is in a loading state.

Throws:

Set_Not_Allowed - if the new timestamp is identical to the current timestamp and the object is not in a loading state.

getActedAt

@SetNotAllowed
@Column(order=300,
        readOnly=true)
public Timestamp getActedAt()

Retrieves the timestamp indicating when the action was performed.

Returns:

a Timestamp object representing the date and time the action occurred.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Validates the data of the current object and its properties.

Overrides:

validateData in class StoredObject

Parameters:

tm - the transaction manager used to validate and check the data.

Throws:

Exception - if validation fails due to invalid or missing values.

save

public static void save(StoredObject object,
 String action)
                 throws Exception

Saves the provided stored object with the specified action.

Parameters:

object - the stored object to be saved, which contains the data that needs to be persisted

action - the action describing the type of save operation to be performed

Throws:

Exception - if an error occurs during the save operation