C# Class SobekCM.Resource_Object.Behaviors.Behaviors_Info

Inheritance: XML_Writing_Base_Type

Mostrar archivo Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method	Description
Add_Aggregation ( string Code ) : void	Adds an aggregation, if it doesn't exist This parses the aggregation string for spaces, commas, and semicolons.
Add_Aggregation ( string Code, string Name ) : void	Adds an aggregation, if it doesn't exist This parses the aggregation string for spaces, commas, and semicolons.
Add_Aggregation ( string Code, string Name, string Type ) : void	Adds an aggregation, if it doesn't exist This parses the aggregation string for spaces, commas, and semicolons.
Add_Tickler ( string Tickler ) : void	Clear all the ticklers associated with this item
Add_User_Tag ( int UserID, string UserName, string Description_Tag, System.DateTime Date_Added, int TagID ) : void	Add a new user tag to this item
Add_View ( string View_Type ) : View_Object	Add a new SobekCM View to this resource
Add_View ( string View_Type, string Label, string Attributes ) : View_Object	Add a new SobekCM View to this resource
Add_View ( string View_Type, string Label, string Attributes, float MenuOrder, bool Exclude ) : View_Object	Add a new SobekCM View to this resource
Add_View ( View_Object New_View ) : void	Add a new SobekCM View to this resource
Add_Web_Skin ( string New_Web_Skin ) : void	Add a new web skin code to this item
Add_Wordmark ( Wordmark_Info Wordmark ) : void	Adds a wordmark/icon, if it doesn't exist
Add_Wordmark ( string Wordmark ) : void	Adds a wordmark/icon, if it doesn't exist
Add_Wordmarks ( string Wordmark ) : void	Adds a wordmark/icon, if it doesn't exist This parses the wordmark string for spaces, commas, and semicolons.
Behaviors_Info ( ) : System	Constructor for a new instance of the Behaviors_Info class
Clear_Aggregations ( ) : void	Clear all of the aggregations associated with this item
Clear_Ticklers ( ) : void	Clear all the ticklers associated with this item
Clear_Views ( ) : void	Clear all the pre-existing views from this item
Clear_Web_Skins ( ) : void	Clear all the pre-existing web skins from this item
Clear_Wordmarks ( ) : void	Clears all the icon/wordmarks associated with this item
Dedupe_Wordmarks ( ) : void	Dedupes the wordmarks to ensure that no duplication is occurring Saving duped wordmarks to the database can result in a database exception during the save process
Delete_User_Tag ( int TagID, int UserID ) : bool	Delete a user tag from this object, by TagID and UserID This only deletes the user tag if the UserID for the tag matches the provided userid
Insert_View ( int Index, string View_Type ) : View_Object	Add a new SobekCM View to this resource
Insert_View ( int Index, string View_Type, string Label, string Attributes ) : View_Object	Add a new SobekCM View to this resource
Set_Primary_Identifier ( string Type, string Identifier ) : void	Sets the type and identifier for the primary alternate identifier associated with this item group
Set_Private ( ) : void	Makes this item private in the behaviorSec, which results in a VisibilityRestrictions tag of -1 in the procParam of the resulting METS
Set_Public ( ) : void	Makes this item public in the behaviorSec, which results in a VisibilityRestrictions tag of zero in the procParam of the resulting METS
Set_Serial_Info ( SobekCM.Resource_Object.Behaviors.Serial_Info SerialInfo ) : void	Saves the data stored in this instance of the element to the provided bibliographic object

Private Methods

Method	Description
Add_BehaviorSec_METS ( TextWriter BehaviorSec, bool PackageIncludesImageFiles ) : void	Returns the METS behavior section associated with this resource
Add_METS_Processing_Metadata ( string Sobek_Namespace, TextWriter Results ) : void	Returns the METS formatted XML for all the processing parameters for SobekCM
Calculate_GUID ( string BibID, string License ) : void
ToMETS ( string METS_Tag, string METS_Value ) : string	Returns a single value in METS formatted XML

Method Details

Add_Aggregation() public method

Adds an aggregation, if it doesn't exist

This parses the aggregation string for spaces, commas, and semicolons.

public Add_Aggregation ( string Code ) : void
Code	string	Aggregation code to add
return	void

Add_Aggregation() public method

Adds an aggregation, if it doesn't exist

This parses the aggregation string for spaces, commas, and semicolons.

public Add_Aggregation ( string Code, string Name ) : void
Code	string	Aggregation code to add
Name	string	Aggregation name to add
return	void

Add_Aggregation() public method

Adds an aggregation, if it doesn't exist

This parses the aggregation string for spaces, commas, and semicolons.

public Add_Aggregation ( string Code, string Name, string Type ) : void
Code	string	Aggregation code to add
Name	string	Aggregation name to add
Type	string	Aggregation type
return	void

Add_Tickler() public method

Clear all the ticklers associated with this item

public Add_Tickler ( string Tickler ) : void
Tickler	string	New tickler to add to this item
return	void

Add_User_Tag() public method

Add a new user tag to this item

public Add_User_Tag ( int UserID, string UserName, string Description_Tag, System.DateTime Date_Added, int TagID ) : void
UserID	int	Primary key for the user who entered this tag
UserName	string	Name of the user ( Last Name, Firt Name )
Description_Tag	string	Text of the user-entered descriptive tag
Date_Added	System.DateTime	Date the tag was added or last modified
TagID	int	Primary key for this tag from the database
return	void

Add_View() public method

Add a new SobekCM View to this resource

public Add_View ( string View_Type ) : View_Object
View_Type	string	Standard type of SobekCM View
return	View_Object

Add_View() public method

Add a new SobekCM View to this resource

public Add_View ( string View_Type, string Label, string Attributes ) : View_Object
View_Type	string	Standard type of SobekCM View
Label	string	Label for this SobekCM View
Attributes	string	Any additional attribures needed for thie SobekCM View
return	View_Object

Add_View() public method

Add a new SobekCM View to this resource

public Add_View ( string View_Type, string Label, string Attributes, float MenuOrder, bool Exclude ) : View_Object
View_Type	string	Standard type of SobekCM View
Label	string	Label for this SobekCM View
Attributes	string	Any additional attribures needed for thie SobekCM View
MenuOrder	float	order where this sits on the item main menu
Exclude	bool
return	View_Object

Add_View() public method

Add a new SobekCM View to this resource

public Add_View ( View_Object New_View ) : void
New_View	View_Object	SobekCM View object
return	void

Add_Web_Skin() public method

Add a new web skin code to this item

public Add_Web_Skin ( string New_Web_Skin ) : void
New_Web_Skin	string	New web skin code
return	void

Add_Wordmark() public method

Adds a wordmark/icon, if it doesn't exist

public Add_Wordmark ( Wordmark_Info Wordmark ) : void
Wordmark	Wordmark_Info	Wordmark code to add
return	void

Add_Wordmark() public method

Adds a wordmark/icon, if it doesn't exist

public Add_Wordmark ( string Wordmark ) : void
Wordmark	string	Wordmark code to add
return	void

Add_Wordmarks() public method

Adds a wordmark/icon, if it doesn't exist

This parses the wordmark string for spaces, commas, and semicolons.

public Add_Wordmarks ( string Wordmark ) : void
Wordmark	string	Wordmark code to add
return	void

Behaviors_Info() public method

Constructor for a new instance of the Behaviors_Info class

public Behaviors_Info ( ) : System
return	System

Clear_Aggregations() public method

Clear all of the aggregations associated with this item

public Clear_Aggregations ( ) : void
return	void

Clear_Ticklers() public method

Clear all the ticklers associated with this item

public Clear_Ticklers ( ) : void
return	void

Clear_Views() public method

Clear all the pre-existing views from this item

public Clear_Views ( ) : void
return	void

Clear_Web_Skins() public method

Clear all the pre-existing web skins from this item

public Clear_Web_Skins ( ) : void
return	void

Clear_Wordmarks() public method

Clears all the icon/wordmarks associated with this item

public Clear_Wordmarks ( ) : void
return	void

Dedupe_Wordmarks() public method

Dedupes the wordmarks to ensure that no duplication is occurring

Saving duped wordmarks to the database can result in a database exception during the save process

public Dedupe_Wordmarks ( ) : void
return	void

Delete_User_Tag() public method

Delete a user tag from this object, by TagID and UserID

This only deletes the user tag if the UserID for the tag matches the provided userid

public Delete_User_Tag ( int TagID, int UserID ) : bool
TagID	int	Primary key for this tag from the database
UserID	int	Primary key for the user who entered this tag
return	bool

Insert_View() public method

Add a new SobekCM View to this resource

public Insert_View ( int Index, string View_Type ) : View_Object
Index	int	Index where to insert this view
View_Type	string	Standard type of SobekCM View
return	View_Object

Insert_View() public method

Add a new SobekCM View to this resource

public Insert_View ( int Index, string View_Type, string Label, string Attributes ) : View_Object
Index	int	Index where to insert this view
View_Type	string	Standard type of SobekCM View
Label	string	Label for this SobekCM View
Attributes	string	Any additional attribures needed for thie SobekCM View
return	View_Object

Set_Primary_Identifier() public method

Sets the type and identifier for the primary alternate identifier associated with this item group

public Set_Primary_Identifier ( string Type, string Identifier ) : void
Type	string	Type of the primary alternate identifier
Identifier	string	Primary alternate identifier
return	void

Set_Private() public method

Makes this item private in the behaviorSec, which results in a VisibilityRestrictions tag of -1 in the procParam of the resulting METS

public Set_Private ( ) : void
return	void

Set_Public() public method

Makes this item public in the behaviorSec, which results in a VisibilityRestrictions tag of zero in the procParam of the resulting METS

public Set_Public ( ) : void
return	void

Set_Serial_Info() public method

Saves the data stored in this instance of the element to the provided bibliographic object

public Set_Serial_Info ( SobekCM.Resource_Object.Behaviors.Serial_Info SerialInfo ) : void
SerialInfo	SobekCM.Resource_Object.Behaviors.Serial_Info	Serial information to set to this object
return	void