Navigation_Object Class

This object stores the current and next mode information for a single HTTP request.

Namespace: SobekCM.Core.Navigation
Assembly: SobekCM_Core (in SobekCM_Core.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
[SerializableAttribute] [ProtoContractAttribute] [XmlRootAttribute("navigationObject")] [DataContractAttribute] public class Navigation_Object

Remarks

Object written by Mark V Sullivan for the University of Florida.

Inheritance Hierarchy

System..::..Object
SobekCM.Core.Navigation..::..Navigation_Object

Constructors

	Name	Description
	Navigation_Object	Constructor for a new instance of the SobekCM_Navigation_Object which stores all of the information about an individual request.

Methods

	Name	Description
	Is_UserAgent_IP_Robot	Algorithm tests the user agent and IP address against known robots to determine if this request is from a search engine indexer or web site crawler bot.
	Set_Robot_Flag	Algorithm tests the user agent and IP address against known robots to determine if this request is from a search engine indexer or web site crawler bot. This returns the value and also sets an internal robot flag.
	ShouldSerializeDateRange_Date1	Method suppresses XML Serialization of the DateRange_Date1 property if it is NULL
	ShouldSerializeDateRange_Date2	Method suppresses XML Serialization of the DateRange_Date2 property if it is NULL
	ShouldSerializeDateRange_Year1	Method suppresses XML Serialization of the DateRange_Year1 property if it is NULL
	ShouldSerializeDateRange_Year2	Method suppresses XML Serialization of the DateRange_Year2 property if it is NULL
	ShouldSerializeFolderID	Method suppresses XML Serialization of the FolderID property if it is NULL
	ShouldSerializeInvalid_Item	Method suppresses XML Serialization of the Invalid_Item property if it is NULL
	ShouldSerializeItemID_DEPRECATED	Method suppresses XML Serialization of the ItemID_DEPRECATED property if it is NULL
	ShouldSerializeMissing	Method suppresses XML Serialization of the Missing flag property if it is NULL
	ShouldSerializePage	Method suppresses XML Serialization of the Page property if it is NULL
	ShouldSerializeShow_Selection_Panel	Method suppresses XML Serialization of the Show_Selection_Panel property if it is NULL
	ShouldSerializeSize_Of_Thumbnails	Method suppresses XML Serialization of the Size_Of_Thumbnails property if it is NULL
	ShouldSerializeSort	Method suppresses XML Serialization of the Sort property if it is NULL
	ShouldSerializeSubPage	Method suppresses XML Serialization of the SubPage property if it is NULL
	ShouldSerializeThumbnails_Per_Page	Method suppresses XML Serialization of the Thumbnails_Per_Page property if it is NULL
	ShouldSerializeWebContentID	Method suppresses XML Serialization of the WebContentID property if it is NULL

Properties

	Name	Description
	Admin_Type	Admin type of display for the current request.
	Aggregation	Current aggregation code
	Aggregation_Alias	Current aggregation alias code, if there is one
	Aggregation_Type	Submode for agrgegation views
	Base_Design_URL	URL to this application's design folder
	Base_Skin	Base infterface interface for display purposes
	Base_Skin_Or_Skin	Base infterface interface for display purposes
	Base_URL	Base URL requested by the user
	BibID	Bib id to display
	Browser_Type	Browser type
	Caught_Exception	Exception generated during execution
	Coordinates	Coordinate search string for a geographic search
	DateRange_Date1	Beginning of a date range, if the search includes a date range between two arbitrary dates
	DateRange_Date2	End of a date range, if the search includes a date range between two arbitrary dates
	DateRange_Year1	Beginning of the year range, if the search includes a date range between two years
	DateRange_Year2	End of the year range, if the search includes a date range between two years
	Default_Aggregation	Default aggregation (based on original URL)
	Default_Language	Default language for this user, from their browser settings
	Default_Skin	Default interface (based on original URL)
	Error_Message	Simple error message generated during execution
	FolderID	Primary key for the folder to display
	Fragment	Fragment utilized when only a portion of a page needs to be rendered
	Home_Type	Submode for the main library home page
	Info_Browse_Mode	Browse or info mode to display
	Instance_Abbreviation	Returns the name of this instance ( i.e., 'UDC', 'dLOC', etc... )
	Instance_Name	Returns the name of this instance ( i.e., 'UDC', 'dLOC', etc... )
	Internal_Type	Submode for the internal pages
	Invalid_Item	Flag that is set to indicate item requested is invalid
	Is_Robot	Flag indicating if the current request is from a search engine indexer or web site crawler bot.
	isPostBack	Flag indicating this is a post back
	ItemID_DEPRECATED	(DEPRECATED) ItemID which formerly was used for indicating items in the URL
	Language	Language for the interface
	Language_Code	Language code for the current skin language
	Logon_Required	Flag indicates that logon is required to access the requested mode
	Missing	Flag indicates if the requested web content page (or item) is not present (possibly a bad URL)
	Mode	Mode determined by parsing the query string
	My_Sobek_SubMode	mySobek submode for the current request.
	My_Sobek_Type	mySobek type of display for the current request.
	Page	Page number to be displayed (either for an item or for results )
	Page_By_FileName	Filename indicated in the URL to allow direct link by page file name, rather than sequence
	Portal_PURL	Gets the PURL associated with this portal which should be used for building permanent links for items
	Redirect	If this found a web content redirect in the system, the URL that this should be redirected to
	Remaining_Url_Segments	Remaining, unaccounted for, URL segments
	Report_Name	Name of the report requested from the reporting module
	Request_Completed	Flag indicates if the request was completed, so no further operations should occur
	Result_Display_Type	Submode for the results display
	Return_URL	Return url value from the url string
	Search_Fields	Search fields
	Search_Precision	Precision to be used while performing a metadata search in the database
	Search_String	Search string
	Search_Type	Submode for searching
	Show_Selection_Panel	Flag which determines if the selection panel is shown for an aggregation search
	Size_Of_Thumbnails	Size of Thumbnails to appear in the related items viewer
	Skin	Current skin for display purposes
	Skin_In_URL	Flag which indicates the interface is indicated in the URL and query string
	Sort	Sort type employed for displaying result sets
	Statistics_Type	Submode for the statistics pages
	SubAggregation	Information about which sub aggregationPermissions to include or exclude during a collection group search
	SubPage	Sub page number to be displayed (either for an item or for results )
	Text_Search	String to use for a single-item text search
	Thumbnails_Per_Page	Thumbnails per page to appear in the related images item viewer
	TOC_Display	TOC Display flag, which indicates whether to display the table of contents in the item viewer
	Trace_Flag	Trace flag which indicates whether to display the trace route
	Trace_Flag_Simple	Simplified flag for displaying the trace route
	VID	Volume id to display
	ViewerCode	Viewer code which indicates which viewer to use when displaying a single item in the item writer.
	Watermarks_URL	URL for the watermarks/icons under the design folder
	WebContent_Type	Webcontent type of display for the current request
	WebContentID	Primary key to the web content object selected
	Writer_Type	Writer type to be employed for rendering