org.olat.core.logging.activity
Enum StringResourceableType

java.lang.Object
  java.lang.Enum<StringResourceableType>
      org.olat.core.logging.activity.StringResourceableType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StringResourceableType>, ILoggingResourceableType

public enum StringResourceableType
extends java.lang.Enum<StringResourceableType>
implements ILoggingResourceableType

Specialization of ILoggingResourceableType which represents a String rather than an OlatResourceable.

Note that the string can be something like an URL, an Identity or a group right - but it can also correspond to an OlatResourceable in cases like scormResource, assessmentID. In the latter case we do not have an OlatResourceable at the time where the LoggingResourceable is added to the IUserActivityLogger - otherwise it would be preferable to add an OlatResourceable always.

See the LoggingResourceable class's corresponding wrap() method.

Initial Date: 21.10.2009

Author:

Stefan

See Also:

LoggingResourceable#wrap

Enum Constant Summary

assessmentID
the assessment ID - we seem to not have an Olatresourceable there

bcFile
the briefcase filename

bgArea
the businessgroup area name

bgRight
the businessgroup right (key)

cpNode
the content package node name (filename)

csHelp
Context sensitive help

feedItem
Blog Post and Podcast Episodes

glossarySoftKey
the softkey of the glossary - we seem to not have an OlatResourceable at the time

nodeId
corresponds to the CourseNode ID - but we seem to not have an OlatResourceable at the time

qtiAttempts
the number of attemts - in QTI

qtiCoachComment
the coach comment - in QTI

qtiComment
the comment - in QTI

qtiParams
the param part of the URI during a QTI test - equivalent to what was passed to IQDisplayController.logAudit before

qtiPassed
the passed value - in QTI

qtiScore
the score - in QTI

qtiUserComment
the user comment - in QTI

scormResource
the scorm resource ID - we seem to not have an OlatResourceable at the time

spUri
the single page URI

statisticColumn
the title of the column of which the total is viewed

statisticManager
the name of the statisticmanager viewed

statisticType
the type of statistic viewed

targetIdentity
the target identity

uploadFile
the uploaded filename

Method Summary

static StringResourceableType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StringResourceableType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.core.logging.activity.ILoggingResourceableType

name

Enum Constant Detail

nodeId

public static final StringResourceableType nodeId

corresponds to the CourseNode ID - but we seem to not have an OlatResourceable at the time

spUri

public static final StringResourceableType spUri

the single page URI

bgArea

public static final StringResourceableType bgArea

the businessgroup area name

bgRight

public static final StringResourceableType bgRight

the businessgroup right (key)

cpNode

public static final StringResourceableType cpNode

the content package node name (filename)

bcFile

public static final StringResourceableType bcFile

the briefcase filename

uploadFile

public static final StringResourceableType uploadFile

the uploaded filename

targetIdentity

public static final StringResourceableType targetIdentity

the target identity

glossarySoftKey

public static final StringResourceableType glossarySoftKey

the softkey of the glossary - we seem to not have an OlatResourceable at the time

scormResource

public static final StringResourceableType scormResource

the scorm resource ID - we seem to not have an OlatResourceable at the time

qtiAttempts

public static final StringResourceableType qtiAttempts

the number of attemts - in QTI

qtiScore

public static final StringResourceableType qtiScore

the score - in QTI

qtiPassed

public static final StringResourceableType qtiPassed

the passed value - in QTI

assessmentID

public static final StringResourceableType assessmentID

the assessment ID - we seem to not have an Olatresourceable there

qtiComment

public static final StringResourceableType qtiComment

the comment - in QTI

qtiUserComment

public static final StringResourceableType qtiUserComment

the user comment - in QTI

qtiCoachComment

public static final StringResourceableType qtiCoachComment

the coach comment - in QTI

qtiParams

public static final StringResourceableType qtiParams

the param part of the URI during a QTI test - equivalent to what was passed to IQDisplayController.logAudit before

csHelp

public static final StringResourceableType csHelp

Context sensitive help

feedItem

public static final StringResourceableType feedItem

Blog Post and Podcast Episodes

statisticManager

public static final StringResourceableType statisticManager

the name of the statisticmanager viewed

statisticType

public static final StringResourceableType statisticType

the type of statistic viewed

statisticColumn

public static final StringResourceableType statisticColumn

the title of the column of which the total is viewed

Method Detail

values

public static StringResourceableType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StringResourceableType c : StringResourceableType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StringResourceableType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null