C# Class SobekCM.Engine_Library.Endpoints.AggregationServices

Class supports all the aggregation-level services provided by the SobekCM engine
Inheritance: EndpointBase
Show file Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
GetAggregationByCode ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the language-specific item aggregation, by aggregation code and language code
GetAggregationUploadedImages ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

[PUBLIC] Get the list of uploaded images for a particular aggregation

This REST API should be publicly available for users that are performing administrative work

GetAllAggregations ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the list of all aggregations - including inactive and hidden
GetCollectionHierarchy ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the entire collection hierarchy (used for hierarchical tree displays)
GetCollectionStaticPage ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the all information, including the HTML, for an item aggregation child page
GetCompleteAggregationByCode ( HttpResponse Response, List UrlSegments, NameValueCollection QueryString, Microservice_Endpoint_Protocol_Enum Protocol, bool IsDebug ) : void

Gets the complete (language agnostic) item aggregation, by aggregation code
add_new_aggregation ( SobekCM.Core.Aggregations.New_Aggregation_Arguments NewAggregation ) : SobekCM.Core.Message.RestResponseMessage

Add a new aggregation to the system
get_aggregation_hierarchy ( Custom_Tracer Tracer ) : SobekCM.Core.Aggregations.Aggregation_Hierarchy

[HELPER] Gets the entire collection hierarchy (used for hierarchical tree displays)

This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0

get_complete_aggregation ( string AggregationCode, bool UseCache, Custom_Tracer Tracer ) : Complete_Item_Aggregation

[HELPER] Gets the complete (language agnostic) item aggregation, by aggregation code

This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0

get_item_aggregation ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, Custom_Tracer Tracer ) : Item_Aggregation

[HELPER] Gets the language-specific item aggregation, by aggregation code and language code

This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0

get_item_aggregation_html_child_page ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, string ChildPageCode, Custom_Tracer Tracer ) : HTML_Based_Content

[HELPER] Gets the all information, including the HTML, for an item aggregation child page

This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0

Method Details

GetAggregationByCode() public method

Gets the language-specific item aggregation, by aggregation code and language code
public GetAggregationByCode ( 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

GetAggregationUploadedImages() public method

[PUBLIC] Get the list of uploaded images for a particular aggregation
This REST API should be publicly available for users that are performing administrative work
public GetAggregationUploadedImages ( 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

GetAllAggregations() public method

Gets the list of all aggregations - including inactive and hidden
public GetAllAggregations ( 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

GetCollectionHierarchy() public method

Gets the entire collection hierarchy (used for hierarchical tree displays)
public GetCollectionHierarchy ( 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

GetCollectionStaticPage() public method

Gets the all information, including the HTML, for an item aggregation child page
public GetCollectionStaticPage ( 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

GetCompleteAggregationByCode() public method

Gets the complete (language agnostic) item aggregation, by aggregation code
public GetCompleteAggregationByCode ( 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

add_new_aggregation() public static method

Add a new aggregation to the system
public static add_new_aggregation ( SobekCM.Core.Aggregations.New_Aggregation_Arguments NewAggregation ) : SobekCM.Core.Message.RestResponseMessage
NewAggregation SobekCM.Core.Aggregations.New_Aggregation_Arguments Information for the new aggregation
return SobekCM.Core.Message.RestResponseMessage

get_aggregation_hierarchy() public static method

[HELPER] Gets the entire collection hierarchy (used for hierarchical tree displays)
This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0
public static get_aggregation_hierarchy ( Custom_Tracer Tracer ) : SobekCM.Core.Aggregations.Aggregation_Hierarchy
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Aggregations.Aggregation_Hierarchy

get_complete_aggregation() public static method

[HELPER] Gets the complete (language agnostic) item aggregation, by aggregation code
This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0
public static get_complete_aggregation ( string AggregationCode, bool UseCache, Custom_Tracer Tracer ) : Complete_Item_Aggregation
AggregationCode string Code the requested aggregation
UseCache bool Flag indicates if the cache should be checed and used to store the final product
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Aggregations.Complete_Item_Aggregation

get_item_aggregation() public static method

[HELPER] Gets the language-specific item aggregation, by aggregation code and language code
This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0
public static get_item_aggregation ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, Custom_Tracer Tracer ) : Item_Aggregation
AggregationCode string Code for the aggregation
RequestedLanguage Web_Language_Enum Requested language to retrieve
DefaultLanguage Web_Language_Enum Default interface language, in case the requested language does not exist
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Aggregations.Item_Aggregation

get_item_aggregation_html_child_page() public static method

[HELPER] Gets the all information, including the HTML, for an item aggregation child page
This may be public now, but this will be converted into a private helped class with the release of SobekCM 5.0
public static get_item_aggregation_html_child_page ( string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, string ChildPageCode, Custom_Tracer Tracer ) : HTML_Based_Content
AggregationCode string Code for the aggregation
RequestedLanguage Web_Language_Enum Requested language to retrieve
DefaultLanguage Web_Language_Enum Default interface language, in case the requested language does not exist
ChildPageCode string Code the requested child page
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.WebContent.HTML_Based_Content