C# Class SobekCM.Core.Settings.InstanceWide_Settings

Inheritance: iSerializationEvents

Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
Add_Additional_Setting ( string Key, string Value ) : void	Add a remaining, unassigned, additional setting
Contains_Additional_Setting ( string Key ) : bool	Get a flag indicating if a value is set for this key
Disposition_ID_Future ( string Disposition_Term ) : int	Gets the primary key for a disposition type, by the future tense term
Disposition_ID_Past ( string Disposition_Term ) : int	Gets the primary key for a disposition type, by the past tense term
Disposition_Term_Future ( int DispositionID ) : string	Gets the disposition term, in future tense, by primary key
Disposition_Term_Past ( int DispositionID ) : string	Gets the disposition term, in past tense, by primary key
ExtensionByCode ( string Code ) : ExtensionInfo	Gets the information from the database for a single extension
ExtensionEnabled ( string Code ) : bool	Checks to see if the extension exists and is enabled, according to the database
Get_Additional_Setting ( string Key ) : string	Gets an additional setting value, by the key
InstanceWide_Settings ( ) : System	constructor sets all the values to default empty strings
Metadata_Search_Field_By_Code ( string SobekCM_Code ) : Metadata_Search_Field	Gets a single metadata search field, by SobekCM web code
Metadata_Search_Field_By_Display_Name ( string Display_Name ) : Metadata_Search_Field	Gets a single metadata search field, by the display name
Metadata_Search_Field_By_Facet_Name ( string Facet_Name ) : Metadata_Search_Field	Gets a single metadata search field, by the facet name
Metadata_Search_Field_By_ID ( short MetadataTypeID ) : Metadata_Search_Field	Gets a single metadata search field, by primary identifiere
Metadata_Search_Field_By_Name ( string Metadata_Name ) : Metadata_Search_Field	Gets a single metadata search field, by the metadata column name
PostUnSerialization ( ) : void	Method is called by the serializer after this item is unserialized
ShouldSerializeArchive ( ) : bool	Method suppresses XML Serialization of the Archive property if it is empty
ShouldSerializeFlorida ( ) : bool	Method suppresses XML Serialization of the Florida property if it is empty
ShouldSerializeMarcGeneration ( ) : bool	Method suppresses XML Serialization of the MarcGeneration property if it is empty
User_InProcess_Directory ( User_Object CurrentUser, string DirectoryName ) : string	Gets the user-in-process directory

Method Details

Add_Additional_Setting() public method

Add a remaining, unassigned, additional setting

public Add_Additional_Setting ( string Key, string Value ) : void
Key	string	Name / key for this database setting
Value	string	Current value for this setting
return	void

Contains_Additional_Setting() public method

Get a flag indicating if a value is set for this key

public Contains_Additional_Setting ( string Key ) : bool
Key	string	Name / key for this database setting
return	bool

Disposition_ID_Future() public method

Gets the primary key for a disposition type, by the future tense term

public Disposition_ID_Future ( string Disposition_Term ) : int
Disposition_Term	string	Disposition term, in future tense
return	int

Disposition_ID_Past() public method

Gets the primary key for a disposition type, by the past tense term

public Disposition_ID_Past ( string Disposition_Term ) : int
Disposition_Term	string	Disposition term, in past tense
return	int

Disposition_Term_Future() public method

Gets the disposition term, in future tense, by primary key

public Disposition_Term_Future ( int DispositionID ) : string
DispositionID	int	Primary key for the disposition term
return	string

Disposition_Term_Past() public method

Gets the disposition term, in past tense, by primary key

public Disposition_Term_Past ( int DispositionID ) : string
DispositionID	int	Primary key for the disposition term
return	string

ExtensionByCode() public method

Gets the information from the database for a single extension

public ExtensionByCode ( string Code ) : ExtensionInfo
Code	string	Code of the extensions, which must match the directory for the plug-in
return	SobekCM.Core.Configuration.Extensions.ExtensionInfo

ExtensionEnabled() public method

Checks to see if the extension exists and is enabled, according to the database

public ExtensionEnabled ( string Code ) : bool
Code	string	Code of the extensions, which must match the directory for the plug-in
return	bool

Get_Additional_Setting() public method

Gets an additional setting value, by the key

public Get_Additional_Setting ( string Key ) : string
Key	string	Name / key for this database setting
return	string

InstanceWide_Settings() public method

constructor sets all the values to default empty strings

public InstanceWide_Settings ( ) : System
return	System

Metadata_Search_Field_By_Code() public method

Gets a single metadata search field, by SobekCM web code

public Metadata_Search_Field_By_Code ( string SobekCM_Code ) : Metadata_Search_Field
SobekCM_Code	string	Code for this metadata search field, employed within the URLs
return	SobekCM.Core.Search.Metadata_Search_Field

Metadata_Search_Field_By_Display_Name() public method

Gets a single metadata search field, by the display name

public Metadata_Search_Field_By_Display_Name ( string Display_Name ) : Metadata_Search_Field
Display_Name	string	Name for this field and name of the column in the database
return	SobekCM.Core.Search.Metadata_Search_Field

Metadata_Search_Field_By_Facet_Name() public method

Gets a single metadata search field, by the facet name

public Metadata_Search_Field_By_Facet_Name ( string Facet_Name ) : Metadata_Search_Field
Facet_Name	string	Name for this field for faceting purposes
return	SobekCM.Core.Search.Metadata_Search_Field

Metadata_Search_Field_By_ID() public method

Gets a single metadata search field, by primary identifiere

public Metadata_Search_Field_By_ID ( short MetadataTypeID ) : Metadata_Search_Field
MetadataTypeID	short	Primary identifier for the metadata search field
return	SobekCM.Core.Search.Metadata_Search_Field

Metadata_Search_Field_By_Name() public method

Gets a single metadata search field, by the metadata column name

public Metadata_Search_Field_By_Name ( string Metadata_Name ) : Metadata_Search_Field
Metadata_Name	string	Name for this field and name of the column in the database
return	SobekCM.Core.Search.Metadata_Search_Field

PostUnSerialization() public method

Method is called by the serializer after this item is unserialized

public PostUnSerialization ( ) : void
return	void

ShouldSerializeArchive() public method

Method suppresses XML Serialization of the Archive property if it is empty

public ShouldSerializeArchive ( ) : bool
return	bool

ShouldSerializeFlorida() public method

Method suppresses XML Serialization of the Florida property if it is empty

public ShouldSerializeFlorida ( ) : bool
return	bool

ShouldSerializeMarcGeneration() public method

Method suppresses XML Serialization of the MarcGeneration property if it is empty

public ShouldSerializeMarcGeneration ( ) : bool
return	bool

User_InProcess_Directory() public method

Gets the user-in-process directory

public User_InProcess_Directory ( User_Object CurrentUser, string DirectoryName ) : string
CurrentUser	SobekCM.Core.Users.User_Object	Current user, for which to find the in-process directory
DirectoryName	string	Subdirectory requested
return	string