The IEntity type exposes the following members.

Methods

  NameDescription
Public methodAddChild
Adds/Moves an entity to be a child of this entity
Public methodAddDefaultRole
Public methodAddGroupRole
Get a group role to this folio. A way to state security for the folio.
Public methodAddUserRole
Get a user role to this folio. A way to state security for the folio.
Public methodAllowChildType
Find out if given type is allowed to be child of this object.
Public methodContainsField
Checks to see if the object contains a specicific field by fielod name. to check
(Inherited from ICartellaObject.)
Public methodCurrentUserCanApproveItem
Public methodGet_Procedure_SelectPagedRelations
Return the "SelectPagedRelationsProcedure" delegate, by the given target type
(Inherited from ICartellaObject.)
Public methodGet_Procedure_SelectPositionedRelations
Return the "SelectPositionedRelationsProcedure" delegate, by the given target type
(Inherited from ICartellaObject.)
Public methodGet_Procedure_SelectRelations
Return the "SelectRelationsProcedure" delegate, by the given target type
(Inherited from ICartellaObject.)
Public methodGetCategorizedChildEntities<(Of <<'(TTarget>)>>)
Public methodGetChildEntities<(Of <<'(TTarget>)>>)
Get the relations collection of the FolioModule's child folio items
Public methodGetChildren<(Of <<'(TOwner, TTargetObject, TTarget>)>>) Obsolete.
Get children of this entity of given type
Public methodGetComments
Public methodGetDeletedChildren
Public methodGetFields
Get a collection of fields.
(Inherited from IBaseObject.)
Public methodGetImmediateChildren
Gets all the immediate children of an entity of any type
Public methodGetParent()()()()
retrieves the parent entity based on the ID_Parent column in the DB
Public methodGetParent<(Of <<'(TInterface, TClass>)>>)()()()() Obsolete.
Retrieve the parent entity of this entity.
Public methodGetUnapprovedChildren
Public methodGetVoteAverage (Inherited from IVotable.)
Public methodGetVoteTotal (Inherited from IVotable.)
Public methodInitialize (Inherited from IBaseObject.)
Public methodParentsLocked
Checks parent chain to see if any parents are locked
Public methodPermissionForUser
Retrieve the permission for specific user on this entity
Public methodRemoveDefaultRole
Public methodRemoveGroupRole
Remove a group role from the folio
Public methodRemoveUserRole
Remove a user role from the folio
Public methodRetrieveFullRecord
Retrieve full content of the object. This method is automatically invoked, when full record retrieval is never done on the object, and indexer call if performed on the fields key that doesn't exist.
(Inherited from ICartellaObject.)
Public methodSetOrdinal
Sets the Ordinal of the entity
Public methodSetParent<(Of <<'(TInterface>)>>) Obsolete.
Set the parent entity for this entity. This entity type must be in the allowed list of parent entity for children. This method is equal to move the current enity around.
Public methodSetupDelegates
Setup the delegate methods for data communications
(Inherited from ICartellaObject.)
Public methodSetUserViewed (Inherited from ITrackable.)
Public methodSetVote (Inherited from IVotable.)
Public methodStartUpdate
Suppress update events. Use "Using" statement to automatically dispose and reset Event update switch. Put the actual object property changes inside the using block
(Inherited from IBatchUpdatable.)
Public methodUpdateData
Sync the data of the object to underlying data record
(Inherited from IBatchUpdatable.)
Public methodValidateRules
Validates instance based on rules stored in the Global Manager. If validation fails, a Validation Exception will be thrown.
(Inherited from ICartellaObject.)

Properties

  NameDescription
Public propertyAdditionalProperties (Inherited from IExtensibleObject.)
Public propertyAllowedChildrenTypes
Get the allowed interface types to be its children. Override by subclasses. It is always a fixed list of types for specific object type.
Public propertyApproved
Approved Status of IEntity
(Inherited from IApprovable.)
Public propertyAutoApprove
If true, all child items and comments are auto approved. Moderartors can set
Public propertyCanRate
True if CanRate for current type in configuration is set to true, otherwise false.
(Inherited from IVotable.)
Public propertyCategories
Get the associated categories for the entity. Returned as CartellaRelations, to allow user to add and remove categories
Public propertyCreationDate
Get the Creation Date of the object
(Inherited from IDatedUniqueObject.)
Public propertyCreationUser
Get the Creation User of the object
(Inherited from ICartellaObject.)
Public propertyCreationUserID
Get the ID of the Creation User
(Inherited from ICartellaObject.)
Public propertyDefaultRoles
Public propertyDeleted
Get, set the delete status of current object
(Inherited from ICartellaObject.)
Public propertyDescription
Get/set the description of entity
Public propertyEditable
Test if this object is editable by the current user.
(Inherited from ICartellaObject.)
Public propertyEntityType
Get the Type of this entity in the form of IEntityType
Public propertyGroupRoles
Get Group Roles belong to this folio
Public propertyID
Get ID of the object
(Inherited from IUniqueObject.)
Public propertyInheritedDefaultRoles
gets all inherited default roles
Public propertyIsDirty
Find out if the object fields values has been changes, but not yet synced to underlying data record.
(Inherited from ICartellaObject.)
Public propertyIsNewObject (Inherited from IBaseObject.)
Public propertyItem
Indexer. Get, set field value by field name.
(Inherited from IBaseObject.)
Public propertyLastUpdatedDate
Get the Last Update Date of the object
(Inherited from IDatedUniqueObject.)
Public propertyLastUpdatedUser
Get the Last Update User of the object
(Inherited from ICartellaObject.)
Public propertyLocked
If true, no more comments or children are allowed.
Public propertyName
Get, set Name of the object
(Inherited from IUniqueObject.)
Public propertyNotifiedEmailsDuringCreation
Public propertyOrdinal
Used for sorting
Public propertyOwnerFolio
Get, set the OwnerFolio of the object. Please note not all objects have owner folios. If not, return null by default for getter, throwing exception for setter.
(Inherited from IHaveOwnerFolio.)
Public propertyOwnerFolioID (Inherited from IHaveOwnerFolio.)
Public propertyOwnerFolioName (Inherited from IHaveOwnerFolio.)
Public propertyParentChain
List of parent elements from Entity to root;
Public propertyParentID
Public propertyPermissions
Get the associated Permissions for the entity. Returned as CartellaRelations, to allow user to add and remove permissions
Public propertyProcedure_FullRecordRetrieval
Get , set the delegate pointing to the data method for performing full record retrieval
(Inherited from ICartellaObject.)
Public propertyProcedure_Insert
Get and set delegate for creating an object that has no id
(Inherited from ICartellaObject.)
Public propertyProcedure_Restore
Get, set the delegate pointing to the data method for performing restore method if the underlying data table support delete status.
(Inherited from ICartellaObject.)
Public propertyProcedure_Update
Get , set the delegate pointing to the data method for performing update to database, base on current object field values
(Inherited from ICartellaObject.)
Public propertyProcedures_SelectPagedRelations
Get, set the dictionary of delegates, pointing to the data method for performing selection of PagedRelations (lazy loading relations) The dictionary is indexed by type of target for the relations object to retrieve.
(Inherited from ICartellaObject.)
Public propertyProcedures_SelectPositionedRelations
Get, set the dictionary of delegates, pointing to the data method for performing selection of PositionedRelations (relation with specific position information for each item). The dictionary is indexed by type of target for the relations object to retrieve.
(Inherited from ICartellaObject.)
Public propertyProcedures_SelectRelations
Get, set the dictionary of delegates, pointing to the data method for performing relation selections. The dictionary is indexed by type of target for the relations object to retrieve.
(Inherited from ICartellaObject.)
Public propertyReadOnly
If true, only editable by Admins. Only Admins can set
Public propertyRelatedEntities
Public propertySelectable
Whether the current entity can be selected by the current user.
Public propertyShareLevel
Get the share level of this entity
Public propertyStopEventUpdate
Switch to determine if event update is allowed. When "StartUpdate" is invoked, this will be set to true, thus stop all update events When the result of "StartUpdate" is disposded, the value reset to false
(Inherited from IBatchUpdatable.)
Public propertySubscriptions (Inherited from ISubscribable.)
Public propertyUniqueIdField
Get Unique ID field in field collection.
(Inherited from IBaseObject.)
Public propertyUniqueViews (Inherited from ITrackable.)
Public propertyUseAverage
True if configuration is set to use averages for the current type, otherwise false.
(Inherited from IVotable.)
Public propertyUserRoles
Get User Roles belong to this folio
Public propertyViewName
The view to use for viewing
Public propertyVote (Inherited from IVotable.)
Public propertyVotes (Inherited from IVotable.)

Events

  NameDescription
Public eventFullRecordRetrieved
Event to fire when the full content of this object is retrieved. This event will only get triggered, if the object is partially constructed.
(Inherited from ICartellaObject.)
Public eventObjectPreValidation
Event to fire preceeding object validation.
(Inherited from ICartellaObject.)
Public eventObjectUpdated
Event to fire when the update field values are updated
(Inherited from ICartellaObject.)

See Also