org.codice.ddf.resourcemanagement.query.commands

Class RemoveSearchAfterCompleteCommand

java.lang.Object

org.codice.ddf.resourcemanagement.query.commands.RemoveSearchAfterCompleteCommand

All Implemented Interfaces:

org.apache.karaf.shell.api.action.Action

public class RemoveSearchAfterCompleteCommand
extends Object
implements org.apache.karaf.shell.api.action.Action

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoveSearchAfterCompleteCommand.TrueAndFalseCompleter

Constructor Summary

Constructors

Constructor and Description
RemoveSearchAfterCompleteCommand()
RemoveSearchAfterCompleteCommand(QueryMonitorPlugin q)

Method Summary

Modifier and Type	Method and Description
Object	execute() Method to implement Action.
boolean	setRemoveSearchAfterComplete(boolean b) Method to set the boolean in a QueryMonitorPlugin which determines whether ActiveSearch's should be removed from the ActiveSearch Map when the search completes.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveSearchAfterCompleteCommand

public RemoveSearchAfterCompleteCommand(QueryMonitorPlugin q)

RemoveSearchAfterCompleteCommand

public RemoveSearchAfterCompleteCommand()

Method Detail

setRemoveSearchAfterComplete

public boolean setRemoveSearchAfterComplete(boolean b)

Method to set the boolean in a QueryMonitorPlugin which determines whether ActiveSearch's should be removed from the ActiveSearch Map when the search completes. A value of true has the effect that searches will be removed while a value of false has the effect that ActiveSearch's will be left inside of the ActiveSearch Map after query completion.

Parameters:

b - Boolean a value of true has the effect that searches will be removed while a value of false has the effect that ActiveSearch's will be left inside of the ActiveSearch Map after query completion.

Returns:

Boolean representing whether or not setting the variable was successful

execute

public Object execute()
               throws Exception

Method to implement Action. Called when the catalog:removesearchaftercomplete command is called by the shell. Sets the value of the boolean which determines whether or not ActiveSearch's are removed from the ActiveSearch Map after search completion.

Specified by:

execute in interface org.apache.karaf.shell.api.action.Action

Returns:

always returns null

Throws:

Exception