de.innovationgate.wgpublisher.problems

Class SimpleProblemOccasion

java.lang.Object

de.innovationgate.wgpublisher.problems.SimpleProblemOccasion

All Implemented Interfaces:

ProblemKeyQualificator, ProblemOccasion, ProblemQueueEvent

public class SimpleProblemOccasion
extends java.lang.Object
implements ProblemOccasion, ProblemKeyQualificator

A simple problem occasion that uses a string key to identify itself and qualify label keys. Labels will be loaded with keys qualified by this occasion key, like: occasionkey.title, occasionkey.problemkey.message The occasion is unique based on its problem scope and its occasion key. Clearing SimpleProblemOccasion therefor will clear all problems for this scope/occasion key combination. Note: Unlike on custom occasions problems on SimpleProblemOccasions are obliged to always use the problem scope and type they were created with, as these are used to identify the scope.

Constructor Summary

Constructors

Constructor and Description
SimpleProblemOccasion(java.lang.String occKey, java.lang.Class<? extends ProblemType> type, ProblemScope scope, java.lang.Class<?> refClass, boolean clearedAutomatically) Creates an occasion with all parameters.

Method Summary

Methods

Modifier and Type	Method and Description
static SimpleProblemOccasion	createAdministrativeOccasion(java.lang.String occKey, ProblemScope scope, java.lang.Class<?> refClass, boolean clearedAutomatically) Creates an administrative occasion.
static SimpleProblemOccasion	createGlobalAdministrativeOccasion(java.lang.String occKey, java.lang.Class<?> refClass, boolean clearedAutomatically) Creates an administrative occasion with global scope.
boolean	equals(java.lang.Object obj)
java.lang.String	getBaseKey()
java.lang.Class<?>	getDefaultRefClass() Returns a reference class for this occasion, normally the class whose operations may register problems of this occasion.
ProblemScope	getDefaultScope() Returns the default problem scope used by problems of this occasion
java.lang.Class<? extends ProblemType>	getDefaultType() Returns the default problem type used by problems of this occasion
int	hashCode()
boolean	isClearedAutomatically() Identifies if problems of this occasion are automatically cleared once the problem is solved.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleProblemOccasion

public SimpleProblemOccasion(java.lang.String occKey,
                     java.lang.Class<? extends ProblemType> type,
                     ProblemScope scope,
                     java.lang.Class<?> refClass,
                     boolean clearedAutomatically)

Creates an occasion with all parameters. Also take note of the static methods that treat frequent use cases withg lesser parameters

Parameters:

occKey - The key, uniquely identifying this occasion

type - The problem type created by this occasion

scope - The problem scope for problems created by this occasion.

refClass - The reference class. Usually the class containing the code that produces problems on this occasion. Its "*_problems.properties" file will be used to load problem labels (* being the class local name).

clearedAutomatically - Indicates if problems registered under this occasions will get cleared automatically. If false they have to be dismissed manually.

Throws:

de.innovationgate.webgate.api.WGException

Method Detail

createGlobalAdministrativeOccasion

public static SimpleProblemOccasion createGlobalAdministrativeOccasion(java.lang.String occKey,
                                                       java.lang.Class<?> refClass,
                                                       boolean clearedAutomatically)

Creates an administrative occasion with global scope.

Parameters:

occKey - The key, uniquely identifying this occasion

refClass - The reference class. Usually the class containing the code that produces problems on this occasion. Its "*_problems.properties" file will be used to load problem labels (* being the class local name).

clearedAutomatically - Indicates if problems registered under this occasions will get cleared automatically. If false they have to be dismissed manually.

Returns:

Throws:

de.innovationgate.webgate.api.WGException

createAdministrativeOccasion

public static SimpleProblemOccasion createAdministrativeOccasion(java.lang.String occKey,
                                                 ProblemScope scope,
                                                 java.lang.Class<?> refClass,
                                                 boolean clearedAutomatically)

Creates an administrative occasion.

Parameters:

occKey - The key, uniquely identifying this occasion

refClass - The reference class. Usually the class containing the code that produces problems on this occasion. Its "*_problems.properties" file will be used to load problem labels (* being the class local name).

clearedAutomatically - Indicates if problems registered under this occasions will get cleared automatically. If false they have to be dismissed manually.

Returns:

Throws:

de.innovationgate.webgate.api.WGException

getDefaultScope

public ProblemScope getDefaultScope()

Description copied from interface: ProblemOccasion

Returns the default problem scope used by problems of this occasion

Specified by:

getDefaultScope in interface ProblemOccasion

getDefaultType

public java.lang.Class<? extends ProblemType> getDefaultType()

Description copied from interface: ProblemOccasion

Returns the default problem type used by problems of this occasion

Specified by:

getDefaultType in interface ProblemOccasion

getDefaultRefClass

public java.lang.Class<?> getDefaultRefClass()

Description copied from interface: ProblemOccasion

Returns a reference class for this occasion, normally the class whose operations may register problems of this occasion. The problem message texts will be loaded from a file "classname_problems.properties" in the package folder of this class.

Specified by:

getDefaultRefClass in interface ProblemOccasion

isClearedAutomatically

public boolean isClearedAutomatically()

Description copied from interface: ProblemOccasion

Identifies if problems of this occasion are automatically cleared once the problem is solved. Otherwise problems will be "dismissable" by the administrator.

Specified by:

isClearedAutomatically in interface ProblemOccasion

getBaseKey

public java.lang.String getBaseKey()

Specified by:

getBaseKey in interface ProblemKeyQualificator

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object