org.olat.core.logging.activity
Interface ILoggingResourceable

All Known Implementing Classes:
CoreLoggingResourceable, LoggingResourceable

public interface ILoggingResourceable


Method Summary
 boolean correspondsTo(ContextEntry ce)
          Checks whether this LoggingResourceable represents the same resource as the given ContextEntry.
 java.lang.String getId()
          Returns the id of this LoggingResourceable - the id varies depending on the type of this LoggingResourceable - but usually it is the olatresourceable id or the olatresource id.
 java.lang.String getName()
          Returns the name of this LoggingResourceable - the name varies depending on the type of this LoggingResource - e.g.
 ILoggingResourceableType getResourceableType()
          Returns the ILoggingResourceableType of this LoggingResourceable - used for businessPath checking
 java.lang.String getType()
          Returns the type of this LoggingResourceable - this is the OlatResourceable's type (in case this LoggingResource represents a OlatResourceable) - or the StringResourceableType's enum name() otherwise
 

Method Detail

correspondsTo

boolean correspondsTo(ContextEntry ce)
Checks whether this LoggingResourceable represents the same resource as the given ContextEntry.

This is used during the businessPath check.

Parameters:
ce -
Returns:

getType

java.lang.String getType()
Returns the type of this LoggingResourceable - this is the OlatResourceable's type (in case this LoggingResource represents a OlatResourceable) - or the StringResourceableType's enum name() otherwise

Returns:
the type of this LoggingResourceable

getId

java.lang.String getId()
Returns the id of this LoggingResourceable - the id varies depending on the type of this LoggingResourceable - but usually it is the olatresourceable id or the olatresource id.

Returns:
the id of this LoggingResourceable

getName

java.lang.String getName()
Returns the name of this LoggingResourceable - the name varies depending on the type of this LoggingResource - e.g. in the course case it is the name of the course, in the CP case it is the html filename incl path

Returns:

getResourceableType

ILoggingResourceableType getResourceableType()
Returns the ILoggingResourceableType of this LoggingResourceable - used for businessPath checking

Returns:
the ILoggingResourceableType of this LoggingResourceable