C# Class Rock.Data.MigrationHelper

Helper Class for updating Rock entities during migrations

Mostrar archivo Open project: SparkDevNetwork/Rock

Public Methods

Method	Description
AddActionTypeAttributeValue ( string actionTypeGuid, string attributeGuid, string value ) : void	Adds the action type attribute value.
AddActionTypePersonAttributeValue ( string actionTypeGuid, string attributeGuid, string value ) : void	Adds an action type person attribute value. Because there's not a way to link to another person in the target database, person attribute values are just set to the first person alias record in the target database which will most likely be the Admin, Admin record.
AddAttributeQualifier ( string attributeGuid, string key, string value, string guid ) : void	Adds the attribute qualifier.
AddAttributeValue ( string attributeGuid, int entityId, string value, string guid ) : void	Adds a new attribute value for the given attributeGuid if it does not already exist.
AddBlock ( string pageGuid, string layoutGuid, string blockTypeGuid, string name, string zone, string preHtml, string postHtml, int order, string guid ) : void	Adds a new Block of the given block type to the given page (optional) and layout (optional), setting its values with the given parameter values. If only the layout is given, edit/configuration authorization will also be inserted into the Auth table for the admin role (GroupId 2).
AddBlockAttributeValue ( string blockGuid, string attributeGuid, string value, bool appendToExisting = false ) : void	Adds a new block attribute value for the given block guid and attribute guid, deleting any previously existing attribute value first.
AddBlockType ( string name, string description, string path, string category, string guid ) : void	Adds a new BlockType.
AddBlockTypeAttribute ( string blockTypeGuid, string fieldTypeGuid, string name, string key, string category, string description, int order, string defaultValue, string guid, bool isRequired = false ) : void	Adds a new BlockType Attribute for the given blocktype and key.
AddDefinedType ( string category, string name, string description, string guid, string helpText = null ) : void	Adds a new DefinedType.
AddDefinedTypeAttribute ( string definedTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void	Adds the defined type attribute.
AddDefinedType_pre201409101843015 ( string category, string name, string description, string guid, string helpText = null ) : void	Adds the defined type_pre201409101843015.
AddDefinedValue ( string definedTypeGuid, string value, string description ) : void	Adds the defined value.
AddDefinedValue ( string definedTypeGuid, string value, string description, string guid, bool isSystem = true ) : void	Adds a new DefinedValue for the given DefinedType.
AddDefinedValueAttributeValue ( string definedValueGuid, string attributeGuid, string value ) : void	Adds the defined value attribute value.
AddDefinedValueAttributeValueByName_pre20140819 ( string definedTypeGuid, string definedValueName, string attributeKey, string value ) : void	Adds the name of the defined value attribute value by.
AddDefinedValueAttributeValueByValue ( string definedTypeGuid, string definedValueValue, string attributeKey, string value ) : void	Adds the name of the defined value attribute value by.
AddDefinedValue_pre20140819 ( string definedTypeGuid, string name, string description, string guid, bool isSystem = true ) : void	Adds a new DefinedValue for the given DefinedType.
AddEntityAttribute ( string entityTypeName, string fieldTypeGuid, string entityTypeQualifierColumn, string entityTypeQualifierValue, string name, string category, string description, int order, string defaultValue, string guid, string key = null ) : void	Adds a new EntityType Attribute for the given EntityType, FieldType, and name (key).
AddGlobalAttribute ( string fieldTypeGuid, string entityTypeQualifierColumn, string entityTypeQualifierValue, string name, string description, int order, string defaultValue, string guid, string key = null ) : void	Adds a global Attribute for the given FieldType, entityTypeQualifierColumn, entityTypeQualifierValue and name (key). Note: This method delets the Attribute first if it had already existed.
AddGroupMemberAttributeDefinedValue ( string groupGuid, string name, string description, int order, string defaultValue, bool isGridColumn, bool isMultiValue, bool isRequired, string definedTypeGuid, string guid, bool isSystem = true ) : void	Adds or updates a group member Attribute for the given group for storing a particular defined value. The defined values are constrained by the given defined type.
AddGroupType ( string name, string description, string groupTerm, string groupMemberTerm, bool allowMultipleLocations, bool showInGroupList, bool showInNavigation, string iconCssClass, int order, string inheritedGroupTypeGuid, int locationSelectionMode, string groupTypePurposeValueGuid, string guid, bool isSystem = true ) : void	Adds or Updates the GroupType for the given guid (if it exists); otherwise it inserts a new record.
AddGroupTypeGroupAttribute ( string groupTypeGuid, string fieldTypeGuid, string name, string description, int order, string defaultValue, string guid ) : void	Adds a new GroupType "Group Attribute" for the given GroupType using the given values.
AddGroupTypeRole ( string groupTypeGuid, string name, string description, int order, int maxCount, int minCount, string guid, bool isSystem = true, bool isLeader = false, bool isDefaultGroupTypeRole = false ) : void	Adds or Updates the GroupTypeRole for the given guid (if it exists); otherwise it inserts a new record. Can also set the role as the default for the given GroupType if isDefaultGroupTypeRole is set to true.
AddLayout ( string siteGuid, string fileName, string name, string description, string guid ) : void	Adds a new Layout to the given site if it doesn't already exist (by Guid), otherwise it updates it
AddPage ( string parentPageGuid, string layoutGuid, string name, string description, string guid, string iconCssClass = "", string insertAfterPageGuid = "" ) : void	Adds a new Page to the given parent page. The new page will be ordered as last child of the parent page.
AddPageRoute ( string pageGuid, string route ) : void	Adds a new PageRoute to the given page but only if the given route name does not exist.
AddPageRoute ( string pageGuid, string route, string guid ) : void	Adds a new PageRoute to the given page but only if the given route name does not exist.
AddPersonBadgeAttribute ( string personBadgeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void	Adds (or Deletes and Adds) the person badge attribute.
AddPersonBadgeAttributeValue ( string personBadgeGuid, string attributeGuid, string value ) : void	Adds/Updates the person badge attribute value.
AddReport ( string categoryGuid, string dataViewGuid, string entityTypeGuid, string name, string description, string guid, int fetchTop = null ) : void	Adds a report.
AddReportField ( string reportGuid, Rock reportFieldType, bool showInGrid, string dataSelectComponentEntityTypeGuid, string selection, int order, string columnHeaderText, string guid ) : void	Adds a report field to a report
AddRestAction ( string controllerName, string controllerClass, string actionMethod, string actionPath ) : void	Adds the rest action.
AddRestController ( string controllerName, string controllerClass ) : void	Adds the rest controller.
AddSecurityAuth ( string entityTypeName, string action, string groupGuid, string authGuid ) : void	Adds the security auth record for the given entity type and group.
AddSecurityAuthForAttribute ( string attributeGuid, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void	Adds the attribute security authentication. Set GroupGuid to null when setting to a special role
AddSecurityAuthForBinaryFileType ( string binaryFileTypeGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the binaryfiletype security authentication. Set GroupGuid to null when setting to a special role
AddSecurityAuthForBlock ( string blockGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the page security authentication. Set GroupGuid to null when setting to a special role
AddSecurityAuthForCalendar ( string calendarGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the security authentication for calendar.
AddSecurityAuthForCategory ( string categoryGuid, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void	Adds the category security authentication. Set GroupGuid to null when setting to a special role
AddSecurityAuthForContentChannel ( string contentChannelGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the security authentication for content channel.
AddSecurityAuthForEntityType ( string entityTypeName, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void	Adds the security auth record for the given entity type and group.
AddSecurityAuthForGroupType ( string groupTypeGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the page security authentication. Set GroupGuid to null when setting to a special role
AddSecurityAuthForPage ( string pageGuid, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void	Adds the page security authentication. Set GroupGuid to null when setting to a special role
AddSecurityAuthForRestAction ( string restActionMethod, string restActionPath, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the security authentication for rest action.
AddSecurityAuthForRestController ( string restControllerClass, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void	Adds the security authentication for rest controller.
AddSecurityRoleGroup ( string name, string description, string guid ) : void	Adds the security role group.
AddSite ( string name, string description, string theme, string guid ) : void	Adds a new Layout to the given site.
CreateWorkflowTrigger ( string entityTypeName, WorkflowTriggerType triggerType, string qualifierColumn, string qualifierValue, string workflowTypeGuid, string description, string guid = null ) : void	Creates the workflow trigger.
DeleteAttribute ( string guid ) : void	Deletes the attribute.
DeleteAttributeValuesByWorkflowAction ( string workflowActionGuid ) : void	Deletes the attribute values by workflow action guid.
DeleteAttributesByEntityType ( string entityTypeGuid ) : void	Deletes the attributes by entity type.
DeleteBlock ( string guid ) : void	Deletes the block and any authorization records that belonged to it.
DeleteBlockAttribute ( string guid ) : void	Deletes the block Attribute.
DeleteBlockAttributeValue ( string blockGuid, string attributeGuid ) : void	Deletes the block attribute value.
DeleteBlockType ( string guid ) : void	Deletes the BlockType.
DeleteByGuid ( string guid, string tableName ) : void	Deletes from the table by the by unique identifier.
DeleteCategory ( string guid ) : void	Deletes the category.
DeleteDefinedType ( string guid ) : void	Deletes the DefinedType.
DeleteDefinedValue ( string guid ) : void	Deletes the DefinedValue.
DeleteEntityType ( string guid ) : void	Deletes the EntityType.
DeleteFieldType ( string guid ) : void	Deletes the FieldType.
DeleteGroup ( string guid, bool orphanAnyChildren = true ) : void	Deletes the group.
DeleteGroupType ( string guid ) : void	Deletes the GroupType.
DeleteGroupTypeRole ( string guid ) : void	Deletes the GroupTypeRole.
DeleteLayout ( string guid ) : void	Deletes the Layout.
DeletePage ( string guid ) : void	Deletes the Page and any PageViews that use the page.
DeletePageContext ( string guid ) : void	Deletes the page context.
DeleteReport ( string guid ) : void	Deletes the report
DeleteReportField ( string guid ) : void	Deletes the report field.
DeleteSecurityAuth ( string guid ) : void	Deletes the security auth record.
DeleteSecurityAuthForAttribute ( string attributeGuid ) : void	Deletes the security authentication for page.
DeleteSecurityAuthForBlock ( string blockGuid ) : void	Deletes the security authentication for block.
DeleteSecurityAuthForCategory ( string categoryGuid ) : void	Deletes the security authentication for category.
DeleteSecurityAuthForGroupType ( string groupTypeGuid ) : void	Deletes the security authentication for groupType.
DeleteSecurityAuthForPage ( string pageGuid ) : void	Deletes the security authentication for page.
DeleteSecurityRoleGroup ( string guid ) : void	Deletes the security role group.
DeleteSite ( string guid ) : void	Deletes the Layout.
DeleteSystemEmail ( string guid ) : void	Deletes the SystemEmail.
DeleteWorkflowActionType ( string guid ) : void	Deletes the type of the workflow action.
DeleteWorkflowActivityType ( string guid ) : void	Deletes the type of the workflow activity.
DeleteWorkflowTriggersByWorkflowCategory ( string workflowCategoryGuid ) : void	Deletes workflow triggers that reference a workflow type that has a category defined by the given guid.
DeleteWorkflowType ( string guid ) : void	Deletes the type of the workflow.
MigrationHelper ( IMigration migration ) : System	Initializes a new instance of the MigrationHelper class.
MovePage ( string pageGuid, string parentPageGuid ) : void	Moves the Page to the new given parent page.
RenameBlockType ( string oldPath, string newPath, string newCategory = null, string newName = null, string newDescription = null ) : void	Renames the type of the block.
UpdateAttributeQualifier ( string attributeGuid, string key, string value, string guid ) : void	Updates the attribute qualifier.
UpdateBinaryFileType ( string storageEntityTypeId, string name, string description, string iconCssClass, string guid, bool allowCaching = false, bool requiresViewSecurity = false ) : void	Updates the type of the binary file.
UpdateBlockType ( string name, string description, string path, string category, string guid ) : void	Updates the BlockType by path (if it exists); otherwise it inserts a new record. In either case it will be marked IsSystem.
UpdateBlockTypeAttribute ( string blockTypeGuid, string fieldTypeGuid, string name, string key, string category, string description, int order, string defaultValue, string guid ) : void	Updates the BlockType Attribute for the given blocktype and key (if it exists); otherwise it inserts a new record.
UpdateCategory ( string entityTypeGuid, string name, string iconCssClass, string description, string guid, int order, string parentCategoryGuid = "" ) : void	Updates the category or adds if it doesn't already exist (based on Guid)
UpdateCategoryByName ( string entityTypeGuid, string name, string iconCssClass, string description, string guid, int order ) : void	Updates the category or adds if it doesn't already exist (based on Name)
UpdateDefinedValue ( string definedTypeGuid, string value, string description, string guid, bool isSystem = true, int foreignId = null, string foreignKey = "" ) : void	Updates (or Adds) the defined value for the given DefinedType.
UpdateDefinedValueAttributeValue ( string definedValueGuid, string attributeGuid, string value ) : void	Adds the defined value attribute value.
UpdateDefinedValueByName_pre20140819 ( string definedTypeGuid, string name, string description, int order, bool isSystem = true ) : void	Updates the name of the defined value by.
UpdateDefinedValueByValue ( string definedTypeGuid, string value, string description, int order, bool isSystem = true ) : void	Updates the name of the defined value by.
UpdateDefinedValue_pre20140819 ( string definedTypeGuid, string name, string description, string guid, bool isSystem = true ) : void	Updates (or Adds) the defined value for the given DefinedType.
UpdateEntityAttribute ( string modelEntityTypeName, string componentEntityTypeName, string fieldTypeGuid, string name, string description, int order, string defaultValue, string guid, string key = null ) : void	Updates the entity attribute.
UpdateEntityAttribute ( string entityTypeName, string fieldTypeGuid, string entityTypeQualifierColumn, string entityTypeQualifierValue, string name, string description, int order, string defaultValue, string guid, string key = null ) : void	Updates the Entity Attribute for the given EntityType, FieldType, and name (key). otherwise it inserts a new record.
UpdateEntityType ( string name, string guid, bool isEntity, bool isSecured ) : void	Updates the EntityType by name (if it exists); otherwise it inserts a new record.
UpdateEntityType ( string name, string friendlyName, string assemblyName, bool isEntity, bool isSecured, string guid ) : void	Updates the EntityType by name (if it exists); otherwise it inserts a new record.
UpdateEntityTypeMultiValueFieldType ( string entityTypeName, string fieldTypeGuid ) : void	Updates the EntityType MultiValueFieldType
UpdateEntityTypeSingleValueFieldType ( string entityTypeName, string fieldTypeGuid ) : void	Updates the EntityType SingleValueFieldType
UpdateFieldType ( string name, string description, string assembly, string className, string guid, bool IsSystem = true ) : void	Updates the FieldType by assembly and className (if it exists); otherwise it inserts a new record.
UpdateGroup ( string parentGroupGuid, string groupTypeGuid, string name, string description, string campusGuid, int order, string guid, bool isSystem = true, bool isSecurityRole = false, bool isActive = true ) : void	Updates the Group for the given guid (if it exists); otherwise it inserts a new record.
UpdateGroupMemberAttributeDefinedValue ( string groupGuid, string name, string description, int order, string defaultValue, bool isGridColumn, bool isMultiValue, bool isRequired, string definedTypeGuid, string guid, bool isSystem = true ) : void	Adds or updates a group member Attribute for the given group for storing a particular defined value. The defined values are constrained by the given defined type.
UpdateGroupType ( string name, string description, string groupTerm, string groupMemberTerm, string defaultGroupRoleGuid, bool allowMultipleLocations, bool showInGroupList, bool showInNavigation, string iconCssClass, int order, string inheritedGroupTypeGuid, int locationSelectionMode, string groupTypePurposeValueGuid, string guid, bool isSystem = true ) : void	Adds or Updates the GroupType for the given guid (if it exists); otherwise it inserts a new record.
UpdateGroupTypeRole ( string groupTypeGuid, string name, string description, int order, int maxCount, int minCount, string guid, bool isSystem = true, bool isLeader = false, bool isDefaultGroupTypeRole = false ) : void	Adds or Updates the GroupTypeRole for the given guid (if it exists); otherwise it inserts a new record. Can also set the role as the default for the given GroupType if isDefaultGroupTypeRole is set to true.
UpdateHtmlContentBlock ( string blockGuid, string htmlContent, string guid ) : void	Add or Updates the HTML content for an HTML Content Block
UpdateLayout ( string siteGuid, string fileName, string name, string description, string guid, bool IsSystem = true ) : void	Updates the layout file for the Site to have a known Guid and update the Name, Description and IsSystem
UpdatePageContext ( string pageGuid, string entity, string idParameter, string guid ) : void	Adds or Updates PageContext to the given page, entity, idParameter
UpdatePersonAttribute ( string fieldTypeGuid, string categoryGuid, string name, string key, string iconCssClass, string description, int order, string defaultValue, string guid ) : void	Updates the Person Attribute for the given key (if it exists); otherwise it inserts a new record.
UpdatePersonAttributeCategory ( string name, string iconCssClass, string description, string guid, int order ) : void	Updates the person attribute category.
UpdatePersonBadge ( string name, string description, string entityTypeName, int order, string guid ) : void	Updates the PersonBadge by Guid (if it exists); otherwise it inserts a new record.
UpdateSystemEmail ( string category, string title, string from, string fromName, string to, string cc, string bcc, string subject, string body, string guid ) : void	Updates or Inserts the system email.
UpdateSystemEmail_pre201409101843015 ( string category, string title, string from, string fromName, string to, string cc, string bcc, string subject, string body, string guid ) : void	Updates the system email_pre201409101843015.
UpdateWorkflowActionEntityAttribute ( string actionEntityTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void	Updates the workflow action entity attribute.
UpdateWorkflowActionForm ( string header, string footer, string actions, string systemEmailGuid, bool includeActionsInNotification, string actionAttributeGuid, string guid ) : void	Updates the workflow action form.
UpdateWorkflowActionFormAttribute ( string actionFormGuid, string attributeGuid, int order, bool isVisible, bool isReadOnly, bool isRequired, bool hideLabel, string preHtml, string postHtml, string guid ) : void	Updates the workflow action form attribute.
UpdateWorkflowActionFormAttribute ( string actionFormGuid, string attributeGuid, int order, bool isVisible, bool isReadOnly, bool isRequired, string guid ) : void	Updates the workflow action form attribute.
UpdateWorkflowActionType ( string activityTypeGuid, string name, int order, string entityTypeGuid, bool isActionCompletedOnSuccess, bool isActivityCompletedOnSuccess, string workflowFormGuid, string criteriaAttributeGuid, int criteriaComparisonType, string criteriaValue, string guid ) : void	Updates the type of the workflow action.
UpdateWorkflowActivityType ( string WorkflowTypeGuid, bool isActive, string name, string description, bool isActivatedWithWorkflow, int order, string guid ) : void	Updates the type of the workflow activity.
UpdateWorkflowActivityTypeAttribute ( string workflowActivityTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void	Updates the workflow activity type attribute.
UpdateWorkflowType ( bool isSystem, bool isActive, string name, string description, string categoryGuid, string workTerm, string iconCssClass, int processingIntervalSeconds, bool isPersisted, int loggingLevel, string guid, int order ) : void	Updates the type of the workflow.
UpdateWorkflowTypeAttribute ( string workflowTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void	Updates the workflow type attribute.

Private Methods

Method	Description
EnsureEntityTypeExists ( string entityTypeName, bool isEntity = true, bool isSecured = true ) : void	Ensures the entity type exists by adding it by name if it did not already exist.

Method Details

AddActionTypeAttributeValue() public method

Adds the action type attribute value.

public AddActionTypeAttributeValue ( string actionTypeGuid, string attributeGuid, string value ) : void
actionTypeGuid	string	The action type unique identifier.
attributeGuid	string	The attribute unique identifier.
value	string	The value.
return	void

AddActionTypePersonAttributeValue() public method

Adds an action type person attribute value. Because there's not a way to link to another person in the target database, person attribute values are just set to the first person alias record in the target database which will most likely be the Admin, Admin record.

public AddActionTypePersonAttributeValue ( string actionTypeGuid, string attributeGuid, string value ) : void
actionTypeGuid	string	The action type unique identifier.
attributeGuid	string	The attribute unique identifier.
value	string	The value.
return	void

AddAttributeQualifier() public method

Adds the attribute qualifier.

public AddAttributeQualifier ( string attributeGuid, string key, string value, string guid ) : void
attributeGuid	string	The attribute unique identifier.
key	string	The key.
value	string	The value.
guid	string	The unique identifier.
return	void

AddAttributeValue() public method

Adds a new attribute value for the given attributeGuid if it does not already exist.

public AddAttributeValue ( string attributeGuid, int entityId, string value, string guid ) : void
attributeGuid	string	The attribute GUID.
entityId	int	The entity id.
value	string	The value.
guid	string	The GUID.
return	void

AddBlock() public method

Adds a new Block of the given block type to the given page (optional) and layout (optional), setting its values with the given parameter values. If only the layout is given, edit/configuration authorization will also be inserted into the Auth table for the admin role (GroupId 2).

public AddBlock ( string pageGuid, string layoutGuid, string blockTypeGuid, string name, string zone, string preHtml, string postHtml, int order, string guid ) : void
pageGuid	string	The page GUID.
layoutGuid	string	The layout GUID.
blockTypeGuid	string	The block type GUID.
name	string	The name.
zone	string	The zone.
preHtml	string	The pre HTML.
postHtml	string	The post HTML.
order	int	The order.
guid	string	The unique identifier.
return	void

AddBlockAttributeValue() public method

Adds a new block attribute value for the given block guid and attribute guid, deleting any previously existing attribute value first.

public AddBlockAttributeValue ( string blockGuid, string attributeGuid, string value, bool appendToExisting = false ) : void
blockGuid	string	The block GUID.
attributeGuid	string	The attribute GUID.
value	string	The value.
appendToExisting	bool	if set to true appends the value to the existing value instead of replacing.
return	void

AddBlockType() public method

Adds a new BlockType.

public AddBlockType ( string name, string description, string path, string category, string guid ) : void
name	string
description	string
path	string
category	string
guid	string
return	void

AddBlockTypeAttribute() public method

Adds a new BlockType Attribute for the given blocktype and key.

Attribute Category no longer supported by this helper function. You'll have to write special migration code yourself. Sorry!

public AddBlockTypeAttribute ( string blockTypeGuid, string fieldTypeGuid, string name, string key, string category, string description, int order, string defaultValue, string guid, bool isRequired = false ) : void
blockTypeGuid	string	The block GUID.
fieldTypeGuid	string	The field type GUID.
name	string	The name.
key	string	The key.
category	string	The category.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The GUID.
isRequired	bool	if set to true [is required].
return	void

AddDefinedType() public method

Adds a new DefinedType.

public AddDefinedType ( string category, string name, string description, string guid, string helpText = null ) : void
category	string	The category.
name	string	The name.
description	string	The description.
guid	string	The GUID.
helpText	string	The help text.
return	void

AddDefinedTypeAttribute() public method

Adds the defined type attribute.

public AddDefinedTypeAttribute ( string definedTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void
definedTypeGuid	string	The defined type unique identifier.
fieldTypeGuid	string	The field type unique identifier.
name	string	The name.
key	string	The key.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
return	void

AddDefinedType_pre201409101843015() public method

Adds the defined type_pre201409101843015.

public AddDefinedType_pre201409101843015 ( string category, string name, string description, string guid, string helpText = null ) : void
category	string	The category.
name	string	The name.
description	string	The description.
guid	string	The unique identifier.
helpText	string	The help text.
return	void

AddDefinedValue() public method

Adds the defined value.

public AddDefinedValue ( string definedTypeGuid, string value, string description ) : void
definedTypeGuid	string	The defined type unique identifier.
value	string	The value.
description	string	The description.
return	void

AddDefinedValue() public method

Adds a new DefinedValue for the given DefinedType.

public AddDefinedValue ( string definedTypeGuid, string value, string description, string guid, bool isSystem = true ) : void
definedTypeGuid	string	The defined type GUID.
value	string	The value.
description	string	The description.
guid	string	The GUID.
isSystem	bool	if set to true [is system].
return	void

AddDefinedValueAttributeValue() public method

Adds the defined value attribute value.

public AddDefinedValueAttributeValue ( string definedValueGuid, string attributeGuid, string value ) : void
definedValueGuid	string	The defined value unique identifier.
attributeGuid	string	The attribute unique identifier.
value	string	The value.
return	void

AddDefinedValueAttributeValueByName_pre20140819() public method

Adds the name of the defined value attribute value by.

public AddDefinedValueAttributeValueByName_pre20140819 ( string definedTypeGuid, string definedValueName, string attributeKey, string value ) : void
definedTypeGuid	string	The defined type unique identifier.
definedValueName	string	Name of the defined value.
attributeKey	string	The attribute key.
value	string	The value.
return	void

AddDefinedValueAttributeValueByValue() public method

Adds the name of the defined value attribute value by.

public AddDefinedValueAttributeValueByValue ( string definedTypeGuid, string definedValueValue, string attributeKey, string value ) : void
definedTypeGuid	string	The defined type unique identifier.
definedValueValue	string	The defined value value.
attributeKey	string	The attribute key.
value	string	The value.
return	void

AddDefinedValue_pre20140819() public method

Adds a new DefinedValue for the given DefinedType.

public AddDefinedValue_pre20140819 ( string definedTypeGuid, string name, string description, string guid, bool isSystem = true ) : void
definedTypeGuid	string	The defined type GUID.
name	string	The name.
description	string	The description.
guid	string	The GUID.
isSystem	bool	if set to true [is system].
return	void

AddEntityAttribute() public method

Adds a new EntityType Attribute for the given EntityType, FieldType, and name (key).

public AddEntityAttribute ( string entityTypeName, string fieldTypeGuid, string entityTypeQualifierColumn, string entityTypeQualifierValue, string name, string category, string description, int order, string defaultValue, string guid, string key = null ) : void
entityTypeName	string	Name of the entity type.
fieldTypeGuid	string	The field type GUID.
entityTypeQualifierColumn	string	The entity type qualifier column.
entityTypeQualifierValue	string	The entity type qualifier value.
name	string	The name.
category	string	The category.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The GUID.
key	string	The key. Defaults to Name without Spaces. If this is a core global attribute, specify the key with a 'core.' prefix
return	void

AddGlobalAttribute() public method

Adds a global Attribute for the given FieldType, entityTypeQualifierColumn, entityTypeQualifierValue and name (key). Note: This method delets the Attribute first if it had already existed.

public AddGlobalAttribute ( string fieldTypeGuid, string entityTypeQualifierColumn, string entityTypeQualifierValue, string name, string description, int order, string defaultValue, string guid, string key = null ) : void
fieldTypeGuid	string	The field type GUID.
entityTypeQualifierColumn	string	The entity type qualifier column.
entityTypeQualifierValue	string	The entity type qualifier value.
name	string	The name.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The GUID.
key	string	The key. Defaults to Name without Spaces. If this is a core global attribute, specify the key with a 'core.' prefix
return	void

AddGroupMemberAttributeDefinedValue() public method

Adds or updates a group member Attribute for the given group for storing a particular defined value. The defined values are constrained by the given defined type.

public AddGroupMemberAttributeDefinedValue ( string groupGuid, string name, string description, int order, string defaultValue, bool isGridColumn, bool isMultiValue, bool isRequired, string definedTypeGuid, string guid, bool isSystem = true ) : void
groupGuid	string	The group unique identifier.
name	string	The name the group member attribute. The attribute key will become the name with the whitespace removed.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
isGridColumn	bool	if set to true the group member attribute will appear in the group member list grid.
isMultiValue	bool	if set to true the attribute will allow multiple defined values to be set.
isRequired	bool	if set to true the attribute will be required to be set.
definedTypeGuid	string	The defined type unique identifier.
guid	string	The unique identifier of the attribute.
isSystem	bool	if set to true the attribute is considered a system attribute..
return	void

AddGroupType() public method

Adds or Updates the GroupType for the given guid (if it exists); otherwise it inserts a new record.

public AddGroupType ( string name, string description, string groupTerm, string groupMemberTerm, bool allowMultipleLocations, bool showInGroupList, bool showInNavigation, string iconCssClass, int order, string inheritedGroupTypeGuid, int locationSelectionMode, string groupTypePurposeValueGuid, string guid, bool isSystem = true ) : void
name	string	The name.
description	string	The description.
groupTerm	string	The group term.
groupMemberTerm	string	The group member term.
allowMultipleLocations	bool	if set to true [allow multiple locations].
showInGroupList	bool	if set to true [show in group list].
showInNavigation	bool	if set to true [show in navigation].
iconCssClass	string	The icon CSS class.
order	int	The order.
inheritedGroupTypeGuid	string	The inherited group type unique identifier.
locationSelectionMode	int	The location selection mode.
groupTypePurposeValueGuid	string	The group type purpose value unique identifier.
guid	string	The unique identifier.
isSystem	bool	if set to true [is system].
return	void

AddGroupTypeGroupAttribute() public method

Adds a new GroupType "Group Attribute" for the given GroupType using the given values.

public AddGroupTypeGroupAttribute ( string groupTypeGuid, string fieldTypeGuid, string name, string description, int order, string defaultValue, string guid ) : void
groupTypeGuid	string
fieldTypeGuid	string
name	string
description	string
order	int
defaultValue	string	a string, empty string, or NULL
guid	string
return	void

AddGroupTypeRole() public method

Adds or Updates the GroupTypeRole for the given guid (if it exists); otherwise it inserts a new record. Can also set the role as the default for the given GroupType if isDefaultGroupTypeRole is set to true.

public AddGroupTypeRole ( string groupTypeGuid, string name, string description, int order, int maxCount, int minCount, string guid, bool isSystem = true, bool isLeader = false, bool isDefaultGroupTypeRole = false ) : void
groupTypeGuid	string	The group type unique identifier.
name	string	The name of the role.
description	string	The description.
order	int	The order.
maxCount	int	The maximum count.
minCount	int	The minimum count.
guid	string	The unique identifier of the group type role.
isSystem	bool	if set to true [is system].
isLeader	bool	if set to true [is leader].
isDefaultGroupTypeRole	bool	if set to true the role will be set as the default role for the given group type.
return	void

AddLayout() public method

Adds a new Layout to the given site if it doesn't already exist (by Guid), otherwise it updates it

public AddLayout ( string siteGuid, string fileName, string name, string description, string guid ) : void
siteGuid	string	The site GUID.
fileName	string	Name of the file.
name	string	The name.
description	string	The description.
guid	string	The GUID.
return	void

AddPage() public method

Adds a new Page to the given parent page. The new page will be ordered as last child of the parent page.

public AddPage ( string parentPageGuid, string layoutGuid, string name, string description, string guid, string iconCssClass = "", string insertAfterPageGuid = "" ) : void
parentPageGuid	string	The parent page GUID.
layoutGuid	string	The layout GUID.
name	string	The name.
description	string	The description.
guid	string	The GUID.
iconCssClass	string	The icon CSS class.
insertAfterPageGuid	string	The insert after page unique identifier.
return	void

AddPageRoute() public method

Adds a new PageRoute to the given page but only if the given route name does not exist.

public AddPageRoute ( string pageGuid, string route ) : void
pageGuid	string	The page GUID.
route	string	The route.
return	void

AddPageRoute() public method

Adds a new PageRoute to the given page but only if the given route name does not exist.

public AddPageRoute ( string pageGuid, string route, string guid ) : void
pageGuid	string	The page GUID.
route	string	The route.
guid	string	The unique identifier.
return	void

AddPersonBadgeAttribute() public method

Adds (or Deletes and Adds) the person badge attribute.

public AddPersonBadgeAttribute ( string personBadgeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void
personBadgeGuid	string	The person badge unique identifier.
fieldTypeGuid	string	The field type unique identifier.
name	string	The name.
key	string	The key.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
return	void

AddPersonBadgeAttributeValue() public method

Adds/Updates the person badge attribute value.

public AddPersonBadgeAttributeValue ( string personBadgeGuid, string attributeGuid, string value ) : void
personBadgeGuid	string	The person badge unique identifier.
attributeGuid	string	The attribute unique identifier.
value	string	The value.
return	void

AddReport() public method

Adds a report.

public AddReport ( string categoryGuid, string dataViewGuid, string entityTypeGuid, string name, string description, string guid, int fetchTop = null ) : void
categoryGuid	string	The category unique identifier.
dataViewGuid	string	The data view unique identifier.
entityTypeGuid	string	The entity type unique identifier.
name	string	The name.
description	string	The description.
guid	string	The report.Guid
fetchTop	int	The fetch top.
return	void

AddReportField() public method

Adds a report field to a report

public AddReportField ( string reportGuid, Rock reportFieldType, bool showInGrid, string dataSelectComponentEntityTypeGuid, string selection, int order, string columnHeaderText, string guid ) : void
reportGuid	string	The report unique identifier.
reportFieldType	Rock	Type of the report field.
showInGrid	bool	if set to true [show in grid].
dataSelectComponentEntityTypeGuid	string	The data select component entity type unique identifier.
selection	string	The selection.
order	int	The order.
columnHeaderText	string	The column header text.
guid	string	The unique identifier.
return	void

AddRestAction() public method

Adds the rest action.

public AddRestAction ( string controllerName, string controllerClass, string actionMethod, string actionPath ) : void
controllerName	string	Name of the controller.
controllerClass	string	The controller class.
actionMethod	string	The action method.
actionPath	string	The action path.
return	void

AddRestController() public method

Adds the rest controller.

public AddRestController ( string controllerName, string controllerClass ) : void
controllerName	string	Name of the controller.
controllerClass	string	The controller class.
return	void

AddSecurityAuth() public method

Adds the security auth record for the given entity type and group.

public AddSecurityAuth ( string entityTypeName, string action, string groupGuid, string authGuid ) : void
entityTypeName	string	Name of the entity type.
action	string	The action.
groupGuid	string	The group GUID.
authGuid	string	The auth GUID.
return	void

AddSecurityAuthForAttribute() public method

Adds the attribute security authentication. Set GroupGuid to null when setting to a special role

public AddSecurityAuthForAttribute ( string attributeGuid, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void
attributeGuid	string	The attribute unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	int	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForBinaryFileType() public method

Adds the binaryfiletype security authentication. Set GroupGuid to null when setting to a special role

public AddSecurityAuthForBinaryFileType ( string binaryFileTypeGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
binaryFileTypeGuid	string	The binary file type unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForBlock() public method

Adds the page security authentication. Set GroupGuid to null when setting to a special role

public AddSecurityAuthForBlock ( string blockGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
blockGuid	string	The block unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForCalendar() public method

Adds the security authentication for calendar.

public AddSecurityAuthForCalendar ( string calendarGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
calendarGuid	string	The calendar unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForCategory() public method

Adds the category security authentication. Set GroupGuid to null when setting to a special role

public AddSecurityAuthForCategory ( string categoryGuid, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void
categoryGuid	string	The category unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	int	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForContentChannel() public method

Adds the security authentication for content channel.

public AddSecurityAuthForContentChannel ( string contentChannelGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
contentChannelGuid	string	The content channel unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForEntityType() public method

Adds the security auth record for the given entity type and group.

public AddSecurityAuthForEntityType ( string entityTypeName, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void
entityTypeName	string	Name of the entity type.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	int	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForGroupType() public method

Adds the page security authentication. Set GroupGuid to null when setting to a special role

public AddSecurityAuthForGroupType ( string groupTypeGuid, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
groupTypeGuid	string	The group type unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForPage() public method

Adds the page security authentication. Set GroupGuid to null when setting to a special role

public AddSecurityAuthForPage ( string pageGuid, int order, string action, bool allow, string groupGuid, int specialRole, string authGuid ) : void
pageGuid	string	The page unique identifier.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	int	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForRestAction() public method

Adds the security authentication for rest action.

public AddSecurityAuthForRestAction ( string restActionMethod, string restActionPath, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
restActionMethod	string	The rest action method.
restActionPath	string	The rest action path.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityAuthForRestController() public method

Adds the security authentication for rest controller.

public AddSecurityAuthForRestController ( string restControllerClass, int order, string action, bool allow, string groupGuid, Rock specialRole, string authGuid ) : void
restControllerClass	string	The rest controller class.
order	int	The order.
action	string	The action.
allow	bool	if set to true [allow].
groupGuid	string	The group unique identifier.
specialRole	Rock	The special role.
authGuid	string	The authentication unique identifier.
return	void

AddSecurityRoleGroup() public method

Adds the security role group.

public AddSecurityRoleGroup ( string name, string description, string guid ) : void
name	string	The name.
description	string	The description.
guid	string	The GUID.
return	void

AddSite() public method

Adds a new Layout to the given site.

public AddSite ( string name, string description, string theme, string guid ) : void
name	string	The name.
description	string	The description.
theme	string	The theme.
guid	string	The GUID.
return	void

CreateWorkflowTrigger() public method

Creates the workflow trigger.

public CreateWorkflowTrigger ( string entityTypeName, WorkflowTriggerType triggerType, string qualifierColumn, string qualifierValue, string workflowTypeGuid, string description, string guid = null ) : void
entityTypeName	string	Name of the entity type.
triggerType	WorkflowTriggerType	Type of the trigger.
qualifierColumn	string	The qualifier column.
qualifierValue	string	The qualifier value.
workflowTypeGuid	string	The workflow type unique identifier.
description	string	The description.
guid	string	The unique identifier.
return	void

DeleteAttribute() public method

Deletes the attribute.

public DeleteAttribute ( string guid ) : void
guid	string	The GUID.
return	void

DeleteAttributeValuesByWorkflowAction() public method

Deletes the attribute values by workflow action guid.

public DeleteAttributeValuesByWorkflowAction ( string workflowActionGuid ) : void
workflowActionGuid	string	The workflow action unique identifier.
return	void

DeleteAttributesByEntityType() public method

Deletes the attributes by entity type.

public DeleteAttributesByEntityType ( string entityTypeGuid ) : void
entityTypeGuid	string	The entity type unique identifier.
return	void

DeleteBlock() public method

Deletes the block and any authorization records that belonged to it.

public DeleteBlock ( string guid ) : void
guid	string	The GUID.
return	void

DeleteBlockAttribute() public method

Deletes the block Attribute.

public DeleteBlockAttribute ( string guid ) : void
guid	string	The GUID.
return	void

DeleteBlockAttributeValue() public method

Deletes the block attribute value.

public DeleteBlockAttributeValue ( string blockGuid, string attributeGuid ) : void
blockGuid	string	The block GUID.
attributeGuid	string	The attribute GUID.
return	void

DeleteBlockType() public method

Deletes the BlockType.

public DeleteBlockType ( string guid ) : void
guid	string	The GUID.
return	void

DeleteByGuid() public method

Deletes from the table by the by unique identifier.

public DeleteByGuid ( string guid, string tableName ) : void
guid	string	The unique identifier.
tableName	string	The table.
return	void

DeleteCategory() public method

Deletes the category.

public DeleteCategory ( string guid ) : void
guid	string	The unique identifier.
return	void

DeleteDefinedType() public method

Deletes the DefinedType.

public DeleteDefinedType ( string guid ) : void
guid	string	The GUID.
return	void

DeleteDefinedValue() public method

Deletes the DefinedValue.

public DeleteDefinedValue ( string guid ) : void
guid	string	The GUID.
return	void

DeleteEntityType() public method

Deletes the EntityType.

public DeleteEntityType ( string guid ) : void
guid	string	The GUID.
return	void

DeleteFieldType() public method

Deletes the FieldType.

public DeleteFieldType ( string guid ) : void
guid	string	The GUID.
return	void

DeleteGroup() public method

Deletes the group.

public DeleteGroup ( string guid, bool orphanAnyChildren = true ) : void
guid	string	The unique identifier.
orphanAnyChildren	bool	if set to true any child groups will be orphaned.
return	void

DeleteGroupType() public method

Deletes the GroupType.

public DeleteGroupType ( string guid ) : void
guid	string	The GUID.
return	void

DeleteGroupTypeRole() public method

Deletes the GroupTypeRole.

public DeleteGroupTypeRole ( string guid ) : void
guid	string	The GUID.
return	void

DeleteLayout() public method

Deletes the Layout.

public DeleteLayout ( string guid ) : void
guid	string	The GUID.
return	void

DeletePage() public method

Deletes the Page and any PageViews that use the page.

public DeletePage ( string guid ) : void
guid	string	The GUID.
return	void

DeletePageContext() public method

Deletes the page context.

public DeletePageContext ( string guid ) : void
guid	string	The unique identifier.
return	void

DeleteReport() public method

Deletes the report

public DeleteReport ( string guid ) : void
guid	string	The unique identifier.
return	void

DeleteReportField() public method

Deletes the report field.

public DeleteReportField ( string guid ) : void
guid	string	The unique identifier.
return	void

DeleteSecurityAuth() public method

Deletes the security auth record.

public DeleteSecurityAuth ( string guid ) : void
guid	string	The GUID.
return	void

DeleteSecurityAuthForAttribute() public method

Deletes the security authentication for page.

public DeleteSecurityAuthForAttribute ( string attributeGuid ) : void
attributeGuid	string	The attribute unique identifier.
return	void

DeleteSecurityAuthForBlock() public method

Deletes the security authentication for block.

public DeleteSecurityAuthForBlock ( string blockGuid ) : void
blockGuid	string	The block unique identifier.
return	void

DeleteSecurityAuthForCategory() public method

Deletes the security authentication for category.

public DeleteSecurityAuthForCategory ( string categoryGuid ) : void
categoryGuid	string	The category unique identifier.
return	void

DeleteSecurityAuthForGroupType() public method

Deletes the security authentication for groupType.

public DeleteSecurityAuthForGroupType ( string groupTypeGuid ) : void
groupTypeGuid	string	The groupType unique identifier.
return	void

DeleteSecurityAuthForPage() public method

Deletes the security authentication for page.

public DeleteSecurityAuthForPage ( string pageGuid ) : void
pageGuid	string	The page unique identifier.
return	void

DeleteSecurityRoleGroup() public method

Deletes the security role group.

public DeleteSecurityRoleGroup ( string guid ) : void
guid	string	The GUID.
return	void

DeleteSite() public method

Deletes the Layout.

public DeleteSite ( string guid ) : void
guid	string	The GUID.
return	void

DeleteSystemEmail() public method

Deletes the SystemEmail.

public DeleteSystemEmail ( string guid ) : void
guid	string	The GUID.
return	void

DeleteWorkflowActionType() public method

Deletes the type of the workflow action.

public DeleteWorkflowActionType ( string guid ) : void
guid	string	The unique identifier.
return	void

DeleteWorkflowActivityType() public method

Deletes the type of the workflow activity.

public DeleteWorkflowActivityType ( string guid ) : void
guid	string	The unique identifier.
return	void

DeleteWorkflowTriggersByWorkflowCategory() public method

Deletes workflow triggers that reference a workflow type that has a category defined by the given guid.

public DeleteWorkflowTriggersByWorkflowCategory ( string workflowCategoryGuid ) : void
workflowCategoryGuid	string	The workflow category unique identifier.
return	void

DeleteWorkflowType() public method

Deletes the type of the workflow.

public DeleteWorkflowType ( string guid ) : void
guid	string	The unique identifier.
return	void

MigrationHelper() public method

Initializes a new instance of the MigrationHelper class.

public MigrationHelper ( IMigration migration ) : System
migration	IMigration	The migration.
return	System

MovePage() public method

Moves the Page to the new given parent page.

public MovePage ( string pageGuid, string parentPageGuid ) : void
pageGuid	string	The page GUID.
parentPageGuid	string	The parent page GUID.
return	void

RenameBlockType() public method

Renames the type of the block.

public RenameBlockType ( string oldPath, string newPath, string newCategory = null, string newName = null, string newDescription = null ) : void
oldPath	string	The old path.
newPath	string	The new path.
newCategory	string	The new category.
newName	string	The new name.
newDescription	string	The new description.
return	void

UpdateAttributeQualifier() public method

Updates the attribute qualifier.

public UpdateAttributeQualifier ( string attributeGuid, string key, string value, string guid ) : void
attributeGuid	string	The attribute unique identifier.
key	string	The key.
value	string	The value.
guid	string	The unique identifier.
return	void

UpdateBinaryFileType() public method

Updates the type of the binary file.

public UpdateBinaryFileType ( string storageEntityTypeId, string name, string description, string iconCssClass, string guid, bool allowCaching = false, bool requiresViewSecurity = false ) : void
storageEntityTypeId	string	The storage entity type identifier.
name	string	The name.
description	string	The description.
iconCssClass	string	The icon CSS class.
guid	string	The unique identifier.
allowCaching	bool	if set to true [allow caching].
requiresViewSecurity	bool	if set to true [requires view security].
return	void

UpdateBlockType() public method

Updates the BlockType by path (if it exists); otherwise it inserts a new record. In either case it will be marked IsSystem.

public UpdateBlockType ( string name, string description, string path, string category, string guid ) : void
name	string	The name.
description	string	The description.
path	string	The path.
category	string	The category.
guid	string	The GUID.
return	void

UpdateBlockTypeAttribute() public method

Updates the BlockType Attribute for the given blocktype and key (if it exists); otherwise it inserts a new record.

public UpdateBlockTypeAttribute ( string blockTypeGuid, string fieldTypeGuid, string name, string key, string category, string description, int order, string defaultValue, string guid ) : void
blockTypeGuid	string
fieldTypeGuid	string
name	string
key	string
category	string
description	string
order	int
defaultValue	string
guid	string
return	void

UpdateCategory() public method

Updates the category or adds if it doesn't already exist (based on Guid)

public UpdateCategory ( string entityTypeGuid, string name, string iconCssClass, string description, string guid, int order, string parentCategoryGuid = "" ) : void
entityTypeGuid	string	The entity type unique identifier.
name	string	The name.
iconCssClass	string	The icon CSS class.
description	string	The description.
guid	string	The unique identifier.
order	int	The order.
parentCategoryGuid	string	The parent category unique identifier.
return	void

UpdateCategoryByName() public method

Updates the category or adds if it doesn't already exist (based on Name)

public UpdateCategoryByName ( string entityTypeGuid, string name, string iconCssClass, string description, string guid, int order ) : void
entityTypeGuid	string	The entity type unique identifier.
name	string	The name.
iconCssClass	string	The icon CSS class.
description	string	The description.
guid	string	The unique identifier.
order	int	The order.
return	void

UpdateDefinedValue() public method

Updates (or Adds) the defined value for the given DefinedType.

public UpdateDefinedValue ( string definedTypeGuid, string value, string description, string guid, bool isSystem = true, int foreignId = null, string foreignKey = "" ) : void
definedTypeGuid	string	The defined type GUID.
value	string	The value.
description	string	The description.
guid	string	The GUID.
isSystem	bool	if set to true [is system].
foreignId	int	The foreign identifier.
foreignKey	string	The foreign key.
return	void

UpdateDefinedValueAttributeValue() public method

Adds the defined value attribute value.

public UpdateDefinedValueAttributeValue ( string definedValueGuid, string attributeGuid, string value ) : void
definedValueGuid	string	The defined value unique identifier.
attributeGuid	string	The attribute unique identifier.
value	string	The value.
return	void

UpdateDefinedValueByName_pre20140819() public method

Updates the name of the defined value by.

public UpdateDefinedValueByName_pre20140819 ( string definedTypeGuid, string name, string description, int order, bool isSystem = true ) : void
definedTypeGuid	string	The defined type unique identifier.
name	string	The name.
description	string	The description.
order	int	The order.
isSystem	bool	if set to true [is system].
return	void

UpdateDefinedValueByValue() public method

Updates the name of the defined value by.

public UpdateDefinedValueByValue ( string definedTypeGuid, string value, string description, int order, bool isSystem = true ) : void
definedTypeGuid	string	The defined type unique identifier.
value	string	The value.
description	string	The description.
order	int	The order.
isSystem	bool	if set to true [is system].
return	void

UpdateDefinedValue_pre20140819() public method

Updates (or Adds) the defined value for the given DefinedType.

public UpdateDefinedValue_pre20140819 ( string definedTypeGuid, string name, string description, string guid, bool isSystem = true ) : void
definedTypeGuid	string	The defined type GUID.
name	string	The name.
description	string	The description.
guid	string	The GUID.
isSystem	bool	if set to true [is system].
return	void

UpdateEntityAttribute() public method

Updates the entity attribute.

public UpdateEntityAttribute ( string modelEntityTypeName, string componentEntityTypeName, string fieldTypeGuid, string name, string description, int order, string defaultValue, string guid, string key = null ) : void
modelEntityTypeName	string	Name of the model entity type.
componentEntityTypeName	string	Name of the component entity type.
fieldTypeGuid	string	The field type unique identifier.
name	string	The name.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
key	string	The key.
return	void

UpdateEntityAttribute() public method

Updates the Entity Attribute for the given EntityType, FieldType, and name (key). otherwise it inserts a new record.

public UpdateEntityAttribute ( string entityTypeName, string fieldTypeGuid, string entityTypeQualifierColumn, string entityTypeQualifierValue, string name, string description, int order, string defaultValue, string guid, string key = null ) : void
entityTypeName	string	Name of the entity type.
fieldTypeGuid	string	The field type unique identifier.
entityTypeQualifierColumn	string	The entity type qualifier column.
entityTypeQualifierValue	string	The entity type qualifier value.
name	string	The name.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
key	string	The key. Defaults to Name without Spaces. If this is a core attribute for the entity, specify the key with a 'core.' prefix
return	void

UpdateEntityType() public method

Updates the EntityType by name (if it exists); otherwise it inserts a new record.

public UpdateEntityType ( string name, string guid, bool isEntity, bool isSecured ) : void
name	string	The name.
guid	string	The GUID.
isEntity	bool	if set to true [is entity].
isSecured	bool	if set to true [is secured].
return	void

UpdateEntityType() public method

Updates the EntityType by name (if it exists); otherwise it inserts a new record.

public UpdateEntityType ( string name, string friendlyName, string assemblyName, bool isEntity, bool isSecured, string guid ) : void
name	string	The name.
friendlyName	string	Name of the friendly.
assemblyName	string	Name of the assembly.
isEntity	bool	if set to true [is entity].
isSecured	bool	if set to true [is secured].
guid	string	The GUID.
return	void

UpdateEntityTypeMultiValueFieldType() public method

Updates the EntityType MultiValueFieldType

public UpdateEntityTypeMultiValueFieldType ( string entityTypeName, string fieldTypeGuid ) : void
entityTypeName	string	Name of the entity type.
fieldTypeGuid	string	The field type unique identifier.
return	void

UpdateEntityTypeSingleValueFieldType() public method

Updates the EntityType SingleValueFieldType

public UpdateEntityTypeSingleValueFieldType ( string entityTypeName, string fieldTypeGuid ) : void
entityTypeName	string	Name of the entity type.
fieldTypeGuid	string	The field type unique identifier.
return	void

UpdateFieldType() public method

Updates the FieldType by assembly and className (if it exists); otherwise it inserts a new record.

public UpdateFieldType ( string name, string description, string assembly, string className, string guid, bool IsSystem = true ) : void
name	string	The name.
description	string	The description.
assembly	string	The assembly.
className	string	Name of the class.
guid	string	The GUID.
IsSystem	bool	if set to true [is system].
return	void

UpdateGroup() public method

Updates the Group for the given guid (if it exists); otherwise it inserts a new record.

public UpdateGroup ( string parentGroupGuid, string groupTypeGuid, string name, string description, string campusGuid, int order, string guid, bool isSystem = true, bool isSecurityRole = false, bool isActive = true ) : void
parentGroupGuid	string	The parent group unique identifier.
groupTypeGuid	string	The group type unique identifier.
name	string	The name of the group.
description	string	The description.
campusGuid	string	The campus unique identifier.
order	int	The order.
guid	string	The unique identifier of the group.
isSystem	bool	if set to true [is system].
isSecurityRole	bool	if set to true [is security role].
isActive	bool	if set to true [is active].
return	void

UpdateGroupMemberAttributeDefinedValue() public method

Adds or updates a group member Attribute for the given group for storing a particular defined value. The defined values are constrained by the given defined type.

public UpdateGroupMemberAttributeDefinedValue ( string groupGuid, string name, string description, int order, string defaultValue, bool isGridColumn, bool isMultiValue, bool isRequired, string definedTypeGuid, string guid, bool isSystem = true ) : void
groupGuid	string	The group unique identifier.
name	string	The name the group member attribute. The attribute key will become the name with the whitespace removed.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
isGridColumn	bool	if set to true the group member attribute will appear in the group member list grid.
isMultiValue	bool	if set to true the attribute will allow multiple defined values to be set.
isRequired	bool	if set to true the attribute will be required to be set.
definedTypeGuid	string	The defined type unique identifier.
guid	string	The unique identifier of the attribute.
isSystem	bool	if set to true the attribute is considered a system attribute..
return	void

UpdateGroupType() public method

Adds or Updates the GroupType for the given guid (if it exists); otherwise it inserts a new record.

public UpdateGroupType ( string name, string description, string groupTerm, string groupMemberTerm, string defaultGroupRoleGuid, bool allowMultipleLocations, bool showInGroupList, bool showInNavigation, string iconCssClass, int order, string inheritedGroupTypeGuid, int locationSelectionMode, string groupTypePurposeValueGuid, string guid, bool isSystem = true ) : void
name	string	The name.
description	string	The description.
groupTerm	string	The group term.
groupMemberTerm	string	The group member term.
defaultGroupRoleGuid	string	The guid for default group role. If you don't have a role yet, use 'null' and then use the method later when creating the new role.
allowMultipleLocations	bool	if set to true [allow multiple locations].
showInGroupList	bool	if set to true [show in group list].
showInNavigation	bool	if set to true [show in navigation].
iconCssClass	string	The icon CSS class.
order	int	The order.
inheritedGroupTypeGuid	string	The inherited group type unique identifier.
locationSelectionMode	int	The location selection mode.
groupTypePurposeValueGuid	string	The group type purpose value unique identifier.
guid	string	The unique identifier.
isSystem	bool	if set to true [is system].
return	void

UpdateGroupTypeRole() public method

public UpdateGroupTypeRole ( string groupTypeGuid, string name, string description, int order, int maxCount, int minCount, string guid, bool isSystem = true, bool isLeader = false, bool isDefaultGroupTypeRole = false ) : void
groupTypeGuid	string	The group type unique identifier.
name	string	The name of the role.
description	string	The description.
order	int	The order.
maxCount	int	The maximum count.
minCount	int	The minimum count.
guid	string	The unique identifier of the group type role.
isSystem	bool	if set to true [is system].
isLeader	bool	if set to true [is leader].
isDefaultGroupTypeRole	bool	if set to true the role will be set as the default role for the given group type.
return	void

UpdateHtmlContentBlock() public method

Add or Updates the HTML content for an HTML Content Block

public UpdateHtmlContentBlock ( string blockGuid, string htmlContent, string guid ) : void
blockGuid	string	The block unique identifier.
htmlContent	string	Content of the HTML.
guid	string	The unique identifier.
return	void

UpdateLayout() public method

Updates the layout file for the Site to have a known Guid and update the Name, Description and IsSystem

public UpdateLayout ( string siteGuid, string fileName, string name, string description, string guid, bool IsSystem = true ) : void
siteGuid	string	The site unique identifier.
fileName	string	Name of the file.
name	string	The name.
description	string	The description.
guid	string	The unique identifier.
IsSystem	bool	if set to true [is system].
return	void

UpdatePageContext() public method

Adds or Updates PageContext to the given page, entity, idParameter

public UpdatePageContext ( string pageGuid, string entity, string idParameter, string guid ) : void
pageGuid	string	The page GUID.
entity	string	The entity value.
idParameter	string	The idparameter value.
guid	string	The unique identifier for the PageContext record.
return	void

UpdatePersonAttribute() public method

Updates the Person Attribute for the given key (if it exists); otherwise it inserts a new record.

public UpdatePersonAttribute ( string fieldTypeGuid, string categoryGuid, string name, string key, string iconCssClass, string description, int order, string defaultValue, string guid ) : void
fieldTypeGuid	string	The field type unique identifier.
categoryGuid	string	The category unique identifier.
name	string	The name.
key	string	The key. Defaults to Name without Spaces. If this is a core person attribute, specify the key with a 'core.' prefix
iconCssClass	string	The icon CSS class.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
return	void

UpdatePersonAttributeCategory() public method

Updates the person attribute category.

public UpdatePersonAttributeCategory ( string name, string iconCssClass, string description, string guid, int order ) : void
name	string	The name.
iconCssClass	string	The icon CSS class.
description	string	The description.
guid	string	The unique identifier.
order	int	The order.
return	void

UpdatePersonBadge() public method

Updates the PersonBadge by Guid (if it exists); otherwise it inserts a new record.

public UpdatePersonBadge ( string name, string description, string entityTypeName, int order, string guid ) : void
name	string	The name.
description	string	The description.
entityTypeName	string	Name of the entity type.
order	int	The order.
guid	string	The unique identifier.
return	void

UpdateSystemEmail() public method

Updates or Inserts the system email.

public UpdateSystemEmail ( string category, string title, string from, string fromName, string to, string cc, string bcc, string subject, string body, string guid ) : void
category	string	The category.
title	string	The title.
from	string	From.
fromName	string	From name.
to	string	To.
cc	string	The cc.
bcc	string	The BCC.
subject	string	The subject.
body	string	The body.
guid	string	The unique identifier.
return	void

UpdateSystemEmail_pre201409101843015() public method

Updates the system email_pre201409101843015.

public UpdateSystemEmail_pre201409101843015 ( string category, string title, string from, string fromName, string to, string cc, string bcc, string subject, string body, string guid ) : void
category	string	The category.
title	string	The title.
from	string	From.
fromName	string	From name.
to	string	To.
cc	string	The cc.
bcc	string	The BCC.
subject	string	The subject.
body	string	The body.
guid	string	The unique identifier.
return	void

UpdateWorkflowActionEntityAttribute() public method

Updates the workflow action entity attribute.

public UpdateWorkflowActionEntityAttribute ( string actionEntityTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void
actionEntityTypeGuid	string	The action entity type unique identifier.
fieldTypeGuid	string	The field type unique identifier.
name	string	The name.
key	string	The key.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
return	void

UpdateWorkflowActionForm() public method

Updates the workflow action form.

public UpdateWorkflowActionForm ( string header, string footer, string actions, string systemEmailGuid, bool includeActionsInNotification, string actionAttributeGuid, string guid ) : void
header	string	The header.
footer	string	The footer.
actions	string	The actions.
systemEmailGuid	string	The system email unique identifier.
includeActionsInNotification	bool	if set to true [include actions in notification].
actionAttributeGuid	string	The action attribute unique identifier.
guid	string	The unique identifier.
return	void

UpdateWorkflowActionFormAttribute() public method

Updates the workflow action form attribute.

public UpdateWorkflowActionFormAttribute ( string actionFormGuid, string attributeGuid, int order, bool isVisible, bool isReadOnly, bool isRequired, bool hideLabel, string preHtml, string postHtml, string guid ) : void
actionFormGuid	string	The action form unique identifier.
attributeGuid	string	The attribute unique identifier.
order	int	The order.
isVisible	bool	if set to true [is visible].
isReadOnly	bool	if set to true [is read only].
isRequired	bool	if set to true [is required].
hideLabel	bool	if set to true [hide label].
preHtml	string	The pre html text/html.
postHtml	string	The post html text/html.
guid	string	The unique identifier.
return	void

UpdateWorkflowActionFormAttribute() public method

Updates the workflow action form attribute.

public UpdateWorkflowActionFormAttribute ( string actionFormGuid, string attributeGuid, int order, bool isVisible, bool isReadOnly, bool isRequired, string guid ) : void
actionFormGuid	string	The action form unique identifier.
attributeGuid	string	The attribute unique identifier.
order	int	The order.
isVisible	bool	if set to true [is visible].
isReadOnly	bool	if set to true [is read only].
isRequired	bool	if set to true [is required].
guid	string	The unique identifier.
return	void

UpdateWorkflowActionType() public method

Updates the type of the workflow action.

public UpdateWorkflowActionType ( string activityTypeGuid, string name, int order, string entityTypeGuid, bool isActionCompletedOnSuccess, bool isActivityCompletedOnSuccess, string workflowFormGuid, string criteriaAttributeGuid, int criteriaComparisonType, string criteriaValue, string guid ) : void
activityTypeGuid	string	The activity type unique identifier.
name	string	The name.
order	int	The order.
entityTypeGuid	string	The entity type unique identifier.
isActionCompletedOnSuccess	bool	if set to true [is action completed on success].
isActivityCompletedOnSuccess	bool	if set to true [is activity completed on success].
workflowFormGuid	string	The workflow form unique identifier.
criteriaAttributeGuid	string	The criteria attribute unique identifier.
criteriaComparisonType	int	Type of the criteria comparison.
criteriaValue	string	The criteria value.
guid	string	The unique identifier.
return	void

UpdateWorkflowActivityType() public method

Updates the type of the workflow activity.

public UpdateWorkflowActivityType ( string WorkflowTypeGuid, bool isActive, string name, string description, bool isActivatedWithWorkflow, int order, string guid ) : void
WorkflowTypeGuid	string	The workflow type unique identifier.
isActive	bool	if set to true [is active].
name	string	The name.
description	string	The description.
isActivatedWithWorkflow	bool	if set to true [is activated with workflow].
order	int	The order.
guid	string	The unique identifier.
return	void

UpdateWorkflowActivityTypeAttribute() public method

Updates the workflow activity type attribute.

public UpdateWorkflowActivityTypeAttribute ( string workflowActivityTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void
workflowActivityTypeGuid	string	The workflow activity type unique identifier.
fieldTypeGuid	string	The field type unique identifier.
name	string	The name.
key	string	The key.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
return	void

UpdateWorkflowType() public method

Updates the type of the workflow.

public UpdateWorkflowType ( bool isSystem, bool isActive, string name, string description, string categoryGuid, string workTerm, string iconCssClass, int processingIntervalSeconds, bool isPersisted, int loggingLevel, string guid, int order ) : void
isSystem	bool	if set to true [is system].
isActive	bool	if set to true [is active].
name	string	The name.
description	string	The description.
categoryGuid	string	The category unique identifier.
workTerm	string	The work term.
iconCssClass	string	The icon CSS class.
processingIntervalSeconds	int	The processing interval seconds.
isPersisted	bool	if set to true [is persisted].
loggingLevel	int	The logging level.
guid	string	The unique identifier.
order	int	The order.
return	void

UpdateWorkflowTypeAttribute() public method

Updates the workflow type attribute.

public UpdateWorkflowTypeAttribute ( string workflowTypeGuid, string fieldTypeGuid, string name, string key, string description, int order, string defaultValue, string guid ) : void
workflowTypeGuid	string	The workflow type unique identifier.
fieldTypeGuid	string	The field type unique identifier.
name	string	The name.
key	string	The key.
description	string	The description.
order	int	The order.
defaultValue	string	The default value.
guid	string	The unique identifier.
return	void