org.olat.core.logging.activity
Class BaseLoggingAction

java.lang.Object
  org.olat.core.logging.activity.BaseLoggingAction

All Implemented Interfaces:

ILoggingAction

Direct Known Subclasses:

CourseLoggingAction, FolderLoggingAction, GroupLoggingAction, LearningResourceLoggingAction, OlatLoggingAction, StatisticLoggingAction

public class BaseLoggingAction
extends java.lang.Object
implements ILoggingAction

Base implementation for ILoggingAction - the recommended super class for all implementations for ILoggingAction (but not mandatory)

Things this class implements:

• Contains the actual properties with setters and getters
• Contains a constructor which needs to be given the mandatory properties
• Note that typeList is mandatory yet is set later via a setTypeList call - this is due to the way the LoggingAction definition is done

Initial Date: 20.10.2009

Author:

Stefan

Method Summary

java.lang.String	getActionObject() Returns the actionObject of the logging action
ActionVerb	getActionVerb() Returns the actionVerb of the logging action
CrudAction	getCrudAction() Returns the crudAction (create, retrieve, update, delete) action type - directly propagates to the DB later
java.lang.String	getJavaFieldIdForDebug() Returns the optional name of the field in which this instance is held - for DEBUGging only
ActionType	getResourceActionType() Returns the resourceAdminAction property - directly propagates to the DB later
ResourceableTypeList	getTypeListDefinition() Returns the ResourceableTypeList - which is a list of ILoggingResourceableTypes defining what is expected to be stored to the DB alongside this logging action
void	setJavaFieldIdForDebug(java.lang.String javaId) Sets the optional name of the field in which this instance is held - for DEBUGging only - this field id will be issued when there are problems with this ILoggingAction's ResourceableTypeList later

Methods inherited from class java.lang.Object

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

Method Detail

getTypeListDefinition

public ResourceableTypeList getTypeListDefinition()

Description copied from interface: ILoggingAction

Returns the ResourceableTypeList - which is a list of ILoggingResourceableTypes defining what is expected to be stored to the DB alongside this logging action

Specified by:

getTypeListDefinition in interface ILoggingAction

Returns:

the ResourceableTypeList which defines what is expected to be stored alongside this logging action

getResourceActionType

public ActionType getResourceActionType()

Returns the resourceAdminAction property - directly propagates to the DB later

Specified by:

getResourceActionType in interface ILoggingAction

Returns:

the resourceAdminAction property - directly propagates to the DB later

getCrudAction

public CrudAction getCrudAction()

Returns the crudAction (create, retrieve, update, delete) action type - directly propagates to the DB later

Specified by:

getCrudAction in interface ILoggingAction

Returns:

the crudAction (create, retrieve, update, delete) action type - directly propagates to the DB later

getActionVerb

public ActionVerb getActionVerb()

Returns the actionVerb of the logging action

Specified by:

getActionVerb in interface ILoggingAction

Returns:

the actionVerb of the logging action

getActionObject

public java.lang.String getActionObject()

Returns the actionObject of the logging action

Specified by:

getActionObject in interface ILoggingAction

Returns:

the actionObject of the logging action

getJavaFieldIdForDebug

public java.lang.String getJavaFieldIdForDebug()

Returns the optional name of the field in which this instance is held - for DEBUGging only

Specified by:

getJavaFieldIdForDebug in interface ILoggingAction

Returns:

the optional name of the field in which this instance is held - for DEBUGging only

setJavaFieldIdForDebug

public void setJavaFieldIdForDebug(java.lang.String javaId)

Sets the optional name of the field in which this instance is held - for DEBUGging only - this field id will be issued when there are problems with this ILoggingAction's ResourceableTypeList later

Parameters:

javaId - the java field id - or anything else which helps in your DEBUGging case - this field id will be issued when there are problems with this ILoggingAction's ResourceableTypeList later