\hypertarget{interfaceorg_1_1libelektra_1_1Plugin}{}\doxysection{org.\+libelektra.\+Plugin Interface Reference}
\label{interfaceorg_1_1libelektra_1_1Plugin}\index{org.libelektra.Plugin@{org.libelektra.Plugin}}


Java representation of an \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} plugin.  




Inheritance diagram for org.\+libelektra.\+Plugin\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=227pt]{interfaceorg_1_1libelektra_1_1Plugin__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}{get\+Config}} ()
\item 
String \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a51be1d6efdd3542c2ae503031bd16e04}{get\+Name}} ()
\item 
int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a81622b7078d0442d8121831788252a61}{open}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} config, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} error\+Key)
\begin{DoxyCompactList}\small\item\em Calls the plugin\textquotesingle{}s open function. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a0c7f060e15eee5529b15f2500f0d1eda}{get}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} parent\+Key)  throws KDBException
\begin{DoxyCompactList}\small\item\em Calls the plugin\textquotesingle{}s get function. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a3bfd38d875f3e50a05aaaf9a6f547bb4}{set}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} parent\+Key)  throws KDBException
\begin{DoxyCompactList}\small\item\em Calls the set function of the plugin. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a34b1b6d0a56b9aaf238a86291b823273}{error}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} key\+Set, \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} parent\+Key)
\begin{DoxyCompactList}\small\item\em Calls the error function of the plugin. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_aa5d4abf6ffd0d477d6972b13bed05d41}{close}} (\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} parent\+Key)
\begin{DoxyCompactList}\small\item\em Calls the close function of the plugin. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_af8feab87d512d92228facfab0f90ccd8}\label{interfaceorg_1_1libelektra_1_1Plugin_af8feab87d512d92228facfab0f90ccd8}} 
static final int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_af8feab87d512d92228facfab0f90ccd8}{STATUS\+\_\+\+ERROR}} = -\/1
\begin{DoxyCompactList}\small\item\em Return value for plugin methods\+: An error occurred inside the plugin function. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a89783ba1d7c720421b7e60c09d592663}\label{interfaceorg_1_1libelektra_1_1Plugin_a89783ba1d7c720421b7e60c09d592663}} 
static final int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a89783ba1d7c720421b7e60c09d592663}{STATUS\+\_\+\+SUCCESS}} = 1
\begin{DoxyCompactList}\small\item\em Return value for plugin methods\+: Everything went fine. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a647c78af4952987b4dfad732be154c0d}\label{interfaceorg_1_1libelektra_1_1Plugin_a647c78af4952987b4dfad732be154c0d}} 
static final int \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a647c78af4952987b4dfad732be154c0d}{STATUS\+\_\+\+NO\+\_\+\+UPDATE}} = 0
\begin{DoxyCompactList}\small\item\em Return value for plugin methods\+: Everything went fine and the function {\bfseries{did not}} update the given key set / configuration. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Java representation of an \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} plugin. 

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_aa5d4abf6ffd0d477d6972b13bed05d41}\label{interfaceorg_1_1libelektra_1_1Plugin_aa5d4abf6ffd0d477d6972b13bed05d41}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!close@{close}}
\index{close@{close}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+close (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{parent\+Key }\end{DoxyParamCaption})}



Calls the close function of the plugin. 


\begin{DoxyParams}{Parameters}
{\em parent\+Key} & a key \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the plugin\textquotesingle{}s return value for close 
\end{DoxyReturn}


Implemented in \mbox{\hyperlink{classorg_1_1libelektra_1_1NativePlugin_a07ee3cd0b93d19b7bef85041d7c4f352}{org.\+libelektra.\+Native\+Plugin}}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a34b1b6d0a56b9aaf238a86291b823273}\label{interfaceorg_1_1libelektra_1_1Plugin_a34b1b6d0a56b9aaf238a86291b823273}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!error@{error}}
\index{error@{error}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{error()}{error()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+error (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{key\+Set,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{parent\+Key }\end{DoxyParamCaption})}



Calls the error function of the plugin. 


\begin{DoxyParams}{Parameters}
{\em key\+Set} & a keyset \\
\hline
{\em parent\+Key} & a key \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the plugin\textquotesingle{}s return value for error 
\end{DoxyReturn}
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a0c7f060e15eee5529b15f2500f0d1eda}\label{interfaceorg_1_1libelektra_1_1Plugin_a0c7f060e15eee5529b15f2500f0d1eda}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!get@{get}}
\index{get@{get}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{get()}{get()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+get (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{key\+Set,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{parent\+Key }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classorg_1_1libelektra_1_1KDBException}{KDBException}}}



Calls the plugin\textquotesingle{}s get function. 


\begin{DoxyParams}{Parameters}
{\em key\+Set} & \mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}} set to store the retrieved keys in \\
\hline
{\em parent\+Key} & Parent key for retrieval \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em \mbox{\hyperlink{classorg_1_1libelektra_1_1KDBException}{KDBException}}} & if \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} could not set the key set \\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
the plugin\textquotesingle{}s return value for get 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a89783ba1d7c720421b7e60c09d592663}{STATUS\+\_\+\+SUCCESS}} 

\mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_af8feab87d512d92228facfab0f90ccd8}{STATUS\+\_\+\+ERROR}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}\label{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!getConfig@{getConfig}}
\index{getConfig@{getConfig}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{getConfig()}{getConfig()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} org.\+libelektra.\+Plugin.\+get\+Config (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}} containing the plugin configuration 
\end{DoxyReturn}


Implemented in \mbox{\hyperlink{classorg_1_1libelektra_1_1NativePlugin_a6d050d1527b902baae8e5c7b4f4061ec}{org.\+libelektra.\+Native\+Plugin}}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a51be1d6efdd3542c2ae503031bd16e04}\label{interfaceorg_1_1libelektra_1_1Plugin_a51be1d6efdd3542c2ae503031bd16e04}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!getName@{getName}}
\index{getName@{getName}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
{\footnotesize\ttfamily String org.\+libelektra.\+Plugin.\+get\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

\begin{DoxyReturn}{Returns}
Name of the plugin 
\end{DoxyReturn}
\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a81622b7078d0442d8121831788252a61}\label{interfaceorg_1_1libelektra_1_1Plugin_a81622b7078d0442d8121831788252a61}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!open@{open}}
\index{open@{open}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{open()}{open()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+open (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{config,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{error\+Key }\end{DoxyParamCaption})}



Calls the plugin\textquotesingle{}s open function. 


\begin{DoxyParams}{Parameters}
{\em config} & \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin}{Plugin}} configuration key set \\
\hline
{\em error\+Key} & Used to store warnings and error information \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin}{Plugin}}\textquotesingle{}s return value for open 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a89783ba1d7c720421b7e60c09d592663}{STATUS\+\_\+\+SUCCESS}} 

\mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Plugin_af8feab87d512d92228facfab0f90ccd8}{STATUS\+\_\+\+ERROR}} 
\end{DoxySeeAlso}


Implemented in \mbox{\hyperlink{classorg_1_1libelektra_1_1NativePlugin_a73373e3f05a130927bdc13174d809af7}{org.\+libelektra.\+Native\+Plugin}}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a3bfd38d875f3e50a05aaaf9a6f547bb4}\label{interfaceorg_1_1libelektra_1_1Plugin_a3bfd38d875f3e50a05aaaf9a6f547bb4}} 
\index{org.libelektra.Plugin@{org.libelektra.Plugin}!set@{set}}
\index{set@{set}!org.libelektra.Plugin@{org.libelektra.Plugin}}
\doxysubsubsection{\texorpdfstring{set()}{set()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+set (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}}]{key\+Set,  }\item[{\mbox{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}}]{parent\+Key }\end{DoxyParamCaption}) throws \mbox{\hyperlink{classorg_1_1libelektra_1_1KDBException}{KDBException}}}



Calls the set function of the plugin. 


\begin{DoxyParams}{Parameters}
{\em key\+Set} & a keyset \\
\hline
{\em parent\+Key} & a key \\
\hline
\end{DoxyParams}

\begin{DoxyExceptions}{Exceptions}
{\em \mbox{\hyperlink{classorg_1_1libelektra_1_1KDBException}{KDBException}}} & when \mbox{\hyperlink{interfaceorg_1_1libelektra_1_1Elektra}{Elektra}} could not set the keyset \\
\hline
\end{DoxyExceptions}
\begin{DoxyReturn}{Returns}
the plugin\textquotesingle{}s return value for set 
\end{DoxyReturn}


Implemented in \mbox{\hyperlink{classorg_1_1libelektra_1_1NativePlugin_a8c6a7d55ecfa67a1213ed2c67d98c733}{org.\+libelektra.\+Native\+Plugin}}.



The documentation for this interface was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
Plugin.\+java\end{DoxyCompactItemize}
