Class FolderEntity
Inheritance
System.Object
FolderEntity
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
public class FolderEntity : EntityObject
Constructors
Declaration
Declaration
public FolderEntity(PrimaryKeyId primaryKeyId)
Parameters
Declaration
public FolderEntity(string metaClassName)
Parameters
| Type |
Name |
Description |
| System.String |
metaClassName |
|
Declaration
public FolderEntity(string metaClassName, PrimaryKeyId primaryKeyId)
Parameters
| Type |
Name |
Description |
| System.String |
metaClassName |
|
| PrimaryKeyId |
primaryKeyId |
|
Fields
Declaration
public const string ClassName = "Folder"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldCreated = "Created"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldCreatorId = "CreatorId"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldDescription = "Description"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldHasChildren = "HasChildren"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldModified = "Modified"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldModifierId = "ModifierId"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldName = "Name"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldOutlineLevel = "OutlineLevel"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldOutlineNumber = "OutlineNumber"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldParent = "Parent"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldParentId = "ParentId"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string FieldScopeIndex = "ScopeIndex"
Field Value
| Type |
Description |
| System.String |
|
Declaration
public const string PrimaryKeyName = "PrimaryKeyId"
Field Value
| Type |
Description |
| System.String |
|
Properties
Declaration
public DateTime Created { get; set; }
Property Value
| Type |
Description |
| System.DateTime |
|
Declaration
public string CreatorId { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public string Description { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public EntityObjectProperty[] ExtendedProperties { get; set; }
Property Value
Declaration
public bool HasChildren { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Declaration
public DateTime Modified { get; set; }
Property Value
| Type |
Description |
| System.DateTime |
|
Declaration
public string ModifierId { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public string Name { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public int OutlineLevel { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
Declaration
public string OutlineNumber { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public string Parent { get; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public PrimaryKeyId? ParentId { get; set; }
Property Value
Declaration
public int? ScopeIndex { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int32> |
|
Methods
Adds the child to the parent folder.
Declaration
public static FolderEntity AppendFolder(PrimaryKeyId? parentId, FolderEntity child)
Parameters
Returns
Copies the specified folder id.
Declaration
public static void CopyRecursive(PrimaryKeyId folderId, PrimaryKeyId parentId)
Parameters
Deletes specified folder and all its children.
Declaration
public static void DeleteRecursive(FolderEntity folder)
Parameters
| Type |
Name |
Description |
| FolderEntity |
folder |
The folder to delete.
|
Declaration
public static FolderElementEntity[] GetChildElements(PrimaryKeyId parentId)
Parameters
Returns
Declaration
public static FolderElementEntity[] GetChildElements(PrimaryKeyId parentId, out int total)
Parameters
| Type |
Name |
Description |
| PrimaryKeyId |
parentId |
The parent id.
|
| System.Int32 |
total |
Returns the total count.
|
Returns
Declaration
public static FolderElementEntity[] GetChildElements(PrimaryKeyId parentId, int? startIndex, int? count, out int total)
Parameters
| Type |
Name |
Description |
| PrimaryKeyId |
parentId |
The parent id.
|
| System.Nullable<System.Int32> |
startIndex |
The start index.
|
| System.Nullable<System.Int32> |
count |
The count.
|
| System.Int32 |
total |
Returns the total count.
|
Returns
Declaration
public static FolderEntity[] GetChildFolders(PrimaryKeyId parentId)
Parameters
Returns
Declaration
public static FolderEntity[] GetChildFolders(PrimaryKeyId parentId, out int total)
Parameters
| Type |
Name |
Description |
| PrimaryKeyId |
parentId |
The parent folder id.
|
| System.Int32 |
total |
The total.
|
Returns
Declaration
public static FolderEntity[] GetChildFolders(PrimaryKeyId parentId, int? startIndex, int? count, out int total)
Parameters
| Type |
Name |
Description |
| PrimaryKeyId |
parentId |
The parent id.
|
| System.Nullable<System.Int32> |
startIndex |
The start index.
|
| System.Nullable<System.Int32> |
count |
The count.
|
| System.Int32 |
total |
The returns the total count.
|
Returns
Declaration
public static FolderEntity GetFolderById(int folderId)
Parameters
| Type |
Name |
Description |
| System.Int32 |
folderId |
The folder id.
|
Returns
Returns a folder with given ouline number.
Declaration
public static FolderEntity GetFolderByOulineNumber(string outlineNumber)
Parameters
| Type |
Name |
Description |
| System.String |
outlineNumber |
The outline number.
|
Returns
Returns all parent folders for given folder.
Declaration
public static FolderEntity[] GetPathToFolder(FolderEntity folder)
Parameters
Returns
Returns total object count.
Declaration
public static int GetTotalCount()
Returns
| Type |
Description |
| System.Int32 |
|
Declaration
protected void InitializeProperties()
Determines whether is target folder have child with the specified folderid (name).
Declaration
public static bool IsExistingFolder(int folderId, int targetFolderId)
Parameters
| Type |
Name |
Description |
| System.Int32 |
folderId |
The folder id.
|
| System.Int32 |
targetFolderId |
The target folder id.
|
Returns
| Type |
Description |
| System.Boolean |
true if is target folder have child the specified folder name; otherwise, false.
|
Declaration
public static FolderEntity[] ListRootFolders()
Returns
Moves the specified folder id.
Declaration
public static void Move(PrimaryKeyId folderId, PrimaryKeyId? newParentId)
Parameters
Moves the specified folder.
Declaration
public static void Move(FolderEntity folder, PrimaryKeyId? newParentId)
Parameters