C# Class SobekCM.Core.Configuration.OAIPMH.OAI_PMH_Configuration

Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property Type Description
Convert_String_To_XML_Safe string

Public Methods

Method Description
Add_Admin_Email ( string AdminEmail ) : void

Add a new admin email address within the Identify response of the OAI-PMH protocol

Add_Description ( string NewDescription ) : void

Add a new description to be included within the Identify response of the OAI-PMH protocol

Add_Metadata_Prefix ( OAI_PMH_Metadata_Format NewPrefix ) : void

Add a new metadata prefix

Clear_Metadata_Prefixes ( ) : void

Clears all the metadata prefixes

OAI_PMH_Configuration ( ) : System

OAI-PMG configuration information for this SobekCM instance

Save_To_Config_File ( string FilePath ) : bool

Save this OAI-PMH configuration to a XML config file

Set_Default ( ) : void

Sets the defautls for the metadata prefixes ( dublin core and marc21 )

Private Methods

Method Description
Convert_String_To_XML_Safe ( string element ) : string

Converts a basic string into an XML-safe string

Method Details

Add_Admin_Email() public method

Add a new admin email address within the Identify response of the OAI-PMH protocol
public Add_Admin_Email ( string AdminEmail ) : void
AdminEmail string New admin email to add to the list
return void

Add_Description() public method

Add a new description to be included within the Identify response of the OAI-PMH protocol
public Add_Description ( string NewDescription ) : void
NewDescription string New custom description to be included
return void

Add_Metadata_Prefix() public method

Add a new metadata prefix
public Add_Metadata_Prefix ( OAI_PMH_Metadata_Format NewPrefix ) : void
NewPrefix OAI_PMH_Metadata_Format New OAI-PMH metadata prefix and reader/writer
return void

Clear_Metadata_Prefixes() public method

Clears all the metadata prefixes
public Clear_Metadata_Prefixes ( ) : void
return void

OAI_PMH_Configuration() public method

OAI-PMG configuration information for this SobekCM instance
public OAI_PMH_Configuration ( ) : System
return System

Save_To_Config_File() public method

Save this OAI-PMH configuration to a XML config file
public Save_To_Config_File ( string FilePath ) : bool
FilePath string File/path for the resulting XML config file
return bool

Set_Default() public method

Sets the defautls for the metadata prefixes ( dublin core and marc21 )
public Set_Default ( ) : void
return void