mySobek Home   |   Help
Skip Navigation Links.
MISSING BANNER
Code Details >> Core Namespace

SobekCM.Core Namespace



Namespace contains all of the classes that are shared by the engine, the web ui-layer, and the builder. Most of these classes are decorated to allow serialization and transfer between the engine and the ui-layer via JSON (and possibly protobuf). Many of these classes must be built using builder classes contained within the SobekCM Engine library.

Sub-Namespaces

NamespaceDescription
Aggregations
Classes contain all the information about aggregations, both complete aggrgeations and language-specific versions, as well classes that hold data about the child pages and other child objects to the aggrgegations.
ApplicationState
Contains the main classes which collectively comprise the application state for the running instance of SobekCM
BriefItem
Brief item object is used to pass information about a single digital resource to the ui-layer via the engine. While this retains most the information from the SobekCM_Item class, the data is somewhat simplified and normalized when passed out via the REST API.
Builder
Client
Client classes used for accessing the endpoints exposed via the SobekCM engine
Configuration
Classes contain much of the configuration information used throughout the SobekCM system, such as the OAI-PMH, Shibboleth, quality control, and contact form settings, as well as classes to support mulitple web languages. Configuration information is very static and is usually read from config files located under the applications. The readers and writers for this configuration files are generally in the SobekCM Engine library.
Configuration.Authentication
Configuration.Engine
Configuration.Extensions
Configuration.Localization
Configuration.OAIPMH
EAD
FileSystems
Items
Class is used to store information about individual items within a single title and made available to the ui-layer via the endpoints on the SobekCM engine
MARC
MemoryMgmt
Contains the cached data manager and methods for clearing the cache (or caching server) as well as retrieving and storing objects.
Message
Messages used to wrap responses between the engine and ui-layer.
MicroservicesClient
General classes to support a client that relies on a configuration file to find all the microservice endpoints to be exposed
Navigation
Classes that hold the basic navigational information for a single query and can be used to write the URL for other specific possible requests.
OAI
Classes used to support OAI-PMH serving of digital resource metadata.
Results
Classes hold the search result information returned from a database or solr/lucene search
ResultTitle
Search
Contains information about a single metadata field, useful for building the search strings for querying both the database and solr/lucene.
Serialization
Interface is used to determine that some action should be completed before or after serialization, and must be checked on both sides of the REST API communication
Settings
Classes hold all the setting information related to this instance. Setting information is more prone to change than configurations and are usually stored within the database. The builders and database calls to populate these setting objects are in the SobekCM Engine library.
SiteMap
Classes are used to store the sitemap information for a tree of top-level static resources within an instance.
Skins
Contains the objects used to control the web skin (a.k.a. interface) which determines the overall appearance of the digital library
UI_Configuration
UI_Configuration.Citation
UI_Configuration.TemplateElements
UI_Configuration.Viewers
Users
Contains all the data about a single authenticated user including all the top-level permissions granted and aggregation-specific permissions.
WebContent
Contains the classes used when to hold all the information about a single static html content page served through the instance, either at the top-level or under an aggrgeation.
WebContent.Admin
WebContent.Hierarchy
WebContent.Single

Classes

  ClassDescription
Public classEmailInfo
Class represents information for an email to be sent by the system
Public classMilestone_Entry
A single milestone entry in the history of an entity

Interfaces

  InterfaceDescription
Public interfaceiSerializationEvents
Interface is implemented for classes that require some additional configuration to occur around serialization events


Version 4.10.0 ( last generated Monday, March 7, 2016 )