Updated documentation
This commit is contained in:
306
man/MNR.DB.Applications.Rd
Normal file
306
man/MNR.DB.Applications.Rd
Normal file
@@ -0,0 +1,306 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/db_applications.R
|
||||
\name{MNR.DB.Applications}
|
||||
\alias{MNR.DB.Applications}
|
||||
\title{MNR database queries for Applications}
|
||||
\value{
|
||||
A query details object (collect = FALSE) or a collected tibble
|
||||
of application details
|
||||
|
||||
A permissions_query object (as_permissions = TRUE,
|
||||
collect = FALSE) or query details object (as_permissions = FALSE,
|
||||
collect = FALSE) or a collected tibble of application details
|
||||
|
||||
A permissions_query object (as_permissions = TRUE,
|
||||
collect = FALSE) or query details object (as_permissions = FALSE,
|
||||
collect = FALSE) or a collected tibble of application details
|
||||
|
||||
A permissions_query object (as_permissions = TRUE,
|
||||
collect = FALSE) or query details object (as_permissions = FALSE,
|
||||
collect = FALSE) or a collected tibble of application details
|
||||
|
||||
A permissions_query object (as_permissions = TRUE,
|
||||
collect = FALSE) or query details object (as_permissions = FALSE,
|
||||
collect = FALSE) or a collected tibble of application details
|
||||
|
||||
A permissions_query object (as_permissions = TRUE,
|
||||
collect = FALSE) or query details object (as_permissions = FALSE,
|
||||
collect = FALSE) or a collected tibble of application details
|
||||
|
||||
A permissions_query object (as_permissions = TRUE,
|
||||
collect = FALSE) or query details object (as_permissions = FALSE,
|
||||
collect = FALSE) or a collected tibble of application details
|
||||
|
||||
A list containing the state flags of an application
|
||||
}
|
||||
\description{
|
||||
MNR database queries for Applications
|
||||
|
||||
MNR database queries for Applications
|
||||
}
|
||||
\section{Super class}{
|
||||
\code{\link[AVSDevR.MarineNoiseRegistry:MNR.DB]{AVSDevR.MarineNoiseRegistry::MNR.DB}} -> \code{MNR.DB.Applications}
|
||||
}
|
||||
\section{Methods}{
|
||||
\subsection{Public methods}{
|
||||
\itemize{
|
||||
\item \href{#method-MNR.DB.Applications-new}{\code{MNR.DB.Applications$new()}}
|
||||
\item \href{#method-MNR.DB.Applications-collectFromPermissions}{\code{MNR.DB.Applications$collectFromPermissions()}}
|
||||
\item \href{#method-MNR.DB.Applications-getUnfilteredApplications}{\code{MNR.DB.Applications$getUnfilteredApplications()}}
|
||||
\item \href{#method-MNR.DB.Applications-getAdminApplications}{\code{MNR.DB.Applications$getAdminApplications()}}
|
||||
\item \href{#method-MNR.DB.Applications-getPublicOnlyApplications}{\code{MNR.DB.Applications$getPublicOnlyApplications()}}
|
||||
\item \href{#method-MNR.DB.Applications-getRelatedApplications}{\code{MNR.DB.Applications$getRelatedApplications()}}
|
||||
\item \href{#method-MNR.DB.Applications-getUserOrganisationApplications}{\code{MNR.DB.Applications$getUserOrganisationApplications()}}
|
||||
\item \href{#method-MNR.DB.Applications-getUserApplications}{\code{MNR.DB.Applications$getUserApplications()}}
|
||||
\item \href{#method-MNR.DB.Applications-getApplicationState}{\code{MNR.DB.Applications$getApplicationState()}}
|
||||
\item \href{#method-MNR.DB.Applications-clone}{\code{MNR.DB.Applications$clone()}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{
|
||||
<details open><summary>Inherited methods</summary>
|
||||
<ul>
|
||||
<li><span class="pkg-link" data-pkg="AVSDevR.MarineNoiseRegistry" data-topic="MNR.DB" data-id="getDBClient"><a href='../../AVSDevR.MarineNoiseRegistry/html/MNR.DB.html#method-MNR.DB-getDBClient'><code>AVSDevR.MarineNoiseRegistry::MNR.DB$getDBClient()</code></a></span></li>
|
||||
</ul>
|
||||
</details>
|
||||
}}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-new"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-new}{}}}
|
||||
\subsection{Method \code{new()}}{
|
||||
Initialises the instance with a database client from
|
||||
\link[AVSDevR.DBClient]{DBClient}
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$new(db_client)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{db_client}}{<\link[AVSDevR.DBClient]{DBClient}> A DBClient instance}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-collectFromPermissions"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-collectFromPermissions}{}}}
|
||||
\subsection{Method \code{collectFromPermissions()}}{
|
||||
Fetch application details from a permissions query
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$collectFromPermissions(perm_query, collect = TRUE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{perm_query}}{A permissions_query object}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getUnfilteredApplications"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getUnfilteredApplications}{}}}
|
||||
\subsection{Method \code{getUnfilteredApplications()}}{
|
||||
Fetch applications details from the database without any
|
||||
filtering applied
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getUnfilteredApplications(
|
||||
as_permissions = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{as_permissions}}{\if{html}{\out{<logical>}} Returns a permissions_query if TRUE else
|
||||
the applications if FALSE}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getAdminApplications"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getAdminApplications}{}}}
|
||||
\subsection{Method \code{getAdminApplications()}}{
|
||||
Fetch application details from the database with filtering
|
||||
for administration rights applied (assuming the user has the role)
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getAdminApplications(
|
||||
user_id = -1,
|
||||
as_permissions = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{user_id}}{\if{html}{\out{<integer>}} The user to check}
|
||||
|
||||
\item{\code{as_permissions}}{\if{html}{\out{<logical>}} Returns a permissions_query if TRUE else
|
||||
the applications if FALSE}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getPublicOnlyApplications"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getPublicOnlyApplications}{}}}
|
||||
\subsection{Method \code{getPublicOnlyApplications()}}{
|
||||
Fetch application details from the database filtered to
|
||||
those that are publicly available (ie. not draft or what-if)
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getPublicOnlyApplications(
|
||||
user_id = -1,
|
||||
as_permissions = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{user_id}}{\if{html}{\out{<integer>}} The user to check}
|
||||
|
||||
\item{\code{as_permissions}}{\if{html}{\out{<logical>}} Returns a permissions_query if TRUE else
|
||||
the applications if FALSE}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getRelatedApplications"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getRelatedApplications}{}}}
|
||||
\subsection{Method \code{getRelatedApplications()}}{
|
||||
Fetch application details from the database filtered to
|
||||
those that are related to a user (via submitter, organisation or
|
||||
agent/recipient)
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getRelatedApplications(
|
||||
user_id,
|
||||
as_permissions = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{user_id}}{\if{html}{\out{<integer>}} The user to check}
|
||||
|
||||
\item{\code{as_permissions}}{\if{html}{\out{<logical>}} Returns a permissions_query if TRUE else
|
||||
the applications if FALSE}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getUserOrganisationApplications"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getUserOrganisationApplications}{}}}
|
||||
\subsection{Method \code{getUserOrganisationApplications()}}{
|
||||
Fetch application details from the database filtered to
|
||||
those that are related to a user's organisation
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getUserOrganisationApplications(
|
||||
user_id,
|
||||
as_permissions = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{user_id}}{\if{html}{\out{<integer>}} The user to check}
|
||||
|
||||
\item{\code{as_permissions}}{\if{html}{\out{<logical>}} Returns a permissions_query if TRUE else
|
||||
the applications if FALSE}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getUserApplications"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getUserApplications}{}}}
|
||||
\subsection{Method \code{getUserApplications()}}{
|
||||
Fetch a list of applications belonging to a user
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getUserApplications(
|
||||
user_id,
|
||||
as_permissions = FALSE,
|
||||
collect = TRUE
|
||||
)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{user_id}}{\if{html}{\out{<integer>}} The user to check}
|
||||
|
||||
\item{\code{as_permissions}}{\if{html}{\out{<logical>}} Returns a permissions_query if TRUE else
|
||||
the applications if FALSE}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-getApplicationState"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-getApplicationState}{}}}
|
||||
\subsection{Method \code{getApplicationState()}}{
|
||||
Fetches the state of an application from the database
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$getApplicationState(application_id, collect = TRUE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{application_id}}{\if{html}{\out{<integer>}} The id of the application to check}
|
||||
|
||||
\item{\code{collect}}{\if{html}{\out{<logical>}} Collect the query before returning (TRUE) or
|
||||
return the built query object (FALSE)}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
\if{html}{\out{<hr>}}
|
||||
\if{html}{\out{<a id="method-MNR.DB.Applications-clone"></a>}}
|
||||
\if{latex}{\out{\hypertarget{method-MNR.DB.Applications-clone}{}}}
|
||||
\subsection{Method \code{clone()}}{
|
||||
The objects of this class are cloneable with this method.
|
||||
\subsection{Usage}{
|
||||
\if{html}{\out{<div class="r">}}\preformatted{MNR.DB.Applications$clone(deep = FALSE)}\if{html}{\out{</div>}}
|
||||
}
|
||||
|
||||
\subsection{Arguments}{
|
||||
\if{html}{\out{<div class="arguments">}}
|
||||
\describe{
|
||||
\item{\code{deep}}{Whether to make a deep clone.}
|
||||
}
|
||||
\if{html}{\out{</div>}}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user