com.openexchange.admin.console.context.extensioninterfaces
Interface ContextConsoleListInterface

All Superinterfaces:
ContextConsoleCommonInterface

public interface ContextConsoleListInterface
extends ContextConsoleCommonInterface

This interface must be implemented by a class in the console package of a plugin so that it can extend the basic command line options. To offer your own implementation of this interface to the core. The ServiceLoader mechanism of JDK 6 is used which requests a directory META-INF/services under which a text file whose name is the full-qualified binary name of this interface (com.openexchange.admin.console.context.ContextConsoleListInterface). And the content of this file must be the full-qualified binary name of your implementation.

Author:
Dennis Sieben

Method Summary
 java.util.ArrayList<java.lang.String> getColumnNamesCSV()
          This method can be implemented to set the names of the columns which should extend the csv output
 java.util.ArrayList<java.lang.String> getColumnNamesHumanReadable()
          This method can be implemented to set the names of the columns which should extend the normal output
 java.util.ArrayList<java.lang.String> getCSVData(Context ctx)
          This method can be implemented to set the data in the CSV output.
 java.util.ArrayList<java.lang.String> getHumanReadableData(Context ctx)
          This method can be implemented to set the data in the normal output.
 
Methods inherited from interface com.openexchange.admin.console.context.extensioninterfaces.ContextConsoleCommonInterface
addExtensionOptions, setAndFillExtension
 

Method Detail

getColumnNamesHumanReadable

java.util.ArrayList<java.lang.String> getColumnNamesHumanReadable()
This method can be implemented to set the names of the columns which should extend the normal output

Returns:

getColumnNamesCSV

java.util.ArrayList<java.lang.String> getColumnNamesCSV()
This method can be implemented to set the names of the columns which should extend the csv output

Returns:

getHumanReadableData

java.util.ArrayList<java.lang.String> getHumanReadableData(Context ctx)
                                                           throws PluginException
This method can be implemented to set the data in the normal output. Note: If the data is empty null must be inserted in the array at that point.

Returns:
Throws:
PluginException

getCSVData

java.util.ArrayList<java.lang.String> getCSVData(Context ctx)
                                                 throws PluginException
This method can be implemented to set the data in the CSV output. Note: If the data is empty null must be inserted in the array at that point.

Returns:
Throws:
PluginException