org.olat.course.editor
Class StatusDescription

java.lang.Object
  org.olat.course.editor.StatusDescription

All Implemented Interfaces:

ValidationStatus

public class StatusDescription
extends java.lang.Object
implements ValidationStatus

Initial Date: Jun 20, 2005

Author:

patrick

Field Summary

static StatusDescription

NOERROR

Fields inherited from interface org.olat.core.util.ValidationStatus

ERROR, INFO, WARNING

Constructor Summary

StatusDescription(java.util.logging.Level severity, java.lang.String shortDescKey, java.lang.String longDescKey, java.lang.String[] descParams, java.lang.String translatorPackage)

Method Summary

ValidationAction	getAction()
java.lang.String	getActivateableViewIdentifier() It is not always needed to create a complete helper wizard but sufficient to just activate an exisiting component.
java.lang.String	getDescriptionForUnit()
java.lang.String[]	getDescriptionParams()
Controller	getHelperWizard(UserRequest ureq, WindowControl wControl) TODO: future use to enable a button/link starting a issue helper to resolve problems, or the like.
java.util.logging.Level	getLevel() the status level corresponds to the definitions in the java util logging spec.
java.lang.String	getLongDescription(java.util.Locale locale) localized long description of the status containing details, references etc.
java.lang.String	getLongDescriptionKey()
java.lang.String	getShortDescription(java.util.Locale locale) localized short description of the status providing a summary (line).
java.lang.String	getShortDescriptionKey()
boolean	isError()
boolean	isInfo()
boolean	isWarning()
void	setActivateableViewIdentifier(java.lang.String viewIdent)
void	setDescriptionForUnit(java.lang.String name) set the unit identifier for which the status description is.
StatusDescription	transformTo(java.lang.String longDescKey, java.lang.String shortDescKey, java.lang.String[] paramsNew) status description may change their meaning.

Methods inherited from class java.lang.Object

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

Field Detail

NOERROR

public static final StatusDescription NOERROR

Constructor Detail

StatusDescription

public StatusDescription(java.util.logging.Level severity,
                         java.lang.String shortDescKey,
                         java.lang.String longDescKey,
                         java.lang.String[] descParams,
                         java.lang.String translatorPackage)

Method Detail

isError

public boolean isError()

Specified by:

isError in interface ValidationStatus

Returns:

getLevel() == ERROR

isWarning

public boolean isWarning()

Specified by:

isWarning in interface ValidationStatus

Returns:

getLevel() == WARNING

isInfo

public boolean isInfo()

Specified by:

isInfo in interface ValidationStatus

Returns:

getLevel() == INFO

getLevel

public java.util.logging.Level getLevel()

the status level corresponds to the definitions in the java util logging spec.

Specified by:

getLevel in interface ValidationStatus

Returns:

See Also:

Level

getShortDescription

public java.lang.String getShortDescription(java.util.Locale locale)

localized short description of the status providing a summary (line).

Parameters:

locale -

Returns:

getShortDescriptionKey

public java.lang.String getShortDescriptionKey()

getLongDescription

public java.lang.String getLongDescription(java.util.Locale locale)

localized long description of the status containing details, references etc.

Parameters:

locale -

Returns:

getLongDescriptionKey

public java.lang.String getLongDescriptionKey()

setDescriptionForUnit

public void setDescriptionForUnit(java.lang.String name)

set the unit identifier for which the status description is. I.e. a course node id

Parameters:

name -

getDescriptionForUnit

public java.lang.String getDescriptionForUnit()

Returns:

the unit identifier for which the status description is.

getHelperWizard

public Controller getHelperWizard(UserRequest ureq,
                                  WindowControl wControl)

TODO: future use to enable a button/link starting a issue helper to resolve problems, or the like.

Parameters:

ureq -

wControl -

Returns:

getActivateableViewIdentifier

public java.lang.String getActivateableViewIdentifier()

It is not always needed to create a complete helper wizard but sufficient to just activate an exisiting component. I.e. a tab in in tabbed pane as it is the case in the course editor.

Returns:

view identifier for calling activate of an activateable

setActivateableViewIdentifier

public void setActivateableViewIdentifier(java.lang.String viewIdent)

getDescriptionParams

public java.lang.String[] getDescriptionParams()

transformTo

public StatusDescription transformTo(java.lang.String longDescKey,
                                     java.lang.String shortDescKey,
                                     java.lang.String[] paramsNew)

status description may change their meaning. I.e. the same error/warning in the course editor means something different during publish.

Parameters:

longDescKey -

shortDescKey -

paramsNew -

Returns:

getAction

public ValidationAction getAction()

Specified by:

getAction in interface ValidationStatus