C# Class SobekCM.Engine_Library.Endpoints.ItemServices

Class supports all the item-level services provided by the SobekCM engine

Inheritance: EndpointBase

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

Public Methods

Method	Description
Bookshelf_HTTP_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Writes the small snippet of HTML to pop-up when the user selects the ADD TO BOOKSHELF button
Describe_HTML_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Serve the small DESCRIBE html used for adding tags to an item
GetItemBriefInternal ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the information about a single digital resource, using the STANDARD mapping set
GetItemBriefStandard ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the information about a single digital resource, using the STANDARD mapping set
GetItemCitation ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the citation information for a digital resource
GetItemEAD ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets any EAD information related to an item
GetItemFiles ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the list of all files related to an item
GetItemMarcRecord ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the item's marc record in object format for serialization/deserialization
GetItemRdf ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the complete (language agnostic) web skin, by web skin code
GetItemStatisticsHistory ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the month-by-month usage for an item
GetItemTrackingWorkHistory ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the work history related to an item
GetItemXml ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Get the item in a standard XML format, such as dublin core, marcxml, etc..
GetMultipleVolumes ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the collection of items under a title
GetRandomItem ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the complete (language agnostic) web skin, by web skin code
Get_Item_Info_Legacy ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the information about a single digital resource
Print_HTML_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Writes the small snippet of HTML to pop-up when the user selects the PRINT button
Send_Email_HTML_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Writes the small snippet of HTML to pop-up when the user selects the SEND EMAIL button
Share_HTTP_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Writes the small snippet of HTML to pop-up when the user selects the SHARE button
getSobekItem ( string BibID, string VID, Custom_Tracer Tracer ) : SobekCM_Item
getSobekItem ( string BibID, string VID, int UserID, Custom_Tracer Tracer ) : SobekCM_Item
getSobekItemGroup ( string BibID, Custom_Tracer Tracer ) : SobekCM_Item
getSobekTitle ( string BibID, Custom_Tracer Tracer ) : SobekCM_Item

Protected Methods

Method	Description
brief_item_response ( string Mapping, HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void	Gets the information about a single digital resource, using the indicated mapping set
legacy_json_display_item_info ( TextWriter Output, BriefItemInfo BriefItem, int Page, string Viewer ) : void	Writes the item information in JSON format directly to the output stream in legacy format

Private Methods

Method	Description
GetBriefItem ( string BibID, string VID, string MappingSet, Custom_Tracer Tracer ) : BriefItemInfo
GetBriefTitle ( string BibID, string MappingSet, Custom_Tracer Tracer ) : BriefItemInfo
ead_copy_container_to_transfer ( Container_Info Source ) : EAD_Transfer_Container_Info
ead_copy_did_to_transfer ( Descriptive_Identification Source ) : EAD_Transfer_Descriptive_Identification

Method Details

Bookshelf_HTTP_Snippet() public method

Writes the small snippet of HTML to pop-up when the user selects the ADD TO BOOKSHELF button

public Bookshelf_HTTP_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

Describe_HTML_Snippet() public method

Serve the small DESCRIBE html used for adding tags to an item

public Describe_HTML_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemBriefInternal() public method

Gets the information about a single digital resource, using the STANDARD mapping set

public GetItemBriefInternal ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemBriefStandard() public method

Gets the information about a single digital resource, using the STANDARD mapping set

public GetItemBriefStandard ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemCitation() public method

Gets the citation information for a digital resource

public GetItemCitation ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemEAD() public method

Gets any EAD information related to an item

public GetItemEAD ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemFiles() public method

Gets the list of all files related to an item

public GetItemFiles ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemMarcRecord() public method

Gets the item's marc record in object format for serialization/deserialization

public GetItemMarcRecord ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemRdf() public method

Gets the complete (language agnostic) web skin, by web skin code

public GetItemRdf ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemStatisticsHistory() public method

Gets the month-by-month usage for an item

public GetItemStatisticsHistory ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemTrackingWorkHistory() public method

Gets the work history related to an item

public GetItemTrackingWorkHistory ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetItemXml() public method

Get the item in a standard XML format, such as dublin core, marcxml, etc..

public GetItemXml ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetMultipleVolumes() public method

Gets the collection of items under a title

public GetMultipleVolumes ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

GetRandomItem() public method

Gets the complete (language agnostic) web skin, by web skin code

public GetRandomItem ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

Get_Item_Info_Legacy() public method

Gets the information about a single digital resource

public Get_Item_Info_Legacy ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

Print_HTML_Snippet() public method

Writes the small snippet of HTML to pop-up when the user selects the PRINT button

public Print_HTML_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

Send_Email_HTML_Snippet() public method

Writes the small snippet of HTML to pop-up when the user selects the SEND EMAIL button

public Send_Email_HTML_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

Share_HTTP_Snippet() public method

Writes the small snippet of HTML to pop-up when the user selects the SHARE button

public Share_HTTP_Snippet ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

brief_item_response() protected method

Gets the information about a single digital resource, using the indicated mapping set

protected brief_item_response ( string Mapping, HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void
Mapping	string	Mapping set to use
Response	System.Web.HttpResponse
UrlSegments	List
QueryString	System.Collections.Specialized.NameValueCollection
Protocol	Microservice_Endpoint_Protocol_Enum
IsDebug	bool
return	void

getSobekItem() public method

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

getSobekItem() public method

public getSobekItem ( 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

getSobekItemGroup() public method

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

getSobekTitle() public method

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

legacy_json_display_item_info() protected method

Writes the item information in JSON format directly to the output stream in legacy format

protected legacy_json_display_item_info ( TextWriter Output, BriefItemInfo BriefItem, int Page, string Viewer ) : void
Output	System.IO.TextWriter	Stream to which to write the JSON item information
BriefItem	SobekCM.Core.BriefItem.BriefItemInfo
Page	int
Viewer	string
return	void