C# Class SobekCM.Core.ApplicationState.Aggregation_Code_Manager

Inheritance: iSerializationEvents

ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
Add_Blank_Thematic_Heading ( int NewThematicHeadingID ) : void	Adds a new blank thematic heading when a user adds one through the administrative tools
Add_Collection ( Item_Aggregation_Related_Aggregations New_Aggregation ) : void	Add the basic information about an aggregation to this aggreation manager
Aggregation_By_ID ( int AggregationID ) : Item_Aggregation_Related_Aggregations	Gets the aggregation by primary key This is not particularly a quick way to do this, since it just loops through all the aggregations, without utilizing a dictionary for lookup.
Aggregation_Code_Manager ( ) : System	Constructor for a new instance of the Aggregation_Code_Manager class
Aggregations_By_ThemeID ( int ThemeID ) : ReadOnlyCollection	Read-only collection of item aggregationPermissions matching a particular thematic heading id
Aggregations_By_Type ( string AggregationType ) : ReadOnlyCollection	Read-only collection of item aggregationPermissions matching a particular aggregation type
Clear ( ) : void	Clears the internal data for this code manager
Get_Collection_Short_Name ( string Aggregation_Code ) : string	Gets the short name associated with a provided aggregation code
PostUnSerialization ( ) : void	Method is called by the serializer after this item is unserialized
Set_Aggregation_Thematic_Heading ( string Code, int ThematicHeadingID ) : void	Set an aggregation to be a part of an existing thematic heading id
isValidCode ( string Aggregation_Code ) : bool	Checks to see if an aggregation code exists
this ( string Aggregation_Code ) : Item_Aggregation_Related_Aggregations	Gets the aggregation information by aggregation code

Method Details

Add_Blank_Thematic_Heading() public method

Adds a new blank thematic heading when a user adds one through the administrative tools

public Add_Blank_Thematic_Heading ( int NewThematicHeadingID ) : void
NewThematicHeadingID	int	ID for the new thematic heading
return	void

Add_Collection() public method

Add the basic information about an aggregation to this aggreation manager

public Add_Collection ( Item_Aggregation_Related_Aggregations New_Aggregation ) : void
New_Aggregation	Item_Aggregation_Related_Aggregations	New aggregation to add information about
return	void

Aggregation_By_ID() public method

Gets the aggregation by primary key

This is not particularly a quick way to do this, since it just loops through all the aggregations, without utilizing a dictionary for lookup.

public Aggregation_By_ID ( int AggregationID ) : Item_Aggregation_Related_Aggregations
AggregationID	int	Aggregation ID for the aggregation to get
return	Item_Aggregation_Related_Aggregations

Aggregation_Code_Manager() public method

Constructor for a new instance of the Aggregation_Code_Manager class

public Aggregation_Code_Manager ( ) : System
return	System

Aggregations_By_ThemeID() public method

Read-only collection of item aggregationPermissions matching a particular thematic heading id

public Aggregations_By_ThemeID ( int ThemeID ) : ReadOnlyCollection
ThemeID	int	Primary key for the thematic heading to pull
return	ReadOnlyCollection

Aggregations_By_Type() public method

Read-only collection of item aggregationPermissions matching a particular aggregation type

public Aggregations_By_Type ( string AggregationType ) : ReadOnlyCollection
AggregationType	string	Type of aggregationPermissions to return
return	ReadOnlyCollection

Clear() public method

Clears the internal data for this code manager

public Clear ( ) : void
return	void

Get_Collection_Short_Name() public method

Gets the short name associated with a provided aggregation code

public Get_Collection_Short_Name ( string Aggregation_Code ) : string
Aggregation_Code	string	Code for the aggregation of interest
return	string

PostUnSerialization() public method

Method is called by the serializer after this item is unserialized

public PostUnSerialization ( ) : void
return	void

Set_Aggregation_Thematic_Heading() public method

Set an aggregation to be a part of an existing thematic heading id

public Set_Aggregation_Thematic_Heading ( string Code, int ThematicHeadingID ) : void
Code	string
ThematicHeadingID	int
return	void

isValidCode() public method

Checks to see if an aggregation code exists

public isValidCode ( string Aggregation_Code ) : bool
Aggregation_Code	string	Code for the aggregation of interest
return	bool

this() public method

Gets the aggregation information by aggregation code

public this ( string Aggregation_Code ) : Item_Aggregation_Related_Aggregations
Aggregation_Code	string	Code for the aggregation of interest
return	Item_Aggregation_Related_Aggregations