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


This is a Java representation of a plugin.  




Inheritance diagram for org.\+libelektra.\+Plugin\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=212pt]{interfaceorg_1_1libelektra_1_1Plugin__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}{get\+Config} ()
\begin{DoxyCompactList}\small\item\em Gets the config which was used to configure the plugin. \end{DoxyCompactList}\item 
int \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a740f0602ea62e7a28c86fc801add8907}{open} (\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} conf, \hyperlink{classorg_1_1libelektra_1_1Key}{Key} error\+Key)
\begin{DoxyCompactList}\small\item\em Calls the open function of the plugin. \end{DoxyCompactList}\item 
int \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a9b8362549b7ab8ca5eff39cf6b7c8046}{get} (\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} ks, \hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)  throws K\+D\+B\+Exception
\begin{DoxyCompactList}\small\item\em Calls the get function of the plugin. \end{DoxyCompactList}\item 
int \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a650ce789086f5becf21c5f91fad4c42e}{set} (\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} ks, \hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)  throws K\+D\+B\+Exception
\begin{DoxyCompactList}\small\item\em Calls the set function of the plugin. \end{DoxyCompactList}\item 
int \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_aa91370570c862ebe9eb83094a4731b9a}{error} (\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} ks, \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 \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_aa5d4abf6ffd0d477d6972b13bed05d41}{close} (\hyperlink{classorg_1_1libelektra_1_1Key}{Key} parent\+Key)
\begin{DoxyCompactList}\small\item\em Calls the close function of the plugin. \end{DoxyCompactList}\item 
String \hyperlink{interfaceorg_1_1libelektra_1_1Plugin_a51be1d6efdd3542c2ae503031bd16e04}{get\+Name} ()
\begin{DoxyCompactList}\small\item\em Returns the plugin name. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This is a Java representation of a plugin. 

\subsection{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}}
\subsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+close (\begin{DoxyParamCaption}\item[{\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 \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_acd6f4e0e81a11a1eba64dfa164c67a1f}{org.\+libelektra.\+plugin.\+Native\+Plugin}.

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



Calls the error function of the plugin. 


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


Implemented in \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a54c2753b1d17e14be39526a6ff02e34d}{org.\+libelektra.\+plugin.\+Native\+Plugin}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a9b8362549b7ab8ca5eff39cf6b7c8046}\label{interfaceorg_1_1libelektra_1_1Plugin_a9b8362549b7ab8ca5eff39cf6b7c8046}} 
\index{org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}!get@{get}}
\index{get@{get}!org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}}
\subsubsection{\texorpdfstring{get()}{get()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+get (\begin{DoxyParamCaption}\item[{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{ks,  }\item[{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{parent\+Key }\end{DoxyParamCaption}) throws \hyperlink{classorg_1_1libelektra_1_1exception_1_1KDBException}{K\+D\+B\+Exception}}



Calls the get function of the plugin. 


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

\begin{DoxyExceptions}{Exceptions}
{\em K\+D\+B\+Exception} & when \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 get 
\end{DoxyReturn}


Implemented in \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a766870e5f26cab4d497ed7c2fbc4abd9}{org.\+libelektra.\+plugin.\+Native\+Plugin}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}\label{interfaceorg_1_1libelektra_1_1Plugin_a95ee37a782d5bd32fd95478788652d44}} 
\index{org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}!get\+Config@{get\+Config}}
\index{get\+Config@{get\+Config}!org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}}
\subsubsection{\texorpdfstring{get\+Config()}{getConfig()}}
{\footnotesize\ttfamily \hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set} org.\+libelektra.\+Plugin.\+get\+Config (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the config which was used to configure the plugin. 

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


Implemented in \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_af9c78565029ed2ae38241759549e4b5a}{org.\+libelektra.\+plugin.\+Native\+Plugin}.

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



Returns the plugin name. 

\begin{DoxyReturn}{Returns}
plugin name 
\end{DoxyReturn}


Implemented in \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a606fc8f54bc810d874176103859976ab}{org.\+libelektra.\+plugin.\+Native\+Plugin}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a740f0602ea62e7a28c86fc801add8907}\label{interfaceorg_1_1libelektra_1_1Plugin_a740f0602ea62e7a28c86fc801add8907}} 
\index{org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}!open@{open}}
\index{open@{open}!org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}}
\subsubsection{\texorpdfstring{open()}{open()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+open (\begin{DoxyParamCaption}\item[{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{conf,  }\item[{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{error\+Key }\end{DoxyParamCaption})}



Calls the open function of the plugin. 


\begin{DoxyParams}{Parameters}
{\em conf} & a configuration keyset \\
\hline
{\em error\+Key} & a key \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the plugin\textquotesingle{}s return value for open 
\end{DoxyReturn}


Implemented in \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a81510de92e0d65784e877bf53b89756a}{org.\+libelektra.\+plugin.\+Native\+Plugin}.

\mbox{\Hypertarget{interfaceorg_1_1libelektra_1_1Plugin_a650ce789086f5becf21c5f91fad4c42e}\label{interfaceorg_1_1libelektra_1_1Plugin_a650ce789086f5becf21c5f91fad4c42e}} 
\index{org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}!set@{set}}
\index{set@{set}!org\+::libelektra\+::\+Plugin@{org\+::libelektra\+::\+Plugin}}
\subsubsection{\texorpdfstring{set()}{set()}}
{\footnotesize\ttfamily int org.\+libelektra.\+Plugin.\+set (\begin{DoxyParamCaption}\item[{\hyperlink{classorg_1_1libelektra_1_1KeySet}{Key\+Set}}]{ks,  }\item[{\hyperlink{classorg_1_1libelektra_1_1Key}{Key}}]{parent\+Key }\end{DoxyParamCaption}) throws \hyperlink{classorg_1_1libelektra_1_1exception_1_1KDBException}{K\+D\+B\+Exception}}



Calls the set function of the plugin. 


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

\begin{DoxyExceptions}{Exceptions}
{\em K\+D\+B\+Exception} & when \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 \hyperlink{classorg_1_1libelektra_1_1plugin_1_1NativePlugin_a9faeb1e6eb90a4c90681eeeb097eeb53}{org.\+libelektra.\+plugin.\+Native\+Plugin}.



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