PFGroup Class

Represents a Packflow group, containing other groups and users.

A group can be organisational (under the site) or role (under an application).

All groups can only include organisational groups, not role groups.

A role group is always related to an application context and a modeling role.

Groups are referenced in RLS and user fields, e.g. for permissions and distribution.

Inheritance Hierarchy

SystemObject
  Packflow.CorePFManagedObject
    Packflow.CorePFBaseObject
      Packflow.CorePFGroup

Namespace: Packflow.Core
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)

Syntax

Copy

public class PFGroup : PFBaseObject

The PFGroup type exposes the following members.

Constructors

	Name	Description
	PFGroup

Top

Properties

	Name	Description
	ApplicationContextGuid	Gets the parent application context GUID.
	ApplicationContextId	Gets the parent application context id.
	ApplicationGuid	Gets the parent application GUID.
	ApplicationId	Gets the parent application id.
	BeforeSaveValues	Gets the previous values of modified fields before the latest Save. Note: this feature is NOT persisted in the database and therefore only concerns this instance. (Inherited from PFBaseObject.)
	CanDelete	Checks if the current permission context allows current user to delete this object. (Inherited from PFBaseObject.)
	CanRead	Checks if the current permission context allows current user to access this object. (Inherited from PFBaseObject.)
	CanUpdate	Checks if the current permission context allows current user to update this object. (Inherited from PFBaseObject.)
	Created	Indicates if this object has been created and is still in database (positive Id). (Inherited from PFBaseObject.)
	CreatedAt	Gets the date of creation of this object in the database. (Inherited from PFBaseObject.)
	CreatedBy	Gets the user who created this object in the database. (Inherited from PFBaseObject.)
	Data	Gets the data collection of this object. (Inherited from PFBaseObject.)
	DateObjectCreation	Gets the date of the creation of this object in memory. (Inherited from PFManagedObject.)
	Deleted	True if this object is flagged as deleted. (Inherited from PFBaseObject.)
	DeletedAt	Date of the suppression of this object. (Inherited from PFBaseObject.)
	DeletedBy	The user who deleted this object. (Inherited from PFBaseObject.)
	DisplayName	Gets the display name.
	DomainGroup	Gets or sets the domain group.
	DomainGroupCreateDisabledUsers	Gets or sets a value indicating whether the domain group synchronization can create users, even disabled.
	DomainGroupSynchronised	Gets a value indicating whether this group is synchronized with a domain group.
	DomainGroupSyncMode	Gets or sets a value indicating how the group is synchronized with its domain group.
	DomainGroupSyncModeText	Gets a value indicating how the group is synchronized with its domain group.
	EnableVersionMergeToResolveSaveConflicts	Gets a value indicating whether versions can be merged to resolve save conflicts. If an object is saved with an older version than the last persisted (in database), the system will try to merge the versions values (if no conflicts between values) and will then save the merged item to database. Note : this setting is NOT persisted and will affect this object instance only. (Inherited from PFBaseObject.)
	Exists	Indicates if this object has been created, still exists in database and is not flagged for suppression. (Inherited from PFBaseObject.)
	Guid	Gets the GUID identifying this object. Must be used if Id is no more viable, example if content were merged. (Inherited from PFBaseObject.)
	HasPendingModifications	Checks if there is pending changes. Will check if the values are different from the currently persisted values. (Inherited from PFBaseObject.)
	HasPendingPermissionsModifications	Checks if there is pending modifications in permissions. Will compute permissions (RUD) and check if there is differences with current persisted permissions. (Inherited from PFBaseObject.)
	Id	Gets the id identifying this object. Must be used to find or identify an object because faster than Guid. (Inherited from PFBaseObject.)
	IncludedGroups	Gets the list of organisational groups included in this group.
	KeepBeforeSaveValues	Gets or sets a value indicating whether the Save should keep a collection of the modified fields previous values. Note: this feature is NOT persisted in the database and therefore only concerns this instance. (Inherited from PFBaseObject.)
	Logger	Gets the logger, used to log any useful warning, error or information in the database. (Inherited from PFManagedObject.)
	LogIdentification	Gets a technical text representing this object. (Inherited from PFBaseObject.)
	Name	Gets the name.
	OrganisationalType	Gets or sets the organisational type.
	OrganisationalTypeGuid	Gets the organisational type GUID.
	OrganisationalTypeId	Gets the organisational type id.
	ParentObject	Gets the parent object (site or application depending on the scope).
	PermissionContext	Gets an object calculating permissions on demand.
	Permissions	Gets the permission set (RUD permissions) of this item. (Inherited from PFBaseObject.)
	PermissionSetDeleteId	Id of the permission set for Delete access. (Inherited from PFBaseObject.)
	PermissionSetDeleteXml	XML of serialized permission set for Delete access. (Inherited from PFBaseObject.)
	PermissionSetReadId	Id of the permission set for Read access. (Inherited from PFBaseObject.)
	PermissionSetReadXml	XML of serialized permission set for Read access. (Inherited from PFBaseObject.)
	PermissionSetUpdateId	Id of the permission set for Update access. (Inherited from PFBaseObject.)
	PermissionSetUpdateXml	XML of serialized permission set for Update access. (Inherited from PFBaseObject.)
	RoleGuid	Gets the role GUID. Only applies when the parent is an application.
	Scope	Gets the scope, identifying the parent type of a PFGroup.
	Site	Gets the root of the persisted objects tree. (Inherited from PFBaseObject.)
	SiteGuid	Gets the parent site GUID.
	SiteId	Gets the parent site id.
	StandardGroup	Gets a value indicating whether this group is one of the standard groups.
	UpdatedAt	Gets the date of the last update of this object. (Inherited from PFBaseObject.)
	UpdatedBy	Gets the user who last updated this object in the database. (Inherited from PFBaseObject.)
	Users	Gets the list of users included in this group.
	VersionNumber	Gets the version number of this object in database. Incremented after each save. (Inherited from PFBaseObject.)

Top

Methods

	Name	Description
	CheckForCycles	Checks all children for cycles. NOTE : slow method, do not use on user-production-features.
	Delete	Flags this object as deleted. If it fails, throws an error. If the object could not be deleted because it does not yet exist in database, returns false. If successful, returns true. (Inherited from PFBaseObject.)
	GetGroups	Gets the list of organisational groups included in this group. Note: this method executes a query in the database.
	GetGroupsListRecursive	Gets the recursive list of groups included in this group and its children groups.
	GetGroupsRecursive	Gets the recursive list of groups included in this group and its children groups. More optimized than GetGroupsListRecursive because avoid to load the PFGroups.
	GetGroupUrl	Gets the group form URL.
	GetGroupUrl(PFStructureObject, Int64)	Gets the form URL of the specified group having the specified parent object.
	GetNewPermissionContext	Creates a new permission context based on current object type. (Overrides PFBaseObjectGetNewPermissionContext.)
	GetUsers	Gets the list of users included in this group. Note: this method executes a query in the database.
	GetUsersListRecursive	Gets the recursive list of users included in this group and its children groups.
	GetUsersRecursive	Gets the recursive list of users included in this group and its children groups. More optimized than GetUsersListRecursive because avoid to load the PFUsers.
	InitializeLogger	Use this method to override the way the logger is initialized. (Inherited from PFBaseObject.)
	ProcessPermissions	Compute permissions from permission context and set in data properties. (Inherited from PFBaseObject.)
	RunInTransactionArea	Runs a code with a transaction on object connection. If there is no current transaction and if the code succeed, transaction is committed. If an exception is thrown, transaction is rollback. (Inherited from PFBaseObject.)
	Save	Applies the data of this object in the database. This method will also: -Update the RLS table referencing links between groups and users for this group. -Update relative applications (referencing this group through the roles). -Create a log entry about the changes. (Overrides PFBaseObjectSave.)
	SaveObjectsInDataCollection	Saves data loaded from temp specialized object in data properties collection before save or check hasPendingChanges. (Overrides PFBaseObjectSaveObjectsInDataCollection.)
	SyncWithDomainGroup	Synchronizes all users referenced by this group with the corresponding Active Directory group. Note : this method does nothing if synchronization info are not available.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Top

Fields

	Name	Description
	FieldName_ApplicationContextGuid	Column name in database.
	FieldName_ApplicationContextId	Column name in database.
	FieldName_ApplicationGuid	Column name in database.
	FieldName_ApplicationId	Column name in database.
	FieldName_DisplayName	Column name in database.
	FieldName_DomainGroup	Column name in database.
	FieldName_DomainGroupCreateDisabledUsers	Column name in database.
	FieldName_DomainGroupSyncMode	Column name in database.
	FieldName_Name	Column name in database.
	FieldName_OrganisationalTypeGuid	Column name in database.
	FieldName_OrganisationalTypeId	Column name in database.
	FieldName_RoleGuid	Column name in database.
	StandardGroupName_SiteAdmins	Name of the SiteAdmins standard group.
	StandardGroupName_SiteMembers	Name of the SiteMembers standard group.
	StandardGroupName_SiteOwners	Name of the SiteOwners standard group.
	StandardGroupName_SiteVisitors	Name of the SiteVisitors standard group.

Top

Extension Methods

	Name	Description
	AsT	Casts an object to another type. Returns default(T) if the object is null. (Defined by Utils_Other.)
	EqualsAll	Checks that this object is equal to every object in parameters. (Defined by Utils_Other.)
	EqualsAny	Checks that this object is equal to at least one of the parameters. (Defined by Utils_Other.)
	GetString	Converts an object to String using ToString() method, else returns String.Empty. (Defined by Utils_Other.)
	IsGenericList	Overloaded. Checks if this object is a System.Collections.Generic.List. (Defined by Utils_Linq.)
	IsGenericList(Type)	Overloaded. Checks if this object is a System.Collections.Generic.List using type as T. (Defined by Utils_Linq.)
	Serialize	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	Serialize(String)	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	SerializeJson	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(ListType)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(DataContractJsonSerializerSettings)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)

Top

Reference

Packflow.Core Namespace