C# Class SobekCM.Library.RequestCache

Class holds all the information about one specific request and the non-global data that is specifically needed to resolve the request.
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Properties

Property Type Description
Current_Mode SobekCM.Core.Navigation.Navigation_Object
Current_User SobekCM.Core.Users.User_Object
Paged_Results List
Public_Folder Public_User_Folder
Results_Statistics Search_Results_Statistics
Top_Collection Item_Aggregation
Tracer Custom_Tracer

Public Methods

Method Description
RequestCache ( Navigation_Object Current_Mode, Search_Results_Statistics Results_Statistics, List Paged_Results, User_Object Current_User, Public_User_Folder Public_Folder, Item_Aggregation Top_Collection, Custom_Tracer Tracer ) : System.Collections.Generic

Constructor for a new instance of the RequestCache class
RequestCache ( Navigation_Object Current_Mode, Search_Results_Statistics Results_Statistics, List Paged_Results, Web_Skin_Object HTML_Skin, User_Object Current_User, Public_User_Folder Public_Folder, Item_Aggregation Top_Collection, Custom_Tracer Tracer ) : System.Collections.Generic

Constructor for a new instance of the RequestCache class

Method Details

RequestCache() public method

Constructor for a new instance of the RequestCache class
public RequestCache ( Navigation_Object Current_Mode, Search_Results_Statistics Results_Statistics, List Paged_Results, User_Object Current_User, Public_User_Folder Public_Folder, Item_Aggregation Top_Collection, Custom_Tracer Tracer ) : System.Collections.Generic
Current_Mode Navigation_Object Mode / navigation information for the current request
Results_Statistics Search_Results_Statistics Information about the entire set of results for a search or browse
Paged_Results List Single page of results for a search or browse, within the entire set
Current_User User_Object Currently logged on user
Public_Folder Public_User_Folder Object contains the information about the public folder to display
Top_Collection Item_Aggregation Item aggregation for the top-level collection, which is used in a number of places, for example /// showing the correct banner, even when it is not the "current" aggregation
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return System.Collections.Generic

RequestCache() public method

Constructor for a new instance of the RequestCache class
public RequestCache ( Navigation_Object Current_Mode, Search_Results_Statistics Results_Statistics, List Paged_Results, Web_Skin_Object HTML_Skin, User_Object Current_User, Public_User_Folder Public_Folder, Item_Aggregation Top_Collection, Custom_Tracer Tracer ) : System.Collections.Generic
Current_Mode Navigation_Object Mode / navigation information for the current request
Results_Statistics Search_Results_Statistics Information about the entire set of results for a search or browse
Paged_Results List Single page of results for a search or browse, within the entire set
HTML_Skin Web_Skin_Object HTML Web skin which controls the overall appearance of this digital library
Current_User User_Object Currently logged on user
Public_Folder Public_User_Folder Object contains the information about the public folder to display
Top_Collection Item_Aggregation Item aggregation for the top-level collection, which is used in a number of places, for example /// showing the correct banner, even when it is not the "current" aggregation
Tracer Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return System.Collections.Generic

Property Details

Current_Mode public_oe property

Mode / navigation information for the current request
public Navigation_Object,SobekCM.Core.Navigation Current_Mode
return SobekCM.Core.Navigation.Navigation_Object

Current_User public_oe property

Currently logged on user
public User_Object,SobekCM.Core.Users Current_User
return SobekCM.Core.Users.User_Object

Paged_Results public_oe property

Single page of results for a search or browse, within the entire set
public List Paged_Results
return List

Public_Folder public_oe property

Object contains the information about the public folder to display
public Public_User_Folder Public_Folder
return Public_User_Folder

Results_Statistics public_oe property

Information about the entire set of results for a search or browse
public Search_Results_Statistics Results_Statistics
return Search_Results_Statistics

Top_Collection public_oe property

Item aggregation for the top-level collection, which is used in a number of places, for example showing the correct banner, even when it is not the "current" aggregation
public Item_Aggregation Top_Collection
return Item_Aggregation

Tracer public_oe property

Trace object keeps a list of each method executed and important milestones in rendering
public Custom_Tracer Tracer
return Custom_Tracer