C# Class SobekCM.Engine_Library.Endpoints.AdministrativeServices

Class supports all the administrative-related services provided by the SobekCM engine and not already provided via a more specialized service-related endpoint

Inheritance: EndpointBase

Show file Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
DisablePlugin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Disable an existing plug-in
EnablePlugin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Enable an existing plug-in
GetAdminSettings ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the administrative setting values, which includes display information along with the current value and key
GetConfiguration ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the complete configuration object
GetConfigurationAuthentication ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the authentication configuration object
GetConfigurationBriefItemMapping ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the brief item mapping configuration object
GetConfigurationCitation ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the citation dispay (UI) configuration object
GetConfigurationContactForm ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the contact form configuration object
GetConfigurationEngine ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the engine endpoints configuration object
GetConfigurationExtensions ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the extensions configuration object
GetConfigurationLog ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the log from reading all of the configuration files
GetConfigurationMapEditor ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the map editor (UI) configuration object
GetConfigurationMetadata ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the metadata configuration object
GetConfigurationOaiPmh ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the OAI-PMH configuration object
GetConfigurationQualityControl ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the quality control tool configuration object
GetConfigurationStaticResources ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the UI static resources configuration object
GetConfigurationTemplateElements ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the template elements (UI) configuration object
GetConfigurationUserInterface ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the citation dispay (UI) configuration object
GetConfigurationViewers ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the viewers (ui) configuration object
GetSettings ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the administrative setting values, which includes display information along with the current value and key

Method Details

DisablePlugin() public method

Disable an existing plug-in

public DisablePlugin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

EnablePlugin() public method

Enable an existing plug-in

public EnablePlugin ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetAdminSettings() public method

Gets the administrative setting values, which includes display information along with the current value and key

public GetAdminSettings ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfiguration() public method

Gets the complete configuration object

public GetConfiguration ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationAuthentication() public method

Gets the authentication configuration object

public GetConfigurationAuthentication ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationBriefItemMapping() public method

Gets the brief item mapping configuration object

public GetConfigurationBriefItemMapping ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationCitation() public method

Gets the citation dispay (UI) configuration object

public GetConfigurationCitation ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationContactForm() public method

Gets the contact form configuration object

public GetConfigurationContactForm ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationEngine() public method

Gets the engine endpoints configuration object

public GetConfigurationEngine ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationExtensions() public method

Gets the extensions configuration object

public GetConfigurationExtensions ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationLog() public method

Gets the log from reading all of the configuration files

public GetConfigurationLog ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationMapEditor() public method

Gets the map editor (UI) configuration object

public GetConfigurationMapEditor ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationMetadata() public method

Gets the metadata configuration object

public GetConfigurationMetadata ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationOaiPmh() public method

Gets the OAI-PMH configuration object

public GetConfigurationOaiPmh ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationQualityControl() public method

Gets the quality control tool configuration object

public GetConfigurationQualityControl ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationStaticResources() public method

Gets the UI static resources configuration object

public GetConfigurationStaticResources ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationTemplateElements() public method

Gets the template elements (UI) configuration object

public GetConfigurationTemplateElements ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationUserInterface() public method

Gets the citation dispay (UI) configuration object

public GetConfigurationUserInterface ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetConfigurationViewers() public method

Gets the viewers (ui) configuration object

public GetConfigurationViewers ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetSettings() public method

Gets the administrative setting values, which includes display information along with the current value and key

public GetSettings ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void