Class RemoveConletType
java.lang.Object
org.jgrapes.core.internal.EventBase<T>
org.jgrapes.core.Event<Void>
org.jgrapes.webconsole.base.events.ConsoleCommand
org.jgrapes.webconsole.base.events.RemoveConletType
- All Implemented Interfaces:
Future<Void>
,Associator
,Eligible
Removes a web console component type from the console page.
Implementations of the front-end are not expected to remove
resources from the page that were added by AddConletType
because this is hardly possible to implement.
The only expected action of the front-end is to prevent further
usage of the conlet, typically by removing the conlet type from
e.g. a menu that allows adding conlets. The front-end is also
not expected to remove existing instances of the conlet. If
such a behavior is desired, the required DeleteConlet
events must be generated on the server side.
-
Field Summary
Fields inherited from class org.jgrapes.core.internal.EventBase
completed, completionEvents
-
Constructor Summary
ConstructorDescriptionRemoveConletType
(String conletType) Create a new event for the given web console component type. -
Method Summary
Modifier and TypeMethodDescriptionReturn the web console component type.void
Writes the event as JSON notification to the given writer.Methods inherited from class org.jgrapes.webconsole.base.events.ConsoleCommand
toJson
Methods inherited from class org.jgrapes.core.Event
addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString
Methods inherited from class org.jgrapes.core.internal.EventBase
disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jgrapes.core.Associator
associated, associated, associated, associatedGet
-
Constructor Details
-
RemoveConletType
Create a new event for the given web console component type.- Parameters:
conletType
- a unique id for the web console component type (usually the class name)
-
-
Method Details
-
conletType
Return the web console component type.- Returns:
- the web console component type
-
toJson
Description copied from class:ConsoleCommand
Writes the event as JSON notification to the given writer.Derived classes usually simply call
ConsoleCommand.toJson(Writer, String, Object...)
with the method name and parameters.- Specified by:
toJson
in classConsoleCommand
- Parameters:
writer
- the writer- Throws:
IOException
-