C# Class SobekCM.Library.Database.SobekCM_Database

Gateway to the databases used by SobekCM

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

Public Methods

Method	Description
Add_Description_Tag ( int UserID, int TagID, int ItemID, string AddedDescription, Custom_Tracer Tracer ) : int	Adds a descriptive tag to an existing item by a logged-in user This calls the 'mySobek_Add_Description_Tag' stored procedure
Add_Item_To_User_Folder ( int UserID, string FolderName, string BibID, string Vid, int ItemOrder, string UserNotes, Custom_Tracer Tracer ) : bool	Adds a digital resource to a user folder, or edits an existing item This calls the 'mySobek_Add_Item_To_User_Folder' stored procedure
Add_Minimum_Builder_Information ( SobekCM_Item Resource ) : bool	Pulls the item id, main thumbnail, and aggregation codes and adds them to the resource object This calls the 'SobekCM_Builder_Get_Minimum_Item_Information' stored procedure
Add_Project_Aggregation_Link ( Custom_Tracer Tracer, int ProjectID, int AggregationID ) : void	Save the new Project-Aggregation link to the database.
Add_Project_DefaultMetadata_Link ( Custom_Tracer Tracer, int ProjectID, int DefaultMetadataID ) : void	Save the Project_Default Metadata link to the database
Add_Project_Item_Link ( Custom_Tracer Tracer, int ProjectID, int ItemID ) : void	Save Project, Item link to the database
Add_Project_Template_Link ( Custom_Tracer Tracer, int ProjectID, int TemplateID ) : void	Save Project, Input template link to the database
Add_User_BibID_Link ( int UserID, int GroupID ) : bool	Add a link between a user and an existing item group (by GroupID) This calls the 'mySobek_Link_User_To_Item' stored procedure
Add_User_Item_Link ( int UserID, int ItemID, int RelationshipID, bool ChangeExisting ) : bool	Add a link between a user and an existing item and include the type of relationship This calls the 'SobekCM_Link_User_To_Item' stored procedure
Admin_Update_Cached_Aggregation_Metadata_Links ( ) : bool	Updates the cached links between aggregationPermissions and metadata, used by larger collections This calls the 'Admin_Update_Cached_Aggregation_Metadata_Links' stored procedure. This runs asychronously as this routine may run for a minute or more.
Builder_Add_Log_Entry ( long RelatedBuilderLogID, string BibID_VID, string LogType, string LogMessage, string MetsType ) : long	Add a new log entry for the builder This calls the 'SobekCM_Builder_Add_Log' stored procedure
Builder_Clear_Item_Error_Log ( string BibID, string Vid, string ClearedBy ) : bool	Clears the item error log associated with a particular bibid / vid No error is deleted, but this does set a flag on the error indicating it was cleared so it will no longer appear in the list This calls the 'SobekCM_Clear_Item_Error_Log' stored procedure
Builder_Expire_Log_Entries ( int Retain_For_Days ) : bool	Expire older builder logs which can be removed from the system This calls the 'SobekCM_Builder_Expire_Log_Entries' stored procedure
Builder_Folder_Delete ( int FolderID, Custom_Tracer Tracer ) : bool	Deletes an existing builder incoming folder from the table This calls the 'SobekCM_Builder_Incoming_Folder_Delete' stored procedure
Builder_Folder_Edit ( int FolderID, string Folder_Name, string Network_Folder, string Error_Folder, string Processing_Folder, bool Perform_Checksum, bool Archive_TIFF, bool Archive_All_Files, bool Allow_Deletes, bool Allow_Folders_No_Metadata, string BibID_Roots_Restrictions, int ModuleSetID, Custom_Tracer Tracer ) : bool	Edits an existing builder incoming folder or adds a new folder This calls the 'SobekCM_Builder_Incoming_Folder_Edit' stored procedure
Builder_Get_Error_Logs ( Custom_Tracer Tracer, System.DateTime StartDate, System.DateTime EndDate ) : DataTable	Gets the list of build errors that have been encountered between two dates This calls the 'SobekCM_Get_Build_Error_Logs' stored procedure
Change_Password ( string Username, string CurrentPassword, string NewPassword, bool IsTemporary, Custom_Tracer Tracer ) : bool	Change an existing user's password This calls the 'mySobek_Change_Password' stored procedure
Delete_Aggregation_Alias ( string Alias, Custom_Tracer Tracer ) : bool	Deletes an item aggregation alias by alias code This calls the 'SobekCM_Delete_Item_Aggregation_Alias' stored procedure
Delete_Default_Metadata ( string Code, Custom_Tracer Tracer ) : bool	Deletes an existing default metadata This calls the 'mySobek_Delete_Project' stored procedure
Delete_Description_Tag ( int TagID, Custom_Tracer Tracer ) : bool	Delete's a user's descriptive tage This calls the 'mySobek_Delete_Description_Tag' stored procedure
Delete_IP_Range ( int IdToDelete, Custom_Tracer Tracer ) : bool	Delete a complete IP range group This calls the 'SobekCM_Delete_IP_Range' stored procedure
Delete_Icon ( string IconCode, Custom_Tracer Tracer ) : bool	Deletes an existing wordmark/icon if it is not linked to any titles in the database This calls the 'SobekCM_Delete_Icon' stored procedure
Delete_Item_Aggregation ( string Code, bool IsSysAdmin, string Username, Custom_Tracer Tracer, string &ErrorMessage ) : int	Delete an item aggregation from the database This calls the 'SobekCM_Delete_Item_Aggregation' stored procedure
Delete_Item_From_User_Folder ( int UserID, string FolderName, string BibID, string Vid, Custom_Tracer Tracer ) : bool	Remove an item from the user's folder This calls the 'mySobek_Delete_Item_From_User_Folder' stored procedure
Delete_Item_From_User_Folders ( int UserID, string BibID, string Vid, Custom_Tracer Tracer ) : bool	Remove an item from any user folder it currently resides in (besides Submitted Items) This calls the 'mySobek_Delete_Item_From_All_User_Folders' stored procedure
Delete_Project_Aggregation_Link ( Custom_Tracer Tracer, int ProjectID, int AggregationID ) : void	Delete Project, Aggregation Link from the database
Delete_Project_DefaultMetadata_Link ( Custom_Tracer Tracer, int ProjectID, int DefaultMetadataID ) : void	Delete the Project, default metadata link from the database
Delete_Project_Item_Link ( Custom_Tracer Tracer, int ProjectID, int ItemID ) : void	Delete a Project, Item link from the database
Delete_Project_Template_Link ( Custom_Tracer Tracer, int ProjectID, int TemplateID ) : void	Delete a project, CompleteTemplate link from the database
Delete_Setting ( string SettingKey ) : bool	Delete a value from the settings table This calls the 'SobekCM_Delete_Settinge' stored procedure
Delete_Single_IP ( int PrimaryID, Custom_Tracer Tracer ) : bool	Deletes a single IP address information from an IP restriction range This calls the 'SobekCM_Delete_Single_IP' stored procedure
Delete_SobekCM_Item ( string BibID, string VID, bool AsAdmin, string DeleteMessage ) : bool	Deletes an item from the SobekCM database This method calls the stored procedure 'SobekCM_Delete_Item'. This just marks a flag on the item (and item group) as deleted, it does not actually remove the data from the database
Delete_URL_Portal ( int PortalID, Custom_Tracer Tracer ) : bool	Delete a URL Portal from the database, by primary key This calls the 'SobekCM_Delete_Portal' stored procedure
Delete_User_Folder ( int UserID, int UserFolderID, Custom_Tracer Tracer ) : bool	Deletes a folder from a user This calls the 'mySobek_Delete_User_Folder' stored procedure
Delete_User_Group ( int UserGroupID, Custom_Tracer Tracer ) : int	Deletes a user group, if there are no users attached and if it is not a special group This calls the 'mySobek_Delete_User_Group' stored procedure
Delete_User_Search ( int UserSearchID, Custom_Tracer Tracer ) : bool	Deletes a user search from the collection of saved searches This calls the 'mySobek_Delete_User_Search' stored procedure
Delete_Web_Skin ( string SkinCode, bool ForceDelete, Custom_Tracer Tracer ) : bool	Deletes a HTML web skin fromo the database This calls the 'SobekCM_Delete_Web_Skin' stored procedure
Edit_IP_Range ( int IpRangeID, string Title, string Notes, string ItemRestrictedStatement, Custom_Tracer Tracer ) : bool	Edits an existing IP restriction range, or adds a new one This calls the 'SobekCM_Edit_IP_Range' stored procedure
Edit_Single_IP ( int PrimaryID, int IpRangeID, string StartIp, string EndIp, string Note, Custom_Tracer Tracer ) : int	Adds or edits a single IP address information in an IP restriction range This calls the 'SobekCM_Edit_Single_IP' stored procedure
Edit_URL_Portal ( int PortalID, string BaseUrl, bool IsActive, bool IsDefault, string Abbreviation, string Name, string DefaultAggregation, string DefaultWebSkin, string BasePurl, Custom_Tracer Tracer ) : int	Edit an existing URL Portal or add a new URL portal, by primary key This calls the 'SobekCM_Edit_Portal' stored procedure
Edit_User_Folder ( int UserFolderID, int UserID, int ParentFolderID, string FolderName, bool IsPublic, string Description, Custom_Tracer Tracer ) : int	Edit an existing user folder, or add a new user folder This calls the 'mySobek_Edit_User_Folder' stored procedure
FDA_Report_Save ( SobekCM.Tools.FDA.FDA_Report_Data Report ) : bool	Saves all the pertinent information from a received Florida Digital Archive (FDA) ingest report
FDA_Report_Save ( string Package, string Ieid, string FdaReportType, System.DateTime ReportDate, string Account, string Project, int Warnings, string Message, string BibID, string Vid ) : int	Save the information about a FDA report to the database This calls the FDA_Report_Save stored procedure in the database
Get_AggregationCode_From_CID ( String Cid ) : String	Gets aggregation code from CID in aggregation description
Get_Aggregation_Build_Log ( int AggregationID ) : DataTable	Gets the build log for a particular aggregation This calls the 'SobekCM_Build_Log_Get' stored procedure
Get_Aggregation_Change_Log ( string AggregationCode, Custom_Tracer Tracer ) : DataTable
Get_Aggregation_Statistics_History ( string AggregationCode, Custom_Tracer Tracer ) : DataTable	Returns the month-by-month usage statistics details by item aggregation Passing 'ALL' in as the aggregation code returns the statistics for all item aggregationPermissions within this library This calls the 'SobekCM_Get_Collection_Statistics_History' stored procedure This is used by the Statistics_HtmlSubwriter class
Get_Aggregation_User_Permissions ( string AggregationCode, Custom_Tracer Tracer ) : DataTable
Get_Aggregations_By_ProjectID ( Custom_Tracer Tracer, int ProjectID ) : List	Get the list of Aggregation IDs associated with a project
Get_All_Groups_First_VID ( ) : DataTable	Get the list of groups, with the top item (VID)
Get_All_Items_By_AggregationID ( string AggregationCode, List FIDs, Custom_Tracer Tracer ) : DataTable	Gets the list of unique coordinate points and associated bibid and group title for a single item aggregation This calls the 'SobekCM_Coordinate_Points_By_Aggregation' stored procedure
Get_All_User_Settings_Like ( string KeyStart, string SettingValue ) : DataTable	Gets settings across all the users that are like the key start This calls the 'mySobek_Get_All_User_Settings_Like' stored procedure
Get_All_Users ( Custom_Tracer Tracer ) : DataTable	Gets the datatable of all users from the mySobek / personalization database This calls the 'mySobek_Get_All_Users' stored procedure
Get_BibID_VID_From_Identifier ( string Identifier ) : String	Pulls the BibID, VID via the Identifier
Get_CollectionList_ReadyToBuild ( ) : DataTable	Get a list of collections which have new items and are ready to be built This method calls the stored procedure 'SobekCM_Get_CollectionList_toBuild'.
Get_Folder_Search_Information ( int UserID, Custom_Tracer Tracer ) : DataSet	Gets basic information about all the folders and searches saved for a single user This calls the 'mySobek_Get_Folder_Search_Information' stored procedure
Get_Global_User_Permissions ( Custom_Tracer Tracer ) : DataTable	Get the list of users that have top-level permissions, such as editing all items, being an admin, deleting all items, or a power user
Get_Global_User_Permissions_Aggregations_Links ( Custom_Tracer Tracer ) : DataTable	Get the list of users and for each user the list of aggregations they have special rights over (wither by user or through user group )
Get_Global_User_Permissions_Linked_Aggregations ( Custom_Tracer Tracer ) : DataTable	Get the list of aggregations that have special rights given to some users
Get_Global_User_Permissions_Submission_Rights ( Custom_Tracer Tracer ) : DataTable	Get the list of users, with informaiton about the templates and default metadata, that can submit material to this instance
Get_IP_Restriction_Range_Details ( int PrimaryID, Custom_Tracer Tracer ) : DataSet	Gets the details for a single IP restriction ranges, including each single IP and the complete notes associated with the range This calls the 'SobekCM_Get_IP_Restriction_Range' stored procedure
Get_IP_Restriction_Ranges ( Custom_Tracer Tracer ) : DataTable	Gets the list of all the IP ranges for restriction, including each single IP information in those ranges This calls the 'SobekCM_Get_All_IP_Restrictions' stored procedure
Get_ItemID_From_Bib_VID ( string BibID, string VID ) : int	Pulls the item id by BibID / VID This calls the 'SobekCM_Builder_Get_Minimum_Item_Information' stored procedure
Get_Item_Aggregation_Count ( System.DateTime Date1, int Option, Custom_Tracer Tracer ) : DataTable	Gets the title, item, and page count for each item aggregation currently and at some previous point of time This calls the 'SobekCM_Item_Count_By_Collection_By_Dates' stored procedure This is used by the Internal_HtmlSubwriter class
Get_Item_Aggregation_Count ( int Option, Custom_Tracer Tracer ) : DataTable	Gets the current title, item, and page count for each item aggregation in the item aggregation hierarchy This calls the 'SobekCM_Item_Count_By_Collection' stored procedure This is used by the Internal_HtmlSubwriter class
Get_Item_Aggregation_Count_DateRange ( System.DateTime Date1, System.DateTime Date2, int Option, Custom_Tracer Tracer ) : DataTable	Gets the title, item, and page count for each item aggregation currently and at some previous point of time This calls the 'SobekCM_Item_Count_By_Collection_By_Date_Range' stored procedure This is used by the Internal_HtmlSubwriter class
Get_Item_Aggregation_Milestone ( string AggregationCode ) : DataTable	Gets all the milestones for a single item aggregation This calls the 'SobekCM_Add_Item_Aggregation_Milestone' stored procedure
Get_Item_List ( bool IncludePrivate, Custom_Tracer Tracer ) : DataSet	Gets the dataset of all public items and item groups This calls the 'SobekCM_Item_List_Brief2' stored procedure
Get_Item_Restrictions ( string BibID, string Vid, Custom_Tracer Tracer, bool &IsDark, short &IP_Restrction_Mask ) : void	Determines what restrictions are present on an item This calls the 'SobekCM_Get_Item_Restrictions' stored procedure
Get_Metadata_Name_From_MetadataTypeID ( short MetadataTypeId, Custom_Tracer Tracer ) : string	Gets the human readable name of a metadate id This calls the 'SobekCM_Get_Metadata_Name_From_MetadataTypeID' stored procedure
Get_OAI_Data ( string SetCode, string DataCode, System.DateTime FromDate, System.DateTime UntilDate, int PageSize, int PageNumber, bool IncludeRecord ) : List	Returns a list of either identifiers or records for either the entire system or a single set, to be served through the OAI-PMH server This calls the 'SobekCM_Get_OAI_Data' stored procedure This is called by the Oai_MainWriter class.
Get_OAI_Record ( string BibID, string Vid, string DataCode ) : OAI_Record	Returns a single OAI-PMH record, by identifier ( BibID and VID ) This calls the 'SobekCM_Get_OAI_Data_Item' stored procedure This is called by the Oai_MainWriter class.
Get_OAI_Sets ( ) : DataTable	Gets the list of all OAI-enabled item aggregationPermissions This calls the 'SobekCM_Get_OAI_Sets' stored procedure This is called by the Oai_MainWriter class.
Get_Page_Item_Count_History ( Custom_Tracer Tracer ) : DataTable	Gets the item and page count loaded to this digital library by month and year This calls the 'SobekCM_Page_Item_Count_History' stored procedure
Get_Public_User_Folder ( int UserFolderID, Custom_Tracer Tracer ) : SobekCM.Library.Users.Public_User_Folder	Gets the information about a folder which should be public This calls the 'mySobek_Get_Folder_Information' stored procedure
Get_Settings ( Custom_Tracer Tracer ) : string>.Dictionary	Gets the values from the builder settings table in the database This calls the 'SobekCM_Get_Settings' stored procedure
Get_User_Group ( int UserGroupID, Custom_Tracer Tracer ) : SobekCM.Library.Users.User_Group	Gets the information about a single user group This calls the 'mySobek_Get_User_Group' stored procedure
Get_User_Searches ( int UserID, Custom_Tracer Tracer ) : DataTable	Gets the list of all saved user searches and any user comments This calls the 'mySobek_Get_User_Searches' stored procedure
Link_User_To_User_Group ( int UserID, int UserGroupID ) : bool	Links a single user to a user group This calls the 'mySobek_Link_User_To_User_Group' stored procedure
Lookup_Item_By_ItemID ( int ItemID, Custom_Tracer Tracer ) : DataRow	Gets some basic information about an item before displaing it, such as the descriptive notes from the database, ability to add notes, etc.. This calls the 'SobekCM_Get_BibID_VID_From_ItemID' stored procedure
Reset_User_Password ( int UserID, string NewPassword, bool IsTemporaryPassword, Custom_Tracer Tracer ) : bool	Sets a user's password to the newly provided one This calls the 'mySobek_Reset_User_Password' stored procedure
Save_Aggregation_Alias ( string Alias, string AggregationCode, Custom_Tracer Tracer ) : bool	Saves a item aggregation alias for future use This calls the 'SobekCM_Save_Item_Aggregation_Alias' stored procedure
Save_Default_Metadata ( string Code, string Name, string Description, int UserID, Custom_Tracer Tracer ) : bool	Saves a new default metadata set, or edits an existing default metadata name This calls the 'mySobek_Save_DefaultMetadata' stored procedure
Save_Icon ( string IconName, string IconFile, string IconLink, int Height, string IconTitle, Custom_Tracer Tracer ) : int	Saves information about a new icon/wordmark or modify an existing one This calls the 'SobekCM_Save_Icon' stored procedure
Save_Icon ( string IconName, string IconFile, string IconLink, string IconTitle, Custom_Tracer Tracer ) : int	Saves information about a new icon/wordmark or modify an existing one This calls the 'SobekCM_Save_Icon' stored procedure
Save_Item_Aggregation_Milestone ( string AggregationCode, string Milestone, string User ) : bool	Add a new milestone to an existing item aggregation This calls the 'SobekCM_Add_Item_Aggregation_Milestone' stored procedure
Save_Project ( Custom_Tracer Tracer, int ProjectID, string ProjectCode, string ProjectName, string ProjectManager, string GrantID, System.DateTime StartDate, System.DateTime EndDate, bool isActive, string Description, string Specifications, string Priority, string QcProfile, int TargetItemCount, int TargetPageCount, string Comments, string CopyrightPermissions ) : int	Save a new, or edit an existing Project in the database
Save_Template ( string Code, string Name, string Description, Custom_Tracer Tracer ) : bool	Saves a new template, or edits an existing template name This calls the 'mySobek_Save_Template' stored procedure
Save_User ( SobekCM.Library.Users.User_Object User, string Password, User_Authentication_Type_Enum AuthenticationType, Custom_Tracer Tracer ) : bool	Saves information about a single user This calls the 'mySobek_Save_User' stored procedure
Save_User_Group ( int UserGroupID, string GroupName, string GroupDescription, bool CanSubmit, bool IsInternal, bool CanEditAll, bool IsSystemAdmin, bool IsPortalAdmin, bool IncludeTrackingStandardForms, bool ClearMetadataTemplates, bool ClearAggregationLinks, bool ClearEditableLinks, bool IsSobekDefault, bool IsShibbolethDefault, bool IsLdapDefault, Custom_Tracer Tracer ) : int	Sets some of the basic information and global permissions values for a single user group This calls the 'mySobek_Save_User_Group' stored procedure
Save_User_Search ( int UserID, string SearchUrl, string SearchDescription, int ItemOrder, string UserNotes, Custom_Tracer Tracer ) : int	Saves a search to the user's saved searches This calls the 'mySobek_Save_User_Search' stored procedure
Save_Web_Skin ( string SkinCode, string BaseSkinCode, bool OverrideBanner, bool OverrideHeaderFooter, string BannerLink, string Notes, bool SuppressTopNavigation, Custom_Tracer Tracer ) : bool	Saves a HTML skin to the database This calls the 'SobekCM_Add_Web_Skin' stored procedure
Set_Aggregation_NewItem_Flag ( string AggregationCode, bool NewItemFlag ) : bool	method used to set the new items flag of a specified item aggregation This method calls the stored procedure 'SobekCM_Set_Aggregation_NewItem_Flag'.
Set_Item_Main_Thumbnail ( string BibID, string VID, string MainThumbnail ) : bool	Sets the main thumbnail for a given digital resource This calls the 'SobekCM_Set_Main_Thumbnail' stored procedure
Set_Setting ( string SettingKey, string SettingValue ) : bool	Sets a value in the settings table This calls the 'SobekCM_Set_Setting_Value' stored procedure
Set_User_Receive_Stats_Email ( int UserID, bool NewFlag, Custom_Tracer Tracer ) : bool	Updates the flag that indicates the user would like to receive a monthly usage statistics email This calls the 'mySobek_Set_Receive_Stats_Email_Flag' stored procedure
Set_User_Setting ( int UserID, string SettingKey, string SettingValue ) : bool	Sets a value for an individual user's setting This calls the 'SobekCM_Set_User_Setting_Value' stored procedure
Statistics_Aggregation_Titles ( string AggregationCode, Custom_Tracer Tracer ) : DataSet	Pulls the most often hit titles and items, by item aggregation This calls the 'SobekCM_Statistics_Aggregation_Titles' stored procedure This is used by the Statistics_HtmlSubwriter class
Statistics_By_Date_Range ( int Early_Year, int Early_Month, int Last_Year, int Last_Month, Custom_Tracer Tracer ) : DataTable	Pulls the complete usage statistics, broken down by each level of the item aggregation hierarchy, between two dates This calls the 'SobekCM_Statistics_By_Date_Range' stored procedure This is used by the Statistics_HtmlSubwriter class
Test_Connection ( ) : bool	Test connectivity to the database
Test_Connection ( string TestConnectionString ) : bool	Test connectivity to the database
Tracking_Delete_Workflow ( int WorkflowID ) : void
Tracking_Get_All_Entries_By_User ( string Username ) : DataTable	Gets all tracking workflow entries created by a single user
Tracking_Get_Item_Info_from_ItemID ( int ItemID ) : DataRow	Gets the corresponding BibID, VID for a given itemID
Tracking_Get_Open_Workflows ( int ItemID, int EventNum ) : DataTable	Gets the related workflows for an item by ItemID
Tracking_Get_Scanners_List ( ) : DataTable	Gets the list of users who are Scanning or Processing Technicians
Tracking_Get_Users_Scanning_Processing ( ) : DataTable	Gets the list of users who are Scanning or Processing Technicians
Tracking_Save_New_Workflow ( int ItemID, string WorkPerformedBy, string RelatedEquipment, System.DateTime DateStarted, System.DateTime DateCompleted, int EventNum, int StartEvent, int EndEvent, int StartEndEvent ) : int	Save a new workflow entry during tracking
Tracking_Update_Workflow ( int WorkflowID, int ItemID, string WorkPerformedBy, System.DateTime DateStarted, System.DateTime DateCompleted, string RelatedEquipment, int EventNumber, int StartEventNumber, int EndEventNum ) : void	Update an already saved tracking workflow entry
Update_Additional_Work_Needed_Flag ( int ItemID, bool NewFlag, Custom_Tracer Tracer ) : bool	Update the additional work neeed flag, which flag an item for additional follow up work in the builder This calls the 'SobekCM_Update_Additional_Work_Needed_Flag' stored procedure
Update_Item_Aggregation ( string Code, string Name, string ShortName, bool IsActive, bool IsHidden, string ExternalLink, Custom_Tracer Tracer ) : bool	Updates an existing item aggregation's data that appears in the basic edit aggregation form This calls the 'SobekCM_Update_Item_Aggregation' stored procedure in the SobekCM database
Update_SobekCM_User ( int UserID, bool CanSubmit, bool IsInternal, bool CanEditAll, bool CanDeleteAll, bool IsSystemAdmin, bool IsHostAdmin, bool IsPortalAdmin, bool IncludeTrackingStandardForms, string EditTemplate, string EditTemplateMarc, bool ClearProjectsTemplates, bool ClearAggregationLinks, bool ClearUserGroups, Custom_Tracer Tracer ) : bool	Sets some of the permissions values for a single user This calls the 'mySobek_Update_User' stored procedure
Update_SobekCM_User_Aggregations ( int UserID, List Aggregations, Custom_Tracer Tracer ) : bool	Sets the list of aggregationPermissions and permissions tagged to a given user This calls the 'SobekCM_Add_User_Aggregations_Link' stored procedure
Update_SobekCM_User_DefaultMetadata ( int UserID, ReadOnlyCollection MetadataSets, Custom_Tracer Tracer ) : bool	Sets the list of default metadata sets possible for a given user This calls the 'mySobek_Add_User_DefaultMetadata_Link' stored procedure
Update_SobekCM_User_Group_Aggregations ( int UserGroupID, List Aggregations, Custom_Tracer Tracer ) : bool	Sets the list of aggregationPermissions and permissions tagged to a given user group This calls the 'SobekCM_Add_User_Group_Aggregations_Link' stored procedure
Update_SobekCM_User_Group_DefaultMetadata ( int UserGroupID, List MetadataSets, Custom_Tracer Tracer ) : bool	Sets the list of default metadata sets possible for a given user group This calls the 'mySobek_Add_User_Group_Metadata_Link' stored procedure
Update_SobekCM_User_Group_Templates ( int UserGroupID, List Templates, Custom_Tracer Tracer ) : bool	Sets the list of templates possible for a given user group This calls the 'mySobek_Add_User_Group_Templates_Link' stored procedure
Update_SobekCM_User_Templates ( int UserID, ReadOnlyCollection Templates, Custom_Tracer Tracer ) : bool	Sets the list of templates possible for a given user This calls the 'mySobek_Add_User_Templates_Link' stored procedure
UserName_Exists ( string UserName, string Email, bool &UserNameExists, bool &EmailExists, Custom_Tracer Tracer ) : bool	Checks to see if a username or email exist This calls the 'mySobek_UserName_Exists' stored procedure This is used to enforce uniqueness during registration
User_Set_Aggregation_Home_Page_Flag ( int UserID, int AggregationID, bool NewFlag, Custom_Tracer Tracer ) : bool	Sets the flag indicating an aggregation should appear on a user's home page This calls the 'mySobek_Set_Aggregation_Home_Page_Flag' stored procedure
View_Tags_By_Aggregation ( string AggregationCode, Custom_Tracer Tracer ) : DataTable	List all descriptive tags added by a single user This calls the 'SobekCM_Get_Description_Tags_By_Aggregation' stored procedure
View_Tags_By_User ( int UserID, Custom_Tracer Tracer ) : DataTable	List all descriptive tags added by a single user This calls the 'mySobek_View_All_User_Tags' stored procedure

Private Methods

Method	Description
SobekCM_Database ( ) : System	Static constructor for this class

Method Details

Add_Description_Tag() public static method

Adds a descriptive tag to an existing item by a logged-in user

This calls the 'mySobek_Add_Description_Tag' stored procedure

public static Add_Description_Tag ( int UserID, int TagID, int ItemID, string AddedDescription, Custom_Tracer Tracer ) : int
UserID	int	Primary key for the user adding the descriptive tag
TagID	int	Primary key for a descriptive tag, if this is an edit
ItemID	int	Primary key for the digital resource to tag
AddedDescription	string	User-entered descriptive tag
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Add_Item_To_User_Folder() public static method

Adds a digital resource to a user folder, or edits an existing item

This calls the 'mySobek_Add_Item_To_User_Folder' stored procedure

public static Add_Item_To_User_Folder ( int UserID, string FolderName, string BibID, string Vid, int ItemOrder, string UserNotes, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user in the database
FolderName	string	Name of this user's folder
BibID	string	Bibliographic identifier for this title / item group
Vid	string	Volume identifier for this one volume within a title / item group
ItemOrder	int	Order for this item within the folder
UserNotes	string	Notes from the user about this item
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Add_Minimum_Builder_Information() public static method

Pulls the item id, main thumbnail, and aggregation codes and adds them to the resource object

This calls the 'SobekCM_Builder_Get_Minimum_Item_Information' stored procedure

public static Add_Minimum_Builder_Information ( SobekCM_Item Resource ) : bool
Resource	SobekCM.Resource_Object.SobekCM_Item	Digital resource object
return	bool

Add_Project_Aggregation_Link() public static method

Save the new Project-Aggregation link to the database.

public static Add_Project_Aggregation_Link ( Custom_Tracer Tracer, int ProjectID, int AggregationID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
AggregationID	int
return	void

Add_Project_DefaultMetadata_Link() public static method

Save the Project_Default Metadata link to the database

public static Add_Project_DefaultMetadata_Link ( Custom_Tracer Tracer, int ProjectID, int DefaultMetadataID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
DefaultMetadataID	int
return	void

Add_Project_Item_Link() public static method

Save Project, Item link to the database

public static Add_Project_Item_Link ( Custom_Tracer Tracer, int ProjectID, int ItemID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
ItemID	int
return	void

Add_Project_Template_Link() public static method

Save Project, Input template link to the database

public static Add_Project_Template_Link ( Custom_Tracer Tracer, int ProjectID, int TemplateID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
TemplateID	int
return	void

Add_User_BibID_Link() public static method

Add a link between a user and an existing item group (by GroupID)

This calls the 'mySobek_Link_User_To_Item' stored procedure

public static Add_User_BibID_Link ( int UserID, int GroupID ) : bool
UserID	int	Primary key for this user in the database
GroupID	int	Primary key for the item group to link this user to
return	bool

Add_User_Item_Link() public static method

Add a link between a user and an existing item and include the type of relationship

This calls the 'SobekCM_Link_User_To_Item' stored procedure

public static Add_User_Item_Link ( int UserID, int ItemID, int RelationshipID, bool ChangeExisting ) : bool
UserID	int	Primary key for this user in the database
ItemID	int	Primary key for the item to link this user to
RelationshipID	int	Primary key for the type of relationship to use
ChangeExisting	bool	If a relationship already exists, should this override it?
return	bool

Admin_Update_Cached_Aggregation_Metadata_Links() public static method

Updates the cached links between aggregationPermissions and metadata, used by larger collections

This calls the 'Admin_Update_Cached_Aggregation_Metadata_Links' stored procedure.

This runs asychronously as this routine may run for a minute or more.

public static Admin_Update_Cached_Aggregation_Metadata_Links ( ) : bool
return	bool

Builder_Add_Log_Entry() public static method

Add a new log entry for the builder

This calls the 'SobekCM_Builder_Add_Log' stored procedure

public static Builder_Add_Log_Entry ( long RelatedBuilderLogID, string BibID_VID, string LogType, string LogMessage, string MetsType ) : long
RelatedBuilderLogID	long	Primary key for a related log id, if this adds detail to an already logged entry
BibID_VID	string	BibID / VID, if this is related to an item error (either existing item, or not)
LogType	string	Type of the log entry ( i.e., Error, Complete, etc.. )
LogMessage	string	Actual log entry message
MetsType	string	Type of the METS file (if related to one)
return	long

Builder_Clear_Item_Error_Log() public static method

Clears the item error log associated with a particular bibid / vid

No error is deleted, but this does set a flag on the error indicating it was cleared so it will no longer appear in the list

This calls the 'SobekCM_Clear_Item_Error_Log' stored procedure

public static Builder_Clear_Item_Error_Log ( string BibID, string Vid, string ClearedBy ) : bool
BibID	string	Bibliographic identifier for the item (or name of failed process)
Vid	string	Volume identifier for the item
ClearedBy	string	Name of user or process that cleared the error
return	bool

Builder_Expire_Log_Entries() public static method

Expire older builder logs which can be removed from the system

This calls the 'SobekCM_Builder_Expire_Log_Entries' stored procedure

public static Builder_Expire_Log_Entries ( int Retain_For_Days ) : bool
Retain_For_Days	int	Number of days of logs which should be retained
return	bool

Builder_Folder_Delete() public static method

Deletes an existing builder incoming folder from the table

This calls the 'SobekCM_Builder_Incoming_Folder_Delete' stored procedure

public static Builder_Folder_Delete ( int FolderID, Custom_Tracer Tracer ) : bool
FolderID	int	Primary key for the builder incoming folder to delete
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Builder_Folder_Edit() public static method

Edits an existing builder incoming folder or adds a new folder

This calls the 'SobekCM_Builder_Incoming_Folder_Edit' stored procedure

public static Builder_Folder_Edit ( int FolderID, string Folder_Name, string Network_Folder, string Error_Folder, string Processing_Folder, bool Perform_Checksum, bool Archive_TIFF, bool Archive_All_Files, bool Allow_Deletes, bool Allow_Folders_No_Metadata, string BibID_Roots_Restrictions, int ModuleSetID, Custom_Tracer Tracer ) : bool
FolderID	int	Primary key for the builder incoming folder to delete
Folder_Name	string
Network_Folder	string
Error_Folder	string
Processing_Folder	string
Perform_Checksum	bool
Archive_TIFF	bool
Archive_All_Files	bool
Allow_Deletes	bool
Allow_Folders_No_Metadata	bool
BibID_Roots_Restrictions	string
ModuleSetID	int
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Builder_Get_Error_Logs() public static method

Gets the list of build errors that have been encountered between two dates

This calls the 'SobekCM_Get_Build_Error_Logs' stored procedure

public static Builder_Get_Error_Logs ( Custom_Tracer Tracer, System.DateTime StartDate, System.DateTime EndDate ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
StartDate	System.DateTime	Beginning of the date range
EndDate	System.DateTime	End of the date range
return	System.Data.DataTable

Change_Password() public static method

Change an existing user's password

This calls the 'mySobek_Change_Password' stored procedure

public static Change_Password ( string Username, string CurrentPassword, string NewPassword, bool IsTemporary, Custom_Tracer Tracer ) : bool
Username	string	Username for the user
CurrentPassword	string	Old plain-text password, which is then encrypted prior to saving
NewPassword	string	New plain-text password, which is then encrypted prior to saving
IsTemporary	bool	Flag indicates if the new password is temporary and must be changed on the next logon
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Aggregation_Alias() public static method

Deletes an item aggregation alias by alias code

This calls the 'SobekCM_Delete_Item_Aggregation_Alias' stored procedure

public static Delete_Aggregation_Alias ( string Alias, Custom_Tracer Tracer ) : bool
Alias	string	Alias string which forwarded to a item aggregation
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Default_Metadata() public static method

Deletes an existing default metadata

This calls the 'mySobek_Delete_Project' stored procedure

public static Delete_Default_Metadata ( string Code, Custom_Tracer Tracer ) : bool
Code	string	Code for the default metadata to delete
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Description_Tag() public static method

Delete's a user's descriptive tage

This calls the 'mySobek_Delete_Description_Tag' stored procedure

public static Delete_Description_Tag ( int TagID, Custom_Tracer Tracer ) : bool
TagID	int	Primary key for the entered the descriptive tag
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_IP_Range() public static method

Delete a complete IP range group

This calls the 'SobekCM_Delete_IP_Range' stored procedure

public static Delete_IP_Range ( int IdToDelete, Custom_Tracer Tracer ) : bool
IdToDelete	int	Primary key of the IP range to delete
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Icon() public static method

Deletes an existing wordmark/icon if it is not linked to any titles in the database

This calls the 'SobekCM_Delete_Icon' stored procedure

public static Delete_Icon ( string IconCode, Custom_Tracer Tracer ) : bool
IconCode	string	Wordmark/icon code for the wordmark to delete
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Item_Aggregation() public static method

Delete an item aggregation from the database

This calls the 'SobekCM_Delete_Item_Aggregation' stored procedure

public static Delete_Item_Aggregation ( string Code, bool IsSysAdmin, string Username, Custom_Tracer Tracer, string &ErrorMessage ) : int
Code	string	Aggregation code for the aggregation to delete
IsSysAdmin	bool	Flag indicates if this is a system admin, who can delete aggregationPermissions with items
Username	string	Name of the user that deleted this aggregation, for the milestones
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
ErrorMessage	string	[OUT] Error message, if there was an error
return	int

Delete_Item_From_User_Folder() public static method

Remove an item from the user's folder

This calls the 'mySobek_Delete_Item_From_User_Folder' stored procedure

public static Delete_Item_From_User_Folder ( int UserID, string FolderName, string BibID, string Vid, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user in the database
FolderName	string	Name of this user's folder
BibID	string	Bibliographic identifier for this title / item group
Vid	string	Volume identifier for this one volume within a title / item group
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Item_From_User_Folders() public static method

Remove an item from any user folder it currently resides in (besides Submitted Items)

This calls the 'mySobek_Delete_Item_From_All_User_Folders' stored procedure

public static Delete_Item_From_User_Folders ( int UserID, string BibID, string Vid, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user in the database
BibID	string	Bibliographic identifier for this title / item group
Vid	string	Volume identifier for this one volume within a title / item group
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Project_Aggregation_Link() public static method

Delete Project, Aggregation Link from the database

public static Delete_Project_Aggregation_Link ( Custom_Tracer Tracer, int ProjectID, int AggregationID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
AggregationID	int
return	void

Delete_Project_DefaultMetadata_Link() public static method

Delete the Project, default metadata link from the database

public static Delete_Project_DefaultMetadata_Link ( Custom_Tracer Tracer, int ProjectID, int DefaultMetadataID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
DefaultMetadataID	int
return	void

Delete_Project_Item_Link() public static method

Delete a Project, Item link from the database

public static Delete_Project_Item_Link ( Custom_Tracer Tracer, int ProjectID, int ItemID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
ItemID	int
return	void

Delete_Project_Template_Link() public static method

Delete a project, CompleteTemplate link from the database

public static Delete_Project_Template_Link ( Custom_Tracer Tracer, int ProjectID, int TemplateID ) : void
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
TemplateID	int
return	void

Delete_Setting() public static method

Delete a value from the settings table

This calls the 'SobekCM_Delete_Settinge' stored procedure

public static Delete_Setting ( string SettingKey ) : bool
SettingKey	string	Key for the setting to update or insert
return	bool

Delete_Single_IP() public static method

Deletes a single IP address information from an IP restriction range

This calls the 'SobekCM_Delete_Single_IP' stored procedure

public static Delete_Single_IP ( int PrimaryID, Custom_Tracer Tracer ) : bool
PrimaryID	int	Primary key for this single IP address information to delete
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_SobekCM_Item() public static method

Deletes an item from the SobekCM database

This method calls the stored procedure 'SobekCM_Delete_Item'.

This just marks a flag on the item (and item group) as deleted, it does not actually remove the data from the database

public static Delete_SobekCM_Item ( string BibID, string VID, bool AsAdmin, string DeleteMessage ) : bool
BibID	string	Bibliographic identifier for the item to delete
VID	string	Volume identifier for the item to delete
AsAdmin	bool	Indicates this is an admin, who can delete ANY item, not just those without archives attached
DeleteMessage	string	Message to include on any archive remnants after an admin delete
return	bool

Delete_URL_Portal() public static method

Delete a URL Portal from the database, by primary key

This calls the 'SobekCM_Delete_Portal' stored procedure

public static Delete_URL_Portal ( int PortalID, Custom_Tracer Tracer ) : bool
PortalID	int	Primary key for the URL portal to be deleted
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_User_Folder() public static method

Deletes a folder from a user

This calls the 'mySobek_Delete_User_Folder' stored procedure

public static Delete_User_Folder ( int UserID, int UserFolderID, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user from the database
UserFolderID	int	Primary key for this folder from the database
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_User_Group() public static method

Deletes a user group, if there are no users attached and if it is not a special group

This calls the 'mySobek_Delete_User_Group' stored procedure

public static Delete_User_Group ( int UserGroupID, Custom_Tracer Tracer ) : int
UserGroupID	int	Primary key for this user group from the database
Tracer	SobekCM.Tools.Custom_Tracer
return	int

Delete_User_Search() public static method

Deletes a user search from the collection of saved searches

This calls the 'mySobek_Delete_User_Search' stored procedure

public static Delete_User_Search ( int UserSearchID, Custom_Tracer Tracer ) : bool
UserSearchID	int	Primary key for this saved search
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Delete_Web_Skin() public static method

Deletes a HTML web skin fromo the database

This calls the 'SobekCM_Delete_Web_Skin' stored procedure

public static Delete_Web_Skin ( string SkinCode, bool ForceDelete, Custom_Tracer Tracer ) : bool
SkinCode	string	Code for the HTML web skin to delete
ForceDelete	bool	Flag indicates if this should be deleted, even if things are still attached to this web skin (system admin)
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Edit_IP_Range() public static method

Edits an existing IP restriction range, or adds a new one

This calls the 'SobekCM_Edit_IP_Range' stored procedure

public static Edit_IP_Range ( int IpRangeID, string Title, string Notes, string ItemRestrictedStatement, Custom_Tracer Tracer ) : bool
IpRangeID	int	Primary key for the IP restriction range
Title	string	Title for this IP Restriction Range
Notes	string	Notes about this IP Restriction Range (for system admins)
ItemRestrictedStatement	string	Statement used when a user directly requests an item for which they do not the pre-requisite access
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Edit_Single_IP() public static method

Adds or edits a single IP address information in an IP restriction range

This calls the 'SobekCM_Edit_Single_IP' stored procedure

public static Edit_Single_IP ( int PrimaryID, int IpRangeID, string StartIp, string EndIp, string Note, Custom_Tracer Tracer ) : int
PrimaryID	int	Primary key for this single IP address information to add, or -1 to add a new IP address
IpRangeID	int	Primary key for the IP restriction range to add this single IP address information
StartIp	string	Beginning of the IP range, or the complete IP address
EndIp	string	End of the IP range, if this was a true range
Note	string	Any note associated with this single IP information
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Edit_URL_Portal() public static method

Edit an existing URL Portal or add a new URL portal, by primary key

This calls the 'SobekCM_Edit_Portal' stored procedure

public static Edit_URL_Portal ( int PortalID, string BaseUrl, bool IsActive, bool IsDefault, string Abbreviation, string Name, string DefaultAggregation, string DefaultWebSkin, string BasePurl, Custom_Tracer Tracer ) : int
PortalID	int	Primary key for the URL portal to be edited, or -1 if this is a new URL portal
BaseUrl	string	URL used to match the incoming request with this URL portal
IsActive	bool	Flag indicates if this URL portal is active
IsDefault	bool	Flag indicates if this is the default URL portal, if no other portal match is found
Abbreviation	string	Abbreviation for this system, when referenced by this URL portal
Name	string	Name of this system, when referenced by this URL portal
DefaultAggregation	string	Default aggregation for this URL portal
DefaultWebSkin	string	Default web skin for this URL portal
BasePurl	string	Base PURL , used to override the default PURL built from the current URL
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Edit_User_Folder() public static method

Edit an existing user folder, or add a new user folder

This calls the 'mySobek_Edit_User_Folder' stored procedure

public static Edit_User_Folder ( int UserFolderID, int UserID, int ParentFolderID, string FolderName, bool IsPublic, string Description, Custom_Tracer Tracer ) : int
UserFolderID	int	Primary key for the folder, if this is an edit, otherwise -1
UserID	int	Primary key for this user from the database
ParentFolderID	int	Key for the parent folder for this new folder
FolderName	string	Name for this new folder
IsPublic	bool	Flag indicates if this folder is public
Description	string	Description for this folder
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

FDA_Report_Save() public static method

Saves all the pertinent information from a received Florida Digital Archive (FDA) ingest report

public static FDA_Report_Save ( SobekCM.Tools.FDA.FDA_Report_Data Report ) : bool
Report	SobekCM.Tools.FDA.FDA_Report_Data	Object containing all the data from the received FDA report
return	bool

FDA_Report_Save() public static method

Save the information about a FDA report to the database

This calls the FDA_Report_Save stored procedure in the database

public static FDA_Report_Save ( string Package, string Ieid, string FdaReportType, System.DateTime ReportDate, string Account, string Project, int Warnings, string Message, string BibID, string Vid ) : int
Package	string	ID of the submission package sent to FDA. (End user's id)
Ieid	string	Intellectual Entity ID assigned by FDA
FdaReportType	string	Type of FDA report received
ReportDate	System.DateTime	Date FDA was generated
Account	string	Account information for the FDA submission package
Project	string	Project information for the FDA submission package
Warnings	int	Number of warnings in this package
Message	string	Message included in the FDA report received
BibID	string	Bibliographic Identifier
Vid	string	Volume Identifier
return	int

Get_AggregationCode_From_CID() public static method

Gets aggregation code from CID in aggregation description

public static Get_AggregationCode_From_CID ( String Cid ) : String
Cid	String	CID for the digital collection
return	String

Get_Aggregation_Build_Log() public static method

Gets the build log for a particular aggregation

This calls the 'SobekCM_Build_Log_Get' stored procedure

public static Get_Aggregation_Build_Log ( int AggregationID ) : DataTable
AggregationID	int	Primary key for this aggregation in the database
return	System.Data.DataTable

Get_Aggregation_Change_Log() public static method

public static Get_Aggregation_Change_Log ( string AggregationCode, Custom_Tracer Tracer ) : DataTable
AggregationCode	string
Tracer	SobekCM.Tools.Custom_Tracer
return	System.Data.DataTable

Get_Aggregation_Statistics_History() public static method

Returns the month-by-month usage statistics details by item aggregation

Passing 'ALL' in as the aggregation code returns the statistics for all item aggregationPermissions within this library

This calls the 'SobekCM_Get_Collection_Statistics_History' stored procedure

This is used by the Statistics_HtmlSubwriter class

public static Get_Aggregation_Statistics_History ( string AggregationCode, Custom_Tracer Tracer ) : DataTable
AggregationCode	string	Code for the item aggregation of interest
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_Aggregation_User_Permissions() public static method

public static Get_Aggregation_User_Permissions ( string AggregationCode, Custom_Tracer Tracer ) : DataTable
AggregationCode	string
Tracer	SobekCM.Tools.Custom_Tracer
return	System.Data.DataTable

Get_Aggregations_By_ProjectID() public static method

Get the list of Aggregation IDs associated with a project

public static Get_Aggregations_By_ProjectID ( Custom_Tracer Tracer, int ProjectID ) : List
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
return	List

Get_All_Groups_First_VID() public static method

Get the list of groups, with the top item (VID)

public static Get_All_Groups_First_VID ( ) : DataTable
return	System.Data.DataTable

Get_All_Items_By_AggregationID() public static method

Gets the list of unique coordinate points and associated bibid and group title for a single item aggregation

This calls the 'SobekCM_Coordinate_Points_By_Aggregation' stored procedure

public static Get_All_Items_By_AggregationID ( string AggregationCode, List FIDs, Custom_Tracer Tracer ) : DataTable
AggregationCode	string	Code for the item aggregation
FIDs	List	FileIDs
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_All_User_Settings_Like() public static method

Gets settings across all the users that are like the key start

This calls the 'mySobek_Get_All_User_Settings_Like' stored procedure

public static Get_All_User_Settings_Like ( string KeyStart, string SettingValue ) : DataTable
KeyStart	string	Beginning or entire key to return settings for. Since this uses like, you can pass /// in a string like 'TEI.%' and that will return all the values that have a setting key that STARTS with 'TEI.'
SettingValue	string	If SettingValue is NULL, then all settings that match are returned. If a /// value is provided then only the settings that match the key search and have the same value in the /// database as SettingValue are returned. This is particularly useful for boolean settings, where you /// only want to the see the settings set to 'true'
return	System.Data.DataTable

Get_All_Users() public static method

Gets the datatable of all users from the mySobek / personalization database

This calls the 'mySobek_Get_All_Users' stored procedure

public static Get_All_Users ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_BibID_VID_From_Identifier() public static method

Pulls the BibID, VID via the Identifier

public static Get_BibID_VID_From_Identifier ( string Identifier ) : String
Identifier	string	Identifier (PURL Handle) for the digital resource object
return	String

Get_CollectionList_ReadyToBuild() public static method

Get a list of collections which have new items and are ready to be built

This method calls the stored procedure 'SobekCM_Get_CollectionList_toBuild'.

public static Get_CollectionList_ReadyToBuild ( ) : DataTable
return	System.Data.DataTable

Get_Folder_Search_Information() public static method

Gets basic information about all the folders and searches saved for a single user

This calls the 'mySobek_Get_Folder_Search_Information' stored procedure

public static Get_Folder_Search_Information ( int UserID, Custom_Tracer Tracer ) : DataSet
UserID	int	Primary key for this user in the database
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataSet

Get_Global_User_Permissions() public static method

Get the list of users that have top-level permissions, such as editing all items, being an admin, deleting all items, or a power user

public static Get_Global_User_Permissions ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer
return	System.Data.DataTable

Get_Global_User_Permissions_Aggregations_Links() public static method

Get the list of users and for each user the list of aggregations they have special rights over (wither by user or through user group )

public static Get_Global_User_Permissions_Aggregations_Links ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer
return	System.Data.DataTable

Get_Global_User_Permissions_Linked_Aggregations() public static method

Get the list of aggregations that have special rights given to some users

public static Get_Global_User_Permissions_Linked_Aggregations ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer
return	System.Data.DataTable

Get_Global_User_Permissions_Submission_Rights() public static method

Get the list of users, with informaiton about the templates and default metadata, that can submit material to this instance

public static Get_Global_User_Permissions_Submission_Rights ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer
return	System.Data.DataTable

Get_IP_Restriction_Range_Details() public static method

Gets the details for a single IP restriction ranges, including each single IP and the complete notes associated with the range

This calls the 'SobekCM_Get_IP_Restriction_Range' stored procedure

public static Get_IP_Restriction_Range_Details ( int PrimaryID, Custom_Tracer Tracer ) : DataSet
PrimaryID	int	Primary id to the IP restriction range to pull details for
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataSet

Get_IP_Restriction_Ranges() public static method

Gets the list of all the IP ranges for restriction, including each single IP information in those ranges

This calls the 'SobekCM_Get_All_IP_Restrictions' stored procedure

public static Get_IP_Restriction_Ranges ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_ItemID_From_Bib_VID() public static method

Pulls the item id by BibID / VID

This calls the 'SobekCM_Builder_Get_Minimum_Item_Information' stored procedure

public static Get_ItemID_From_Bib_VID ( string BibID, string VID ) : int
BibID	string	Bibliographic identifier for the digital resource object
VID	string	Volume identifier for the digital resource object
return	int

Get_Item_Aggregation_Count() public static method

Gets the title, item, and page count for each item aggregation currently and at some previous point of time

This calls the 'SobekCM_Item_Count_By_Collection_By_Dates' stored procedure

This is used by the Internal_HtmlSubwriter class

public static Get_Item_Aggregation_Count ( System.DateTime Date1, int Option, Custom_Tracer Tracer ) : DataTable
Date1	System.DateTime	Date from which to additionally include item count
Option	int	Option tells which items to include ( 0 = completed, 1 = entered with files, 2 = all entered items )
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_Item_Aggregation_Count() public static method

Gets the current title, item, and page count for each item aggregation in the item aggregation hierarchy

This calls the 'SobekCM_Item_Count_By_Collection' stored procedure

This is used by the Internal_HtmlSubwriter class

public static Get_Item_Aggregation_Count ( int Option, Custom_Tracer Tracer ) : DataTable
Option	int	Option tells which items to include ( 0 = completed, 1 = entered with files, 2 = all entered items )
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_Item_Aggregation_Count_DateRange() public static method

Gets the title, item, and page count for each item aggregation currently and at some previous point of time

This calls the 'SobekCM_Item_Count_By_Collection_By_Date_Range' stored procedure

This is used by the Internal_HtmlSubwriter class

public static Get_Item_Aggregation_Count_DateRange ( System.DateTime Date1, System.DateTime Date2, int Option, Custom_Tracer Tracer ) : DataTable
Date1	System.DateTime	Date from which to additionally include item count
Date2	System.DateTime	Date to which to additionally include item count
Option	int	Option tells which items to include ( 0 = completed, 1 = entered with files, 2 = all entered items )
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_Item_Aggregation_Milestone() public static method

Gets all the milestones for a single item aggregation

This calls the 'SobekCM_Add_Item_Aggregation_Milestone' stored procedure

public static Get_Item_Aggregation_Milestone ( string AggregationCode ) : DataTable
AggregationCode	string	Item aggregation code
return	System.Data.DataTable

Get_Item_List() public static method

Gets the dataset of all public items and item groups

This calls the 'SobekCM_Item_List_Brief2' stored procedure

public static Get_Item_List ( bool IncludePrivate, Custom_Tracer Tracer ) : DataSet
IncludePrivate	bool	Flag indicates whether to include private items in this list
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataSet

Get_Item_Restrictions() public static method

Determines what restrictions are present on an item

This calls the 'SobekCM_Get_Item_Restrictions' stored procedure

public static Get_Item_Restrictions ( string BibID, string Vid, Custom_Tracer Tracer, bool &IsDark, short &IP_Restrction_Mask ) : void
BibID	string	Bibliographic identifier for the volume to retrieve
Vid	string	Volume identifier for the volume to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
IsDark	bool
IP_Restrction_Mask	short
return	void

Get_Metadata_Name_From_MetadataTypeID() public static method

Gets the human readable name of a metadate id

This calls the 'SobekCM_Get_Metadata_Name_From_MetadataTypeID' stored procedure

public static Get_Metadata_Name_From_MetadataTypeID ( short MetadataTypeId, Custom_Tracer Tracer ) : string
MetadataTypeId	short	Code for the metadata
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	string

Get_OAI_Data() public static method

Returns a list of either identifiers or records for either the entire system or a single set, to be served through the OAI-PMH server

This calls the 'SobekCM_Get_OAI_Data' stored procedure

This is called by the Oai_MainWriter class.

public static Get_OAI_Data ( string SetCode, string DataCode, System.DateTime FromDate, System.DateTime UntilDate, int PageSize, int PageNumber, bool IncludeRecord ) : List
SetCode	string	Code the OAI-PMH set (which is really an aggregation code)
DataCode	string	Code for the metadata to be served ( usually oai_dc )
FromDate	System.DateTime	Date from which to pull records which have changed
UntilDate	System.DateTime	Date to pull up to by last modified date on the records
PageSize	int	Number of records to include in a single 'page' of OAI-PMH results
PageNumber	int	Page number of the results to return
IncludeRecord	bool	Flag indicates whether the full records should be included, or just the identifier
return	List

Get_OAI_Record() public static method

Returns a single OAI-PMH record, by identifier ( BibID and VID )

This calls the 'SobekCM_Get_OAI_Data_Item' stored procedure

This is called by the Oai_MainWriter class.

public static Get_OAI_Record ( string BibID, string Vid, string DataCode ) : OAI_Record
BibID	string	BibID the OAI-PMH record )
Vid	string	VID for the OAI-PMH record
DataCode	string	Code for the metadata to be served ( usually oai_dc or marc21)
return	OAI_Record

Get_OAI_Sets() public static method

Gets the list of all OAI-enabled item aggregationPermissions

This calls the 'SobekCM_Get_OAI_Sets' stored procedure

This is called by the Oai_MainWriter class.

public static Get_OAI_Sets ( ) : DataTable
return	System.Data.DataTable

Get_Page_Item_Count_History() public static method

Gets the item and page count loaded to this digital library by month and year

This calls the 'SobekCM_Page_Item_Count_History' stored procedure

public static Get_Page_Item_Count_History ( Custom_Tracer Tracer ) : DataTable
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Get_Public_User_Folder() public static method

Gets the information about a folder which should be public

This calls the 'mySobek_Get_Folder_Information' stored procedure

public static Get_Public_User_Folder ( int UserFolderID, Custom_Tracer Tracer ) : SobekCM.Library.Users.Public_User_Folder
UserFolderID	int	ID for the user folder to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Library.Users.Public_User_Folder

Get_Settings() public static method

Gets the values from the builder settings table in the database

This calls the 'SobekCM_Get_Settings' stored procedure

public static Get_Settings ( Custom_Tracer Tracer ) : string>.Dictionary
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	string>.Dictionary

Get_User_Group() public static method

Gets the information about a single user group

This calls the 'mySobek_Get_User_Group' stored procedure

public static Get_User_Group ( int UserGroupID, Custom_Tracer Tracer ) : SobekCM.Library.Users.User_Group
UserGroupID	int	Primary key for this user group from the database
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	SobekCM.Library.Users.User_Group

Get_User_Searches() public static method

Gets the list of all saved user searches and any user comments

This calls the 'mySobek_Get_User_Searches' stored procedure

public static Get_User_Searches ( int UserID, Custom_Tracer Tracer ) : DataTable
UserID	int	Primary key for this user in the database
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Link_User_To_User_Group() public static method

Links a single user to a user group

This calls the 'mySobek_Link_User_To_User_Group' stored procedure

public static Link_User_To_User_Group ( int UserID, int UserGroupID ) : bool
UserID	int	Primary key for the user
UserGroupID	int	Primary key for the user group
return	bool

Lookup_Item_By_ItemID() public static method

Gets some basic information about an item before displaing it, such as the descriptive notes from the database, ability to add notes, etc..

This calls the 'SobekCM_Get_BibID_VID_From_ItemID' stored procedure

public static Lookup_Item_By_ItemID ( int ItemID, Custom_Tracer Tracer ) : DataRow
ItemID	int	Bibliographic identifier for the volume to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataRow

Reset_User_Password() public static method

Sets a user's password to the newly provided one

This calls the 'mySobek_Reset_User_Password' stored procedure

public static Reset_User_Password ( int UserID, string NewPassword, bool IsTemporaryPassword, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user from the database
NewPassword	string	New password (unencrypted) to set for this user
IsTemporaryPassword	bool	Flag indicates if this is a temporary password that must be reset the first time the user logs on
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Save_Aggregation_Alias() public static method

Saves a item aggregation alias for future use

This calls the 'SobekCM_Save_Item_Aggregation_Alias' stored procedure

public static Save_Aggregation_Alias ( string Alias, string AggregationCode, Custom_Tracer Tracer ) : bool
Alias	string	Alias string which will forward to a item aggregation
AggregationCode	string	Code for the item aggregation to forward to
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Save_Default_Metadata() public static method

Saves a new default metadata set, or edits an existing default metadata name

This calls the 'mySobek_Save_DefaultMetadata' stored procedure

public static Save_Default_Metadata ( string Code, string Name, string Description, int UserID, Custom_Tracer Tracer ) : bool
Code	string	Code for the new default metadata set, or set to edit
Name	string	Name for this default metadata set
Description	string	Full description for this default metadata set
UserID	int	UserID, if this is not a global default metadata set
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Save_Icon() public static method

Saves information about a new icon/wordmark or modify an existing one

This calls the 'SobekCM_Save_Icon' stored procedure

public static Save_Icon ( string IconName, string IconFile, string IconLink, int Height, string IconTitle, Custom_Tracer Tracer ) : int
IconName	string	Code identifier for this icon/wordmark
IconFile	string	Filename for this icon/wordmark
IconLink	string	Link that clicking on this icon/wordmark will forward the user to
Height	int	Height for this icon/wordmark
IconTitle	string	Title for this icon, which appears when you hover over the icon
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Save_Icon() public static method

Saves information about a new icon/wordmark or modify an existing one

This calls the 'SobekCM_Save_Icon' stored procedure

public static Save_Icon ( string IconName, string IconFile, string IconLink, string IconTitle, Custom_Tracer Tracer ) : int
IconName	string	Code identifier for this icon/wordmark
IconFile	string	Filename for this icon/wordmark
IconLink	string	Link that clicking on this icon/wordmark will forward the user to
IconTitle	string	Title for this icon, which appears when you hover over the icon
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Save_Item_Aggregation_Milestone() public static method

Add a new milestone to an existing item aggregation

This calls the 'SobekCM_Add_Item_Aggregation_Milestone' stored procedure

public static Save_Item_Aggregation_Milestone ( string AggregationCode, string Milestone, string User ) : bool
AggregationCode	string	Item aggregation code
Milestone	string	Milestone to add to this item aggregation
User	string	User name which performed this work
return	bool

Save_Project() public static method

Save a new, or edit an existing Project in the database

public static Save_Project ( Custom_Tracer Tracer, int ProjectID, string ProjectCode, string ProjectName, string ProjectManager, string GrantID, System.DateTime StartDate, System.DateTime EndDate, bool isActive, string Description, string Specifications, string Priority, string QcProfile, int TargetItemCount, int TargetPageCount, string Comments, string CopyrightPermissions ) : int
Tracer	SobekCM.Tools.Custom_Tracer
ProjectID	int
ProjectCode	string
ProjectName	string
ProjectManager	string
GrantID	string
StartDate	System.DateTime
EndDate	System.DateTime
isActive	bool
Description	string
Specifications	string
Priority	string
QcProfile	string
TargetItemCount	int
TargetPageCount	int
Comments	string
CopyrightPermissions	string
return	int

Save_Template() public static method

Saves a new template, or edits an existing template name

This calls the 'mySobek_Save_Template' stored procedure

public static Save_Template ( string Code, string Name, string Description, Custom_Tracer Tracer ) : bool
Code	string	Code for the new template, or template to edit
Name	string	Name for this template
Description	string	Complete description of this template
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Save_User() public static method

Saves information about a single user

This calls the 'mySobek_Save_User' stored procedure

public static Save_User ( SobekCM.Library.Users.User_Object User, string Password, User_Authentication_Type_Enum AuthenticationType, Custom_Tracer Tracer ) : bool
User	SobekCM.Library.Users.User_Object	with all the information about the single user
Password	string	Plain-text password, which is then encrypted prior to saving
AuthenticationType	User_Authentication_Type_Enum	String which indicates the type of authentication utilized, only important if this is the first time this user has authenticated/registered
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Save_User_Group() public static method

Sets some of the basic information and global permissions values for a single user group

This calls the 'mySobek_Save_User_Group' stored procedure

public static Save_User_Group ( int UserGroupID, string GroupName, string GroupDescription, bool CanSubmit, bool IsInternal, bool CanEditAll, bool IsSystemAdmin, bool IsPortalAdmin, bool IncludeTrackingStandardForms, bool ClearMetadataTemplates, bool ClearAggregationLinks, bool ClearEditableLinks, bool IsSobekDefault, bool IsShibbolethDefault, bool IsLdapDefault, Custom_Tracer Tracer ) : int
UserGroupID	int	Primary key for this user group from the database, or -1 for a new user group
GroupName	string	Name of this user group
GroupDescription	string	Basic description of this user group
CanSubmit	bool	Flag indicates if this user group can submit items
IsInternal	bool	Flag indicates if this user group is considered an 'internal user'
CanEditAll	bool	Flag indicates if this user group is authorized to edit all items in the library
IsSystemAdmin	bool	Flag indicates if this user group is a system Administrator
IsPortalAdmin	bool	Flag indicated if this user group is a portal administrator
IncludeTrackingStandardForms	bool	Should this user's settings include the tracking form portions?
ClearMetadataTemplates	bool	Flag indicates whether to clear default metadata sets and templates for this user group
ClearAggregationLinks	bool	Flag indicates whether to clear item aggregationPermissions linked to this user group
ClearEditableLinks	bool	Flag indicates whether to clear the link between this user group and editable regex expressions
IsSobekDefault	bool
IsShibbolethDefault	bool
IsLdapDefault	bool
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Save_User_Search() public static method

Saves a search to the user's saved searches

This calls the 'mySobek_Save_User_Search' stored procedure

public static Save_User_Search ( int UserID, string SearchUrl, string SearchDescription, int ItemOrder, string UserNotes, Custom_Tracer Tracer ) : int
UserID	int	Primary key for this user in the database
SearchUrl	string	SobekCM search URL
SearchDescription	string	Programmatic description of this search
ItemOrder	int	Order for this search within the folder
UserNotes	string	Notes from the user about this search
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	int

Save_Web_Skin() public static method

Saves a HTML skin to the database

This calls the 'SobekCM_Add_Web_Skin' stored procedure

public static Save_Web_Skin ( string SkinCode, string BaseSkinCode, bool OverrideBanner, bool OverrideHeaderFooter, string BannerLink, string Notes, bool SuppressTopNavigation, Custom_Tracer Tracer ) : bool
SkinCode	string	Code for this HTML skin
BaseSkinCode	string	Base skin code from which this html skin inherits
OverrideBanner	bool	Flag indicates this skin overrides the default banner
OverrideHeaderFooter	bool	Flag indicates this skin overrides the default header/footer
BannerLink	string	Link to which the banner sends the user
Notes	string	Notes on this skin ( name, use, etc...)
SuppressTopNavigation	bool	Flag indicates if the top-level aggregation navigation should be suppressed for this web skin ( i.e., is the top-level navigation embedded into the header file already? )
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Set_Aggregation_NewItem_Flag() public static method

method used to set the new items flag of a specified item aggregation

This method calls the stored procedure 'SobekCM_Set_Aggregation_NewItem_Flag'.

public static Set_Aggregation_NewItem_Flag ( string AggregationCode, bool NewItemFlag ) : bool
AggregationCode	string	Code for this SobekCM item aggregation
NewItemFlag	bool	Status for the new item flag
return	bool

Set_Item_Main_Thumbnail() public static method

Sets the main thumbnail for a given digital resource

This calls the 'SobekCM_Set_Main_Thumbnail' stored procedure

public static Set_Item_Main_Thumbnail ( string BibID, string VID, string MainThumbnail ) : bool
BibID	string	Bibliographic identifier for the item
VID	string	Volume identifier for the item
MainThumbnail	string	Filename for the new main thumbnail
return	bool

Set_Setting() public static method

Sets a value in the settings table

This calls the 'SobekCM_Set_Setting_Value' stored procedure

public static Set_Setting ( string SettingKey, string SettingValue ) : bool
SettingKey	string	Key for the setting to update or insert
SettingValue	string	Value for the setting to update or insert
return	bool

Set_User_Receive_Stats_Email() public static method

Updates the flag that indicates the user would like to receive a monthly usage statistics email

This calls the 'mySobek_Set_Receive_Stats_Email_Flag' stored procedure

public static Set_User_Receive_Stats_Email ( int UserID, bool NewFlag, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user in the database
NewFlag	bool	New value for the flag
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Set_User_Setting() public static method

Sets a value for an individual user's setting

This calls the 'SobekCM_Set_User_Setting_Value' stored procedure

public static Set_User_Setting ( int UserID, string SettingKey, string SettingValue ) : bool
UserID	int	Primary key for this user in the database
SettingKey	string	Key for the setting to update or insert
SettingValue	string	Value for the setting to update or insert
return	bool

Statistics_Aggregation_Titles() public static method

Pulls the most often hit titles and items, by item aggregation

This calls the 'SobekCM_Statistics_Aggregation_Titles' stored procedure

This is used by the Statistics_HtmlSubwriter class

public static Statistics_Aggregation_Titles ( string AggregationCode, Custom_Tracer Tracer ) : DataSet
AggregationCode	string	Code for the item aggregation of interest
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataSet

Statistics_By_Date_Range() public static method

Pulls the complete usage statistics, broken down by each level of the item aggregation hierarchy, between two dates

This calls the 'SobekCM_Statistics_By_Date_Range' stored procedure

This is used by the Statistics_HtmlSubwriter class

public static Statistics_By_Date_Range ( int Early_Year, int Early_Month, int Last_Year, int Last_Month, Custom_Tracer Tracer ) : DataTable
Early_Year	int	Year portion of the start date
Early_Month	int	Month portion of the start date
Last_Year	int	Year portion of the last date
Last_Month	int	Month portion of the last date
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

Test_Connection() public static method

Test connectivity to the database

public static Test_Connection ( ) : bool
return	bool

Test_Connection() public static method

Test connectivity to the database

public static Test_Connection ( string TestConnectionString ) : bool
TestConnectionString	string
return	bool

Tracking_Delete_Workflow() public static method

public static Tracking_Delete_Workflow ( int WorkflowID ) : void
WorkflowID	int
return	void

Tracking_Get_All_Entries_By_User() public static method

Gets all tracking workflow entries created by a single user

public static Tracking_Get_All_Entries_By_User ( string Username ) : DataTable
Username	string	User Name
return	System.Data.DataTable

Tracking_Get_Item_Info_from_ItemID() public static method

Gets the corresponding BibID, VID for a given itemID

public static Tracking_Get_Item_Info_from_ItemID ( int ItemID ) : DataRow
ItemID	int	Primary identifier for this item from the database
return	System.Data.DataRow

Tracking_Get_Open_Workflows() public static method

Gets the related workflows for an item by ItemID

public static Tracking_Get_Open_Workflows ( int ItemID, int EventNum ) : DataTable
ItemID	int	Primary key for this item in the database
EventNum	int	Number of the event
return	System.Data.DataTable

Tracking_Get_Scanners_List() public static method

Gets the list of users who are Scanning or Processing Technicians

public static Tracking_Get_Scanners_List ( ) : DataTable
return	System.Data.DataTable

Tracking_Get_Users_Scanning_Processing() public static method

Gets the list of users who are Scanning or Processing Technicians

public static Tracking_Get_Users_Scanning_Processing ( ) : DataTable
return	System.Data.DataTable

Tracking_Save_New_Workflow() public static method

Save a new workflow entry during tracking

public static Tracking_Save_New_Workflow ( int ItemID, string WorkPerformedBy, string RelatedEquipment, System.DateTime DateStarted, System.DateTime DateCompleted, int EventNum, int StartEvent, int EndEvent, int StartEndEvent ) : int
ItemID	int
WorkPerformedBy	string
RelatedEquipment	string
DateStarted	System.DateTime
DateCompleted	System.DateTime
EventNum	int
StartEvent	int
EndEvent	int
StartEndEvent	int
return	int

Tracking_Update_Workflow() public static method

Update an already saved tracking workflow entry

public static Tracking_Update_Workflow ( int WorkflowID, int ItemID, string WorkPerformedBy, System.DateTime DateStarted, System.DateTime DateCompleted, string RelatedEquipment, int EventNumber, int StartEventNumber, int EndEventNum ) : void
WorkflowID	int
ItemID	int
WorkPerformedBy	string
DateStarted	System.DateTime
DateCompleted	System.DateTime
RelatedEquipment	string
EventNumber	int
StartEventNumber	int
EndEventNum	int
return	void

Update_Additional_Work_Needed_Flag() public static method

Update the additional work neeed flag, which flag an item for additional follow up work in the builder

This calls the 'SobekCM_Update_Additional_Work_Needed_Flag' stored procedure

public static Update_Additional_Work_Needed_Flag ( int ItemID, bool NewFlag, Custom_Tracer Tracer ) : bool
ItemID	int	Primary key for the item for which to update the additional work needed flag
NewFlag	bool	New flag for the additional follow up work
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_Item_Aggregation() public static method

Updates an existing item aggregation's data that appears in the basic edit aggregation form

This calls the 'SobekCM_Update_Item_Aggregation' stored procedure in the SobekCM database

public static Update_Item_Aggregation ( string Code, string Name, string ShortName, bool IsActive, bool IsHidden, string ExternalLink, Custom_Tracer Tracer ) : bool
Code	string	Code for this item aggregation
Name	string	Name for this item aggregation
ShortName	string	Short version of this item aggregation
IsActive	bool	Flag indicates if this item aggregation is active
IsHidden	bool	Flag indicates if this item is hidden
ExternalLink	string	External link for this item aggregation (usually used for institutional aggregationPermissions)
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User() public static method

Sets some of the permissions values for a single user

This calls the 'mySobek_Update_User' stored procedure

public static Update_SobekCM_User ( int UserID, bool CanSubmit, bool IsInternal, bool CanEditAll, bool CanDeleteAll, bool IsSystemAdmin, bool IsHostAdmin, bool IsPortalAdmin, bool IncludeTrackingStandardForms, string EditTemplate, string EditTemplateMarc, bool ClearProjectsTemplates, bool ClearAggregationLinks, bool ClearUserGroups, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user from the database
CanSubmit	bool	Flag indicates if this user can submit items
IsInternal	bool	Flag indicates if this user is considered an 'internal user'
CanEditAll	bool	Flag indicates if this user is authorized to edit all items in the library
CanDeleteAll	bool	Flag indicates if this user can delete anything in the repository
IsSystemAdmin	bool	Flag indicates if this user is a system Administrator
IsHostAdmin	bool	Flag indicates if this used is the host administrator (if this is a hosted instance)
IsPortalAdmin	bool	Flag indicates if this user is a portal Administrator
IncludeTrackingStandardForms	bool	Flag indicates if this user should have tracking portions appear in their standard forms
EditTemplate	string	CompleteTemplate name for editing non-MARC records
EditTemplateMarc	string	CompleteTemplate name for editing MARC-derived records
ClearProjectsTemplates	bool	Flag indicates whether to clear projects and templates for this user
ClearAggregationLinks	bool	Flag indicates whether to clear item aggregationPermissions linked to this user
ClearUserGroups	bool	Flag indicates whether to clear user group membership for this user
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User_Aggregations() public static method

Sets the list of aggregationPermissions and permissions tagged to a given user

This calls the 'SobekCM_Add_User_Aggregations_Link' stored procedure

public static Update_SobekCM_User_Aggregations ( int UserID, List Aggregations, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user from the database
Aggregations	List	List of aggregationPermissions and permissions to link to this user
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User_DefaultMetadata() public static method

Sets the list of default metadata sets possible for a given user

This calls the 'mySobek_Add_User_DefaultMetadata_Link' stored procedure

public static Update_SobekCM_User_DefaultMetadata ( int UserID, ReadOnlyCollection MetadataSets, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user from the database
MetadataSets	ReadOnlyCollection	List of default metadata sets to link to this user
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User_Group_Aggregations() public static method

Sets the list of aggregationPermissions and permissions tagged to a given user group

This calls the 'SobekCM_Add_User_Group_Aggregations_Link' stored procedure

public static Update_SobekCM_User_Group_Aggregations ( int UserGroupID, List Aggregations, Custom_Tracer Tracer ) : bool
UserGroupID	int	Primary key for this user group from the database
Aggregations	List	List of aggregationPermissions and permissions to link to this user group
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User_Group_DefaultMetadata() public static method

Sets the list of default metadata sets possible for a given user group

This calls the 'mySobek_Add_User_Group_Metadata_Link' stored procedure

public static Update_SobekCM_User_Group_DefaultMetadata ( int UserGroupID, List MetadataSets, Custom_Tracer Tracer ) : bool
UserGroupID	int	Primary key for this user group from the database
MetadataSets	List	List of default metadata sets to link to this user group
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User_Group_Templates() public static method

Sets the list of templates possible for a given user group

This calls the 'mySobek_Add_User_Group_Templates_Link' stored procedure

public static Update_SobekCM_User_Group_Templates ( int UserGroupID, List Templates, Custom_Tracer Tracer ) : bool
UserGroupID	int	Primary key for this user group from the database
Templates	List	List of templates to link to this user group
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

Update_SobekCM_User_Templates() public static method

Sets the list of templates possible for a given user

This calls the 'mySobek_Add_User_Templates_Link' stored procedure

public static Update_SobekCM_User_Templates ( int UserID, ReadOnlyCollection Templates, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for this user from the database
Templates	ReadOnlyCollection	List of templates to link to this user
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

UserName_Exists() public static method

Checks to see if a username or email exist

This calls the 'mySobek_UserName_Exists' stored procedure

This is used to enforce uniqueness during registration

public static UserName_Exists ( string UserName, string Email, bool &UserNameExists, bool &EmailExists, Custom_Tracer Tracer ) : bool
UserName	string	Username to check
Email	string	Email address to check
UserNameExists	bool	[OUT] Flag indicates if the username exists
EmailExists	bool	[OUT] Flag indicates if the email exists
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

User_Set_Aggregation_Home_Page_Flag() public static method

Sets the flag indicating an aggregation should appear on a user's home page

This calls the 'mySobek_Set_Aggregation_Home_Page_Flag' stored procedure

public static User_Set_Aggregation_Home_Page_Flag ( int UserID, int AggregationID, bool NewFlag, Custom_Tracer Tracer ) : bool
UserID	int	Primary key for the user
AggregationID	int	Primary key for the aggregation
NewFlag	bool	New flag indicates if this should be on the home page
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	bool

View_Tags_By_Aggregation() public static method

List all descriptive tags added by a single user

This calls the 'SobekCM_Get_Description_Tags_By_Aggregation' stored procedure

public static View_Tags_By_Aggregation ( string AggregationCode, Custom_Tracer Tracer ) : DataTable
AggregationCode	string	Aggregation code for which to pull all descriptive tags added
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable

View_Tags_By_User() public static method

List all descriptive tags added by a single user

This calls the 'mySobek_View_All_User_Tags' stored procedure

public static View_Tags_By_User ( int UserID, Custom_Tracer Tracer ) : DataTable
UserID	int	Primary key for the user that entered the descriptive tags (or -1 to get ALL tags)
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	System.Data.DataTable