public class SimpleProblemOccasion extends java.lang.Object implements ProblemOccasion, ProblemKeyQualificator
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.
|
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.
|
public SimpleProblemOccasion(java.lang.String occKey, java.lang.Class<? extends ProblemType> type, ProblemScope scope, java.lang.Class<?> refClass, boolean clearedAutomatically)
occKey
- The key, uniquely identifying this occasiontype
- The problem type created by this occasionscope
- 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.de.innovationgate.webgate.api.WGException
public static SimpleProblemOccasion createGlobalAdministrativeOccasion(java.lang.String occKey, java.lang.Class<?> refClass, boolean clearedAutomatically)
occKey
- The key, uniquely identifying this occasionrefClass
- 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.de.innovationgate.webgate.api.WGException
public static SimpleProblemOccasion createAdministrativeOccasion(java.lang.String occKey, ProblemScope scope, java.lang.Class<?> refClass, boolean clearedAutomatically)
occKey
- The key, uniquely identifying this occasionrefClass
- 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.de.innovationgate.webgate.api.WGException
public ProblemScope getDefaultScope()
ProblemOccasion
getDefaultScope
in interface ProblemOccasion
public java.lang.Class<? extends ProblemType> getDefaultType()
ProblemOccasion
getDefaultType
in interface ProblemOccasion
public java.lang.Class<?> getDefaultRefClass()
ProblemOccasion
getDefaultRefClass
in interface ProblemOccasion
public boolean isClearedAutomatically()
ProblemOccasion
isClearedAutomatically
in interface ProblemOccasion
public java.lang.String getBaseKey()
getBaseKey
in interface ProblemKeyQualificator
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object