C# Class SobekCM.Core.MemoryMgmt.CachedDataManager_ItemServices

Item-specific services for the Cached Data Manager, which allows items to be cached, or portions of items and REST reponses related to items to be cached

Mostrar archivo Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method	Description
CachedDataManager_ItemServices ( SobekCM.Core.MemoryMgmt.CachedDataManager_Settings Settings ) : System	Constructor for a new instance of the CachedDataManager_ItemServices class.
Remove_Digital_Resource_Object ( int UserID, string BibID, string VID, Custom_Tracer Tracer ) : void	Removes a user-specific digital resource object from the cache , it it exists
Remove_Digital_Resource_Object ( string BibID, string VID, Custom_Tracer Tracer ) : void	Removes a global digital resource object from the cache , it it exists
Remove_Digital_Resource_Objects ( string BibID, Custom_Tracer Tracer ) : void	Removes all digital resource objects from the cache , for a given BibID
Remove_Items_In_Title ( string BibID, Custom_Tracer Tracer ) : void	Removes the list of items for a single bibid to the cache
Remove_Items_List ( string BibID, Custom_Tracer Tracer ) : void	Removes the list of items for a single bibid to the cache
Retrieve_Brief_Digital_Resource_Object ( string BibID, string VID, Custom_Tracer Tracer ) : BriefItemInfo	Retrieves the brief (transfer) digital resource object from the cache
Retrieve_Digital_Resource_Object ( int UserID, string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item	Retrieves a user-specific digital resource object from the cache
Retrieve_Digital_Resource_Object ( string BibID, Custom_Tracer Tracer ) : SobekCM_Item	Retrieves the title-level object from the cache
Retrieve_Digital_Resource_Object ( string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item	Retrieves a global digital resource object from the cache
Retrieve_EAD_Info ( string BibID, string VID, Custom_Tracer Tracer ) : EAD_Transfer_Object	Retrieves the EAD information related to a digital resource
Retrieve_Item_List ( string BibID, Custom_Tracer Tracer ) : List	Retrieves the list of items within a single title
Retrieve_Item_Tracking ( string BibID, string VID, Custom_Tracer Tracer ) : Item_Tracking_Details	Retrieves the tracking/workflow information related to a digital resource
Retrieve_Item_Usage ( string BibID, string VID, Custom_Tracer Tracer ) : List	Retrieves the usage history related to a digital resource
Retrieve_Items_In_Title ( string BibID, Custom_Tracer Tracer ) : SobekCM.Core.Items.SobekCM_Items_In_Title	Retrieves the list of items for a single bibid from the cache
Retrieve_MARC_Record ( string BibID, string VID, Custom_Tracer Tracer ) : MARC_Transfer_Record	Retrieves the MARC record object related to a digital resource
Store_Brief_Digital_Resource_Object ( string BibID, string VID, BriefItemInfo StoreObject, Custom_Tracer Tracer ) : void	Store a brief (transfer) digital resource object on the cache
Store_Digital_Resource_Object ( int UserID, string BibID, string VID, SobekCM_Item StoreObject, Custom_Tracer Tracer ) : void	Store a user-specific digital resource object on the cache
Store_Digital_Resource_Object ( string BibID, SobekCM_Item StoreObject, Custom_Tracer Tracer ) : void	Stores the title-level digital resource object on the cache
Store_Digital_Resource_Object ( string BibID, string VID, SobekCM_Item StoreObject, Custom_Tracer Tracer ) : void	Store a global digital resource object on the cache
Store_EAD_Info ( string BibID, string VID, EAD_Transfer_Object StoreObject, Custom_Tracer Tracer ) : void	Store the EAD information related to a digital resource on the cache
Store_Item_List ( string BibID, List StoreObject, Custom_Tracer Tracer ) : void	Store the MARC record object related to a digital resource on the cache
Store_Item_Tracking ( string BibID, string VID, Item_Tracking_Details StoreObject, Custom_Tracer Tracer ) : void	Store the tracking/workflow information related to a digital resource
Store_Item_Usage ( string BibID, string VID, List StoreObject, Custom_Tracer Tracer ) : void	Store the usage history related to a digital resource on the cache
Store_Items_In_Title ( string BibID, SobekCM.Core.Items.SobekCM_Items_In_Title StoreObject, Custom_Tracer Tracer ) : void	Stores the list of items for a single bibid to the cache
Store_MARC_Record ( string BibID, string VID, MARC_Transfer_Record StoreObject, Custom_Tracer Tracer ) : void	Store the MARC record object related to a digital resource on the cache

Method Details

CachedDataManager_ItemServices() public method

Constructor for a new instance of the CachedDataManager_ItemServices class.

public CachedDataManager_ItemServices ( SobekCM.Core.MemoryMgmt.CachedDataManager_Settings Settings ) : System
Settings	SobekCM.Core.MemoryMgmt.CachedDataManager_Settings	Cached data manager settings object
return	System

Remove_Digital_Resource_Object() public method

Removes a user-specific digital resource object from the cache , it it exists

public Remove_Digital_Resource_Object ( int UserID, string BibID, string VID, Custom_Tracer Tracer ) : void
UserID	int	Primary key of the user, if this should be removed from the user-specific cache
BibID	string	Bibliographic Identifier for the digital resource to remove
VID	string	Volume Identifier for the digital resource to remove
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Remove_Digital_Resource_Object() public method

Removes a global digital resource object from the cache , it it exists

public Remove_Digital_Resource_Object ( string BibID, string VID, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to remove
VID	string	Volume Identifier for the digital resource to remove
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Remove_Digital_Resource_Objects() public method

Removes all digital resource objects from the cache , for a given BibID

public Remove_Digital_Resource_Objects ( string BibID, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resources to remove
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Remove_Items_In_Title() public method

Removes the list of items for a single bibid to the cache

public Remove_Items_In_Title ( string BibID, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic identifier for the list of items
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Remove_Items_List() public method

Removes the list of items for a single bibid to the cache

public Remove_Items_List ( string BibID, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic identifier for the list of items
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Retrieve_Brief_Digital_Resource_Object() public method

Retrieves the brief (transfer) digital resource object from the cache

public Retrieve_Brief_Digital_Resource_Object ( string BibID, string VID, Custom_Tracer Tracer ) : BriefItemInfo
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Core.BriefItem.BriefItemInfo

Retrieve_Digital_Resource_Object() public method

Retrieves a user-specific digital resource object from the cache

public Retrieve_Digital_Resource_Object ( int UserID, string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item
UserID	int	Primary key of the user, if this should be pulled from the user-specific cache
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Resource_Object.SobekCM_Item

Retrieve_Digital_Resource_Object() public method

Retrieves the title-level object from the cache

public Retrieve_Digital_Resource_Object ( string BibID, Custom_Tracer Tracer ) : SobekCM_Item
BibID	string	Bibliographic Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Resource_Object.SobekCM_Item

Retrieve_Digital_Resource_Object() public method

Retrieves a global digital resource object from the cache

public Retrieve_Digital_Resource_Object ( string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Resource_Object.SobekCM_Item

Retrieve_EAD_Info() public method

Retrieves the EAD information related to a digital resource

public Retrieve_EAD_Info ( string BibID, string VID, Custom_Tracer Tracer ) : EAD_Transfer_Object
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Core.EAD.EAD_Transfer_Object

Retrieve_Item_List() public method

Retrieves the list of items within a single title

public Retrieve_Item_List ( string BibID, Custom_Tracer Tracer ) : List
BibID	string	Bibliographic Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	List

Retrieve_Item_Tracking() public method

Retrieves the tracking/workflow information related to a digital resource

public Retrieve_Item_Tracking ( string BibID, string VID, Custom_Tracer Tracer ) : Item_Tracking_Details
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Core.Items.Item_Tracking_Details

Retrieve_Item_Usage() public method

Retrieves the usage history related to a digital resource

public Retrieve_Item_Usage ( string BibID, string VID, Custom_Tracer Tracer ) : List
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	List

Retrieve_Items_In_Title() public method

Retrieves the list of items for a single bibid from the cache

public Retrieve_Items_In_Title ( string BibID, Custom_Tracer Tracer ) : SobekCM.Core.Items.SobekCM_Items_In_Title
BibID	string	Bibliographic identifier for the list of items
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Core.Items.SobekCM_Items_In_Title

Retrieve_MARC_Record() public method

Retrieves the MARC record object related to a digital resource

public Retrieve_MARC_Record ( string BibID, string VID, Custom_Tracer Tracer ) : MARC_Transfer_Record
BibID	string	Bibliographic Identifier for the digital resource to retrieve
VID	string	Volume Identifier for the digital resource to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Core.MARC.MARC_Transfer_Record

Store_Brief_Digital_Resource_Object() public method

Store a brief (transfer) digital resource object on the cache

public Store_Brief_Digital_Resource_Object ( string BibID, string VID, BriefItemInfo StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	SobekCM.Core.BriefItem.BriefItemInfo	Digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Digital_Resource_Object() public method

Store a user-specific digital resource object on the cache

public Store_Digital_Resource_Object ( int UserID, string BibID, string VID, SobekCM_Item StoreObject, Custom_Tracer Tracer ) : void
UserID	int	Primary key of the user, if this should be stored in a user-specific cache
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	SobekCM.Resource_Object.SobekCM_Item	Digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Digital_Resource_Object() public method

Stores the title-level digital resource object on the cache

public Store_Digital_Resource_Object ( string BibID, SobekCM_Item StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
StoreObject	SobekCM.Resource_Object.SobekCM_Item	Digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Digital_Resource_Object() public method

Store a global digital resource object on the cache

public Store_Digital_Resource_Object ( string BibID, string VID, SobekCM_Item StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	SobekCM.Resource_Object.SobekCM_Item	Digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_EAD_Info() public method

Store the EAD information related to a digital resource on the cache

public Store_EAD_Info ( string BibID, string VID, EAD_Transfer_Object StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	SobekCM.Core.EAD.EAD_Transfer_Object	EAD information for a digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Item_List() public method

Store the MARC record object related to a digital resource on the cache

public Store_Item_List ( string BibID, List StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
StoreObject	List	List of items under a single title to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Item_Tracking() public method

Store the tracking/workflow information related to a digital resource

public Store_Item_Tracking ( string BibID, string VID, Item_Tracking_Details StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	SobekCM.Core.Items.Item_Tracking_Details	Tracking/workflow information for a digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Item_Usage() public method

Store the usage history related to a digital resource on the cache

public Store_Item_Usage ( string BibID, string VID, List StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	List	Usage history for a digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_Items_In_Title() public method

Stores the list of items for a single bibid to the cache

public Store_Items_In_Title ( string BibID, SobekCM.Core.Items.SobekCM_Items_In_Title StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic identifier for the list of items
StoreObject	SobekCM.Core.Items.SobekCM_Items_In_Title	List of items within the single title
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Store_MARC_Record() public method

Store the MARC record object related to a digital resource on the cache

public Store_MARC_Record ( string BibID, string VID, MARC_Transfer_Record StoreObject, Custom_Tracer Tracer ) : void
BibID	string	Bibliographic Identifier for the digital resource to store
VID	string	Volume Identifier for the digital resource to store
StoreObject	SobekCM.Core.MARC.MARC_Transfer_Record	EAD information for a digital Resource object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void