C# Class SobekCM.Core.Aggregations.Complete_Item_Aggregation

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

Private Properties

Property	Type	Description

Public Methods

Method	Description
Add_Banner_Image ( string Banner_Image, Web_Language_Enum Language ) : void	Add the main banner image for this aggregation, by language
Add_Child_Aggregation ( Item_Aggregation_Related_Aggregations Child_Aggregation ) : void	Method adds another aggregation as a child of this
Add_Child_Page ( Item_Aggregation_Child_Visibility_Enum Browse_Type, string Browse_Code, string StaticHtmlSource, string Text ) : Complete_Item_Aggregation_Child_Page	Add a new browse or info object to this hierarchical object
Add_Child_Page ( Complete_Item_Aggregation_Child_Page ChildPage ) : void	Add a child page to this item aggregatiion
Add_Facet ( short New_Facet_ID ) : void	Adds a single facet type, by primary key, to this item aggregation's browse and search result pages
Add_Front_Banner_Image ( SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner Banner, Web_Language_Enum Language ) : SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner	Add the special front banner image that displays on the home page only for this aggregation, by language
Add_Front_Banner_Image ( string Banner_Image, Web_Language_Enum Language ) : SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner	Add the special front banner image that displays on the home page only for this aggregation, by language
Add_Home_Page_File ( string Home_Page_File, Web_Language_Enum Language, bool isCustomHome ) : void	Add the home page source file information, by language
Add_Parent_Aggregation ( Item_Aggregation_Related_Aggregations Parent_Aggregation ) : void	Method adds another aggregation as a parent to this
Add_Setting ( string Key, string Value ) : void	Add a key/value pair setting to this aggregation If a value already exists for the provided key, the value will be changed to the new value provided to this method.
Add_Web_Skin ( string Web_Skin ) : void	Add a web skin which this aggregation can appear under
Banner_Image ( Web_Language_Enum Language, Web_Skin_Object ThisWebSkin ) : string	Gets the banner image for this aggregation, by language If NO banner images were included in the aggregation XML, then this could be the empty string. If the provided web skin overrides the banner, then use that web skin's banner.
Browse_By_Pages ( Web_Language_Enum Current_Language ) : ReadOnlyCollection	Read-only list of all the browse objects to appear under the BROWSE BY attached to this item aggregation These are returned in alphabetical order of the CODE portion of each browse, according to the provided language
Browse_Home_Pages ( Web_Language_Enum Current_Language ) : ReadOnlyCollection	Read-only list of all the browse objects to appear on the home page attached to this item aggregation These are returned in alphabetical order of the LABEL portion of each browse, according to the provided language
Child_Page_By_Code ( string ChildCode ) : Complete_Item_Aggregation_Child_Page	Get a child page by code
Clear_Banners ( ) : void	Clear the list of banners, by language
Clear_Facets ( ) : void	Clears all the facets in this item aggregation
Complete_Item_Aggregation ( ) : System	Constructor for a new instance of the Item_Aggregation_Complete class
Complete_Item_Aggregation ( Web_Language_Enum Default_UI_Language ) : System	Constructor for a new instance of the Item_Aggregation_Complete class
Complete_Item_Aggregation ( Web_Language_Enum Default_UI_Language, string Code, string Type, int ID, string Display_Options, System.DateTime Last_Item_Added ) : System	Constructor for a new instance of the Item_Aggregation_Complete class
Contains_Browse_Info ( string Browse_Code ) : bool	Checks to see if a particular browse code exists in the list of browses or infos for this item aggregation
Delete_Home_Page ( Web_Language_Enum Language ) : void	Removes a single home page from the collection of home pages
Front_Banner_Image ( Web_Language_Enum Language ) : SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner	Gets the special front banner image for this aggregation's home page, by language If NO special front banner images were included in the aggregation XML, then this could be NULL. This is a special front banner image used for aggregationPermissions that show the highlighted item and the search box in the main banner at the top on the front page
Get_Browse_Info_Object ( string SubMode ) : Complete_Item_Aggregation_Child_Page	Gets the browse or info object from this hierarchy
Get_Setting ( string Key ) : string	Gets a setting value, by key
Home_Page_File ( Web_Language_Enum Language ) : Complete_Item_Aggregation_Home_Page	Gets the home page source file for this aggregation, by language If NO home page files were included in the aggregation XML, then this could be the empty string.
Remove_Child ( string AggregationCode ) : void	Removes a child from this collection, by aggregation code
Remove_Child_Page ( Complete_Item_Aggregation_Child_Page Browse_Page ) : void	Remove an existing browse or info object from this item aggregation
Remove_Child_Page ( string Browse_Page_Code ) : void	Remove an existing browse or info object from this item aggregation
Write_Configuration_File ( string Directory ) : bool	Write the XML configuration file for this item aggregation

Method Details

Add_Banner_Image() public method

Add the main banner image for this aggregation, by language

public Add_Banner_Image ( string Banner_Image, Web_Language_Enum Language ) : void
Banner_Image	string	Main banner image source file for this aggregation
Language	Web_Language_Enum	Language code
return	void

Add_Child_Aggregation() public method

Method adds another aggregation as a child of this

public Add_Child_Aggregation ( Item_Aggregation_Related_Aggregations Child_Aggregation ) : void
Child_Aggregation	Item_Aggregation_Related_Aggregations	New child aggregation
return	void

Add_Child_Page() public method

Add a new browse or info object to this hierarchical object

public Add_Child_Page ( Item_Aggregation_Child_Visibility_Enum Browse_Type, string Browse_Code, string StaticHtmlSource, string Text ) : Complete_Item_Aggregation_Child_Page
Browse_Type	Item_Aggregation_Child_Visibility_Enum	Flag indicates if this is a BROWSE or INFO object
Browse_Code	string	SubMode indicator for this object
StaticHtmlSource	string	Any static HTML source to be used for display
Text	string	Text to display for this browse
return	Complete_Item_Aggregation_Child_Page

Add_Child_Page() public method

Add a child page to this item aggregatiion

public Add_Child_Page ( Complete_Item_Aggregation_Child_Page ChildPage ) : void
ChildPage	Complete_Item_Aggregation_Child_Page	New child page to add
return	void

Add_Facet() public method

Adds a single facet type, by primary key, to this item aggregation's browse and search result pages

public Add_Facet ( short New_Facet_ID ) : void
New_Facet_ID	short	Primary key for the metadata type to include as a facet
return	void

Add_Front_Banner_Image() public method

Add the special front banner image that displays on the home page only for this aggregation, by language

public Add_Front_Banner_Image ( SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner Banner, Web_Language_Enum Language ) : SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner
Banner	SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner	special front banner image source file for this aggregation
Language	Web_Language_Enum	Language code
return	SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner

Add_Front_Banner_Image() public method

Add the special front banner image that displays on the home page only for this aggregation, by language

public Add_Front_Banner_Image ( string Banner_Image, Web_Language_Enum Language ) : SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner
Banner_Image	string	special front banner image source file for this aggregation
Language	Web_Language_Enum	Language code
return	SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner

Add_Home_Page_File() public method

Add the home page source file information, by language

public Add_Home_Page_File ( string Home_Page_File, Web_Language_Enum Language, bool isCustomHome ) : void
Home_Page_File	string	Home page text source file
Language	Web_Language_Enum	Language code
isCustomHome	bool	Flag indicates if this is a custom home page, which will /// override all other home page writing methods, and control the rendered page /// from the top to the bottom
return	void

Add_Parent_Aggregation() public method

Method adds another aggregation as a parent to this

public Add_Parent_Aggregation ( Item_Aggregation_Related_Aggregations Parent_Aggregation ) : void
Parent_Aggregation	Item_Aggregation_Related_Aggregations	New parent aggregation
return	void

Add_Setting() public method

Add a key/value pair setting to this aggregation

If a value already exists for the provided key, the value will be changed to the new value provided to this method.

public Add_Setting ( string Key, string Value ) : void
Key	string	Key for this setting
Value	string	Value for this setting
return	void

Add_Web_Skin() public method

Add a web skin which this aggregation can appear under

public Add_Web_Skin ( string Web_Skin ) : void
Web_Skin	string	Web skin this can appear under
return	void

Banner_Image() public method

Gets the banner image for this aggregation, by language

If NO banner images were included in the aggregation XML, then this could be the empty string.

If the provided web skin overrides the banner, then use that web skin's banner.

public Banner_Image ( Web_Language_Enum Language, Web_Skin_Object ThisWebSkin ) : string
Language	Web_Language_Enum	Language code
ThisWebSkin	SobekCM.Core.Skins.Web_Skin_Object	Web skin object which may override the banner
return	string

Browse_By_Pages() public method

Read-only list of all the browse objects to appear under the BROWSE BY attached to this item aggregation

These are returned in alphabetical order of the CODE portion of each browse, according to the provided language

public Browse_By_Pages ( Web_Language_Enum Current_Language ) : ReadOnlyCollection
Current_Language	Web_Language_Enum	Current language used to sort the browses by the label
return	ReadOnlyCollection

Browse_Home_Pages() public method

Read-only list of all the browse objects to appear on the home page attached to this item aggregation

These are returned in alphabetical order of the LABEL portion of each browse, according to the provided language

public Browse_Home_Pages ( Web_Language_Enum Current_Language ) : ReadOnlyCollection
Current_Language	Web_Language_Enum	Current language used to sort the browses by the label
return	ReadOnlyCollection

Child_Page_By_Code() public method

Get a child page by code

public Child_Page_By_Code ( string ChildCode ) : Complete_Item_Aggregation_Child_Page
ChildCode	string	Code for this child page
return	Complete_Item_Aggregation_Child_Page

Clear_Banners() public method

Clear the list of banners, by language

public Clear_Banners ( ) : void
return	void

Clear_Facets() public method

Clears all the facets in this item aggregation

public Clear_Facets ( ) : void
return	void

Complete_Item_Aggregation() public method

Constructor for a new instance of the Item_Aggregation_Complete class

public Complete_Item_Aggregation ( ) : System
return	System

Complete_Item_Aggregation() public method

Constructor for a new instance of the Item_Aggregation_Complete class

public Complete_Item_Aggregation ( Web_Language_Enum Default_UI_Language ) : System
Default_UI_Language	Web_Language_Enum	Default user interface language for this interface
return	System

Complete_Item_Aggregation() public method

Constructor for a new instance of the Item_Aggregation_Complete class

public Complete_Item_Aggregation ( Web_Language_Enum Default_UI_Language, string Code, string Type, int ID, string Display_Options, System.DateTime Last_Item_Added ) : System
Default_UI_Language	Web_Language_Enum	Default user interface language for this interface
Code	string	Unique code for this item aggregation object
Type	string	Type of aggregation object (i.e., collection, institution, exhibit, etc..)
ID	int	ID for this aggregation object from the database
Display_Options	string	Display options used to determine the views and searches for this item
Last_Item_Added	System.DateTime	Date the last item was added ( or 1/1/2000 by default )
return	System

Contains_Browse_Info() public method

Checks to see if a particular browse code exists in the list of browses or infos for this item aggregation

public Contains_Browse_Info ( string Browse_Code ) : bool
Browse_Code	string	Code for the browse or info to check for existence
return	bool

Delete_Home_Page() public method

Removes a single home page from the collection of home pages

public Delete_Home_Page ( Web_Language_Enum Language ) : void
Language	Web_Language_Enum	Language of the home page to remove
return	void

Front_Banner_Image() public method

Gets the special front banner image for this aggregation's home page, by language

If NO special front banner images were included in the aggregation XML, then this could be NULL.

This is a special front banner image used for aggregationPermissions that show the highlighted item and the search box in the main banner at the top on the front page

public Front_Banner_Image ( Web_Language_Enum Language ) : SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner
Language	Web_Language_Enum	Language code
return	SobekCM.Core.Aggregations.Item_Aggregation_Front_Banner

Get_Browse_Info_Object() public method

Gets the browse or info object from this hierarchy

public Get_Browse_Info_Object ( string SubMode ) : Complete_Item_Aggregation_Child_Page
SubMode	string	Submode for the browse being requested
return	Complete_Item_Aggregation_Child_Page

Get_Setting() public method

Gets a setting value, by key

public Get_Setting ( string Key ) : string
Key	string	Key to look for a match from the settings key/value pairs
return	string

Home_Page_File() public method

Gets the home page source file for this aggregation, by language

If NO home page files were included in the aggregation XML, then this could be the empty string.

public Home_Page_File ( Web_Language_Enum Language ) : Complete_Item_Aggregation_Home_Page
Language	Web_Language_Enum	Language code
return	Complete_Item_Aggregation_Home_Page

Remove_Child() public method

Removes a child from this collection, by aggregation code

public Remove_Child ( string AggregationCode ) : void
AggregationCode	string	Code of the child to remove
return	void

Remove_Child_Page() public method

Remove an existing browse or info object from this item aggregation

public Remove_Child_Page ( Complete_Item_Aggregation_Child_Page Browse_Page ) : void
Browse_Page	Complete_Item_Aggregation_Child_Page	Child page information to remove
return	void

Remove_Child_Page() public method

Remove an existing browse or info object from this item aggregation

public Remove_Child_Page ( string Browse_Page_Code ) : void
Browse_Page_Code	string	Child page information to remove
return	void

Write_Configuration_File() public method

Write the XML configuration file for this item aggregation

public Write_Configuration_File ( string Directory ) : bool
Directory	string	Directory within which to write this XML configuration file
return	bool