mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
Expand <a href='https://sobekrepository.org/codehelp/engineagnosticlayerdbaccess' title='EngineAgnosticLayerDbAccess'>EngineAgnosticLayerDbAccess Namespace</a>EngineAgnosticLayerDbAccess Namespace
Expand <a href='https://sobekrepository.org/codehelp/builder_library' title='SobekCM.Builder_Library'>Builder_Library Namespace</a>Builder_Library Namespace
Collapse <a href='https://sobekrepository.org/codehelp/core' title='SobekCM.Core'>Core Namespace</a>Core Namespace
Expand <a href='https://sobekrepository.org/codehelp/engine_library' title='SobekCM.Engine_Library'>Engine_Library Namespace</a>Engine_Library Namespace
Expand <a href='https://sobekrepository.org/codehelp/library' title='SobekCM.Library'>Library Namespace</a>Library Namespace
Expand <a href='https://sobekrepository.org/codehelp/resource_object' title='SobekCM.Resource_Object'>Resource_Object Namespace</a>Resource_Object Namespace
Expand <a href='https://sobekrepository.org/codehelp/tools' title='SobekCM.Tools'>Tools Namespace</a>Tools Namespace
MISSING BANNER
Code Details >> Core >> Aggregations >> Complete_Item_Aggregation

Complete_Item_Aggregation Class



Contains all of the data about a single aggregation of items, such as a collection or institutional items. This class indicates to SobekCM where to look for searches, browses, and information. It also contains all the information for rendering the home pages of each of these levels.


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

Syntax

C#
[SerializableAttribute]
[DataContractAttribute]
[ProtoContractAttribute]
public class Complete_Item_Aggregation

Inheritance Hierarchy

System..::..Object
  SobekCM.Core.Aggregations..::..Complete_Item_Aggregation

Constructors

  NameDescription
Public methodComplete_Item_Aggregation()()()()
Constructor for a new instance of the Item_Aggregation_Complete class
Public methodComplete_Item_Aggregation(Web_Language_Enum)
Constructor for a new instance of the Item_Aggregation_Complete class
Public methodComplete_Item_Aggregation(Web_Language_Enum, String, String, Int32, String, DateTime)
Constructor for a new instance of the Item_Aggregation_Complete class

Methods

  NameDescription
Public methodAdd_Banner_Image
Add the main banner image for this aggregation, by language
Public methodAdd_Child_Aggregation
Method adds another aggregation as a child of this
Public methodAdd_Child_Page(Complete_Item_Aggregation_Child_Page)
Add a child page to this item aggregatiion
Public methodAdd_Child_Page(Item_Aggregation_Child_Visibility_Enum, String, String, String)
Add a new browse or info object to this hierarchical object
Public methodAdd_Facet
Adds a single facet type, by primary key, to this item aggregation's browse and search result pages
Public methodAdd_Front_Banner_Image(String, Web_Language_Enum)
Add the special front banner image that displays on the home page only for this aggregation, by language
Public methodAdd_Front_Banner_Image(Item_Aggregation_Front_Banner, Web_Language_Enum)
Add the special front banner image that displays on the home page only for this aggregation, by language
Public methodAdd_Home_Page_File
Add the home page source file information, by language
Public methodAdd_Parent_Aggregation
Method adds another aggregation as a parent to this
Public methodAdd_Web_Skin
Add a web skin which this aggregation can appear under
Public methodBanner_Image
Gets the banner image for this aggregation, by language
Public methodBrowse_By_Pages
Read-only list of all the browse objects to appear under the BROWSE BY attached to this item aggregation
Public methodBrowse_Home_Pages
Read-only list of all the browse objects to appear on the home page attached to this item aggregation
Public methodChild_Page_By_Code
Get a child page by code
Public methodClear_Banners
Clear the list of banners, by language
Public methodClear_Facets
Clears all the facets in this item aggregation
Public methodContains_Browse_Info
Checks to see if a particular browse code exists in the list of browses or infos for this item aggregation
Public methodDelete_Home_Page
Removes a single home page from the collection of home pages
Public methodFront_Banner_Image
Gets the special front banner image for this aggregation's home page, by language
Public methodGet_Browse_Info_Object
Gets the browse or info object from this hierarchy
Public methodHome_Page_File
Gets the home page source file for this aggregation, by language
Public methodRemove_Child
Removes a child from this collection, by aggregation code
Public methodRemove_Child_Page(String)
Remove an existing browse or info object from this item aggregation
Public methodRemove_Child_Page(Complete_Item_Aggregation_Child_Page)
Remove an existing browse or info object from this item aggregation
Public methodWrite_Configuration_File
Write the XML configuration file for this item aggregation

Properties

  NameDescription
Public propertyActive
Flag indicating this item aggregation is active
Public propertyActive_Children_Count
Gets the number of child item aggregationPermissions present
Public propertyBanner_Dictionary
Get the standard banner dictionary, by language
Public propertyBrowse_Info_Count
Gets the number of browses and info pages attached to this item aggregation
Public propertyBrowseable_Fields
Returns the list of the primary identifiers for all metadata fields which have data and thus could appear in the metadata browse
Public propertyCan_Browse_Items
Flag indicates if this aggregation can potentially include the ALL ITEMS and NEW ITEMS tabs
Public propertyChild_Pages
Collection of all child pages
Public propertyChild_Types
The common type of all child collections, or the default
Public propertyChildren
Gets the read-only collection of children item aggregation objects
Public propertyChildren_Count
Gets the number of child item aggregationPermissions present
Public propertyCode
Code for this item aggregation object
Public propertyContact_Email
Contact email for any correspondance regarding this item aggregation
Public propertyContactForm
Any aggregation-specific contact form configuration, otherwise NULL
Public propertyCSS_File
Aggregation-level CSS file, if one exists
Public propertyCustom_Directives
Gets the list of custom directives (which function like Server-Side Includes) for this item aggregation
Public propertyDefault_BrowseBy
Default browse by code, if no code is provided in the request
Public propertyDefault_Result_View
Gets the default results view mode for this item aggregation
Public propertyDefault_Skin
Default interface to be used for this item aggregation
Public propertyDescription
Description of this item aggregation (in the default language )
Public propertyDisplay_Options
Display options string for this item aggregation
Public propertyExternal_Link
External link associated with this item aggregation
Public propertyFacets
Returns the list of all facets to display during searches and browses within this aggregation
Public propertyFront_Banner_Dictionary
Get the front banner dictionary, by language
Public propertyHas_Browse_By_Pages
Flag indicates if this item aggregation has at least one BROWSE BY page to display
Public propertyHas_New_Items
Flag indicates if new items have recently been added to this collection which requires additional collection-level work
Public propertyHidden
Flag indicating this item aggregation is hidden from most displays
Public propertyHighlights
Gets the list of highlights associated with this item
Public propertyHome_Page_File_Dictionary
Gets the raw home page source file
Public propertyID
ID for this item aggregation object
Public propertyInfo_Pages
Read-only list of all the info objects attached to this item aggregation
Public propertyItems_Can_Be_Described
Flag indicates whether items linked to this item can be described by logged in users
Public propertyLanguage_Variants
Get the list of different language variants available
Public propertyLast_Item_Added
Date the last item was added to this collection
Public propertyLoad_Email
Email address to receive notifications when items load under this aggregation
Public propertyMap_Browse_Display
Default map display information ( i.e., center and zoom of map ) for doing a map browse within the aggregation
Public propertyMap_Display_Beta
Flag that tells what type of map display to show for this item aggregation
Public propertyMap_Search_Beta
Flag that tells what type of map searching to allow for this item aggregation
Public propertyMap_Search_Display
Default map display information ( i.e., center and zoom of map ) for doing a map search within the aggregation
Public propertyName
Full name of this item aggregation
Public propertyOAI_Enabled
Flag indicates whether this item aggregation should be made available via OAI-PMH
Public propertyOAI_Metadata
Additional metadata for this item aggregation to be included when providing the list of OAI-PMH sets
Public propertyObjDirectory
Directory where all design information for this object is found
Public propertyParent_Codes
Returns the list of all parent codes to this aggregation, seperate by a semi-colon
Public propertyParent_Count
Gets the number of parent item aggregationPermissions present
Public propertyParents
Gets the read-only collection of parent item aggregation objects
Public propertyResult_Views
Gets the list of all result views present in this item aggregation
Public propertyRotating_Highlights
Value indicates if the highlights should be rotating through a number of highlights, or be fixed on a single highlight
Public propertySearch_Fields
Returns the list of the primary identifiers for all metadata fields which have data and thus should appear in the advanced search drop downs
Public propertySearch_Types
Read-only list of searches types for this item aggregation
Public propertyShortName
Short name of this item aggregation
Public propertyShow_New_Item_Browse
Flag indicates if this aggregation has had any changes over the last two weeks
Public propertyStatistics
Statistical information about this aggregation ( i.e., item, title, and page count )
Public propertyThematic_Heading
Key to the thematic heading under which this aggregation should appear on the main home page
Public propertyType
Type of item aggregation object
Public propertyViews_And_Searches
Read-only list of collection views and searches for this item aggregation
Public propertyWeb_Skins
Gets the list of web skins this aggregation can appear under

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )