C# Class SobekCM.Core.Client.SobekEngineClient_ItemEndpoints

Gateway to all the item-related endpoints exposed by the SobekCM engine

Inheritance: MicroservicesClientBase

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

Public Methods

Method	Description
Clear_Item_Cache ( string BibID, string VID, Custom_Tracer Tracer ) : void	Clears the engine cache of all items related to a particular digital resource
Clear_Item_Group_Cache ( string BibID, Custom_Tracer Tracer ) : void	Clears the engine cache of all items related to a particular title, or all volumes within a single BibID
Get_Item_Brief ( string BibID, string VID, bool UseCache, Custom_Tracer Tracer ) : BriefItemInfo	Gets the brief digital resource object, by BibID_VID
Get_Item_EAD ( string BibID, string VID, bool UseCache, Custom_Tracer Tracer ) : EAD_Transfer_Object	Gets the special EAD information related to a digital resource object, by BibID_VID
Get_Item_MARC_Record ( string BibID, string VID, bool UseCache, Custom_Tracer Tracer ) : MARC_Transfer_Record	Gets the digital resource, mapped to a MARC record object, by BibID_VID
Get_Item_Statistics_History ( string BibID, string VID, Custom_Tracer Tracer ) : List	Gets the month-by-month usage for an item
Get_Item_Tracking_Work_History ( string BibID, string VID, Custom_Tracer Tracer ) : Item_Tracking_Details	Gets the work history for a single digital resource item
Get_Multiple_Volumes ( string BibID, Custom_Tracer Tracer ) : List	Gets the list of items (VIDs) under a single title (BibID)
Get_Sobek_Item ( string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item
Get_Sobek_Item ( string BibID, string VID, int UserID, Custom_Tracer Tracer ) : SobekCM_Item
Get_Sobek_Item_Group ( string BibID, Custom_Tracer Tracer ) : SobekCM_Item
SobekEngineClient_ItemEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System	Constructor for a new instance of the SobekEngineClient_ItemEndpoints class

Method Details

Clear_Item_Cache() public method

Clears the engine cache of all items related to a particular digital resource

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

Clear_Item_Group_Cache() public method

Clears the engine cache of all items related to a particular title, or all volumes within a single BibID

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

Get_Item_Brief() public method

Gets the brief digital resource object, by BibID_VID

public Get_Item_Brief ( string BibID, string VID, bool UseCache, Custom_Tracer Tracer ) : BriefItemInfo
BibID	string	Bibliographic identifier (BibID) for the digital resource to retrieve
VID	string	Volume identifier (VID) for the digital resource to retrieve
UseCache	bool	Flag indicates if the cache should be used to check for a built copy or store the final product
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Core.BriefItem.BriefItemInfo

Get_Item_EAD() public method

Gets the special EAD information related to a digital resource object, by BibID_VID

public Get_Item_EAD ( string BibID, string VID, bool UseCache, Custom_Tracer Tracer ) : EAD_Transfer_Object
BibID	string	Bibliographic identifier (BibID) for the digital resource to retrieve
VID	string	Volume identifier (VID) for the digital resource to retrieve
UseCache	bool	Flag indicates if the cache should be used to check for a built copy or store the final product
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

Get_Item_MARC_Record() public method

Gets the digital resource, mapped to a MARC record object, by BibID_VID

public Get_Item_MARC_Record ( string BibID, string VID, bool UseCache, Custom_Tracer Tracer ) : MARC_Transfer_Record
BibID	string	Bibliographic identifier (BibID) for the digital resource to retrieve
VID	string	Volume identifier (VID) for the digital resource to retrieve
UseCache	bool	Flag indicates if the cache should be used to check for a built copy or store the final product
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

Get_Item_Statistics_History() public method

Gets the month-by-month usage for an item

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

Get_Item_Tracking_Work_History() public method

Gets the work history for a single digital resource item

public Get_Item_Tracking_Work_History ( string BibID, string VID, Custom_Tracer Tracer ) : Item_Tracking_Details
BibID	string	Bibliographic identifier (BibID) for the digital resource
VID	string	Volume identifier (VID) for the digital resource
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

Get_Multiple_Volumes() public method

Gets the list of items (VIDs) under a single title (BibID)

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

Get_Sobek_Item() public method

public Get_Sobek_Item ( string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item
BibID	string
VID	string
Tracer	SobekCM.Tools.Custom_Tracer
return	SobekCM.Resource_Object.SobekCM_Item

Get_Sobek_Item() public method

public Get_Sobek_Item ( string BibID, string VID, int UserID, Custom_Tracer Tracer ) : SobekCM_Item
BibID	string
VID	string
UserID	int
Tracer	SobekCM.Tools.Custom_Tracer
return	SobekCM.Resource_Object.SobekCM_Item

Get_Sobek_Item_Group() public method

public Get_Sobek_Item_Group ( string BibID, Custom_Tracer Tracer ) : SobekCM_Item
BibID	string
Tracer	SobekCM.Tools.Custom_Tracer
return	SobekCM.Resource_Object.SobekCM_Item

SobekEngineClient_ItemEndpoints() public method

Constructor for a new instance of the SobekEngineClient_ItemEndpoints class

public SobekEngineClient_ItemEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System
ConfigObj	SobekCM.Core.MicroservicesClient.MicroservicesClient_Configuration	Fully constructed microservices client configuration
return	System