Behaviors_Info Class

Class holds all the non-descriptive behavior information, such as under which aggregations this item should appear, which web skins, etc..

Namespace: SobekCM.Resource_Object.Behaviors
Assembly: SobekCM_Resource_Object (in SobekCM_Resource_Object.dll) Version: 4.10.0.0 (4.10.0)

Syntax

C#
[SerializableAttribute] public class Behaviors_Info : XML_Writing_Base_Type

Remarks

Depending on the currently METS-writing profile, much of this data can also be written into a METS file, which differentiates this object from the Web_Info object, which is utilized by the web server to assist with some rendering and to generally improve performance by calculating and saving several values when building the resource object.

Inheritance Hierarchy

System..::..Object
SobekCM.Resource_Object..::..XML_Writing_Base_Type
SobekCM.Resource_Object.Behaviors..::..Behaviors_Info

Constructors

	Name	Description
	Behaviors_Info	Constructor for a new instance of the Behaviors_Info class

Methods

	Name	Description
	Add_Aggregation(String)	Adds an aggregation, if it doesn't exist
	Add_Aggregation(String, String)	Adds an aggregation, if it doesn't exist
	Add_Aggregation(String, String, String)	Adds an aggregation, if it doesn't exist
	Add_BehaviorSec_METS	Returns the METS behavior section associated with this resource
	Add_Item_Level_Page_View	Add a new SobekCM item-level page view to this resource
	Add_METS_Processing_Metadata	Returns the METS formatted XML for all the processing parameters for SobekCM
	Add_Tickler	Clear all the ticklers associated with this item
	Add_User_Tag	Add a new user tag to this item
	Add_View(View_Enum)	Add a new SobekCM View to this resource
	Add_View(View_Object)	Add a new SobekCM View to this resource
	Add_View(View_Enum, String, String)	Add a new SobekCM View to this resource
	Add_View(View_Enum, String, String, String)	Add a new SobekCM View to this resource
	Add_Web_Skin	Add a new web skin code to this item
	Add_Wordmark(String)	Adds a wordmark/icon, if it doesn't exist
	Add_Wordmark(Wordmark_Info)	Adds a wordmark/icon, if it doesn't exist
	Add_Wordmarks	Adds a wordmark/icon, if it doesn't exist
	Calculate_GUID
	Clear_Aggregations	Clear all of the aggregations associated with this item
	Clear_Item_Level_Page_Views	Clear the SobekCM item-level page views linked to this resource
	Clear_Ticklers	Clear all the ticklers associated with this item
	Clear_Views	Clear all the pre-existing views from this item
	Clear_Web_Skins	Clear all the pre-existing web skins from this item
	Clear_Wordmarks	Clears all the icon/wordmarks associated with this item
	Convert_String_To_XML_Safe	Converts a basic string into an XML-safe string (Inherited from XML_Writing_Base_Type.)
	Dedupe_Wordmarks	Dedupes the wordmarks to ensure that no duplication is occurring
	Delete_User_Tag	Delete a user tag from this object, by TagID and UserID
	Has_Viewer_Type	Checks to see if the viewer type is in use for this digital resource
	Insert_View(Int32, View_Enum)	Add a new SobekCM View to this resource
	Insert_View(Int32, View_Enum, String, String)	Add a new SobekCM View to this resource
	Set_Primary_Identifier	Sets the type and identifier for the primary alternate identifier associated with this item group
	Set_Private	Makes this item private in the behaviorSec, which results in a VisibilityRestrictions tag of -1 in the procParam of the resulting METS
	Set_Public	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	Saves the data stored in this instance of the element to the provided bibliographic object
	ToMETS	Returns a single value in METS formatted XML

Properties

	Name	Description
	Aggregation_Code_List	Gets the list of all aggregation codes
	Aggregation_Codes	Gets the list of all aggregation codes as a single semi-colon delimited string
	Aggregation_Count	Get the number of aggregation codes associated with this resource
	Aggregations	Gets the readonly list of all aggregation codes
	Can_Be_Described	Flag determines if this item can be described online by logged in users
	CheckOut_Required	Flag determines if this item is reserved for single-item use online
	CheckOut_Required_Is_Null	Flag indicates if a checkout required value is provided, or if that flag is currently NULL.
	Dark_Flag	Flag determines if this item is currently set to DARK and can never be made public or have files added online
	Dark_Flag_Is_Null	Flag indicates if a dark flag value is provided, or if that flag is currently NULL.
	Default_View	Gets and sets the default view for this item
	Embedded_Video	Gets and sets the embedded video code
	Expose_Full_Text_For_Harvesting	Flag indicates if the full text should be included in the static files generated for search engine indexing robots
	GroupTitle	Gets and sets the group title for this item from the SobekCM Web database
	GroupType	Gets and sets the group type for this item from the SobekCM Web database
	hasSerialInformation	Gets flag which indicates if there is any serial hierarchy information in this object
	IP_Restriction_Membership	Bitwise flags determines if this item should be restricted to certain IP ranges
	IP_Restriction_Membership_Is_Null	Flag indicates if a value is provided for the current IP Restriction Membership, or if that value is currently NULL.
	Item_Level_Page_Views	List of page views which are generally accessible for this item
	Item_Level_Page_Views_Count	Gets the number of page views associated with this resource
	Left_To_Right	Flag indicates if this item should be displayed Left-to-Right, rather than the default Right-to-Left.
	Main_Page	Gets the information about the main page for this item
	Main_Thumbnail	Gets and sets the name of the main thumbnail file
	NotifyEmail	Gets or sets the notification email for this record
	Primary_Identifier	Get the primary alternate identifier associated with this item group
	Publicly_Accessible	Flag determines if this item is publicly accessible or only accessible to internal users
	Serial_Info	Gets the serial hierarchy information associated with this resource
	Suppress_Endeca	Flag determines if this item should be suppressed in the Endeca feed of digital resources
	Text_Searchable	Gets and sets the text searchable flag for this item from the SobekCM Web database
	Ticklers	List of ticklers associated with this item
	Ticklers_Count	Gets the number of ticklers associated with this item
	User_Tags	Gets the collection of SobekCM user tags associated with this resource
	User_Tags_Count	Gets the number of overall SobekCM user tags associated with this resource
	Views	Gets the collection of SobekCM views associated with this resource
	Views_Count	Gets the number of overall SobekCM views associated with this resource
	Web_Skin_Count	Get the number of web skins linked to this item
	Web_Skins	Gets the collection of web skins associated with this resource
	Wordmark_Count	Get the number of wordmarks (or wormdarks) associated with this resource
	Wordmarks	Gets the collection of wordmarks (or wordmarks) associated with this resource