Classes
Class | Description | |
---|---|---|
EntityRelation | ||
EntityRelationCollection | ||
EntityRelationManager | ||
EntityRelationProcedures | ||
Extensions | ||
SessionIdNeededEventArgs | ||
SubscriptionEventArgs | ||
TempFieldInfoHolder | ||
VisibilityInfo |
Interfaces
Interface | Description | |
---|---|---|
IACSTokenCodeFlow | ||
IAdditionalProperties | ||
IAnnouncement | ||
IAnnouncementManager | ||
IApprovable | ||
IAsset |
Defines the interface for Asset objects.
An Asset is a collection of sets of binary files sharing the same
metadata.
| |
IAssetBinary |
Asset Binary represents a version of a binary file.
It carries all the additional properties with it, which are identified by subclass (e.g. ImageBinary).
This information is captured from the actual binary file and stored in the database upon creation of the binary record.
| |
IAssetBinarySection |
Used to describe a subset of metadata within the binary. Used only by streams in video at this time.
Itself is a virtual concept, only used as hold for set of meta data.
Most binaries only have 1 section to hold the additional information. | |
IAssetChain |
Data Carrier object for search results.
Represents an AssetBinary and all its ancestors.
| |
IAssetCommon |
The base class featuring common characteristics of
all common asset objects.
Please note that the objects themselves are not data-bound. They are simply information holders for corresponding data records. It's perfectly legal to construct a new object without data relevance, populate it with values, and use it to create a new record in the database. It is also legal for one record to have several instances of representive objects. Therefore it is never a correct approach to compare object to object: two instances of same class are equal to each other if they have the same ID. | |
IAssetFolioItem |
Defines the interface of Asset based FolioItem.
Objects inheriting this interface are associated with one Asset.
| |
IAssetFolioItemManager<(Of <(<'T>)>)> |
Defines the interface of AssetFolioItemManager.
It is the manager object to select/create/delete/purge all Folio Item types
containing an Asset member
| |
IAssetMember |
AssetMember is represent a member in an Asset collection.
It always represent a specific file type.
AssetMember is versioned. Each version of the AssetMember is an AssetBinary. The latest AssetBinary is always
the current version.
AssetMember represent a specific file, therefore, its FileName and FileExtension cannot be updated.
| |
IAssetMemberSnapShot |
Represents a snapshot of an AssetMember's specific version.
This is a light weight object potentially used as Domain Model
| |
IAssetMetaInfo |
Interface to serve as carrier.
Implementer must provide mime type information.
Explicitly implemented in order not to
polute asset interfaces.
| |
IAssetSnapShot |
Represents an Asset's specific version.
This is a lightweight object potentially used as Domain Model.
| |
IAssetStorageProvider |
Defines the interface for Storage Provider object in Cartella Asset System.
The Storage Provider is in charge of the storage and lookup of binaries.
| |
IAssetSystemManager |
Defines the interface to the Hub of all Asset functionalities.
It is the entry point to the Asset Management system in Cartella.
| |
IAssetVersioning |
The version aspect of Asset. Extracted as separate interface definition.
| |
IAudioInformation |
Interface specifically for Audio Asset Binary Section
| |
IAuditTrailer |
Defines the interface for AuditTrailer, which is in charge of
Tracking database activities and provide an audit trail.
| |
IAuthenticationEngine |
Defines the interface for the AuthenticationEngine,
the plug-in engine for performing authentication.
It contains a list of authenticator plug-ins for performing authentication.
| |
IAuthenticator | Interface for authenticator plugins to inherit. The plugin registration engine (IAuthenticationEngine) will detect and register the instance of any types inheriting this interface. The authentication plugins are not in charge of providing actual user information, they are stored in the Cartella database. The plugin only need to find out if the user can authenticate with the respective system. Default database authentication is carried out by LicenseManagerBase, not from this system. | |
IAuthenticatorInformation |
Interface to provide authenticator information.
We can also use it to retrieve the actual authenticator.
| |
IAutoConverter |
AutoConverters are conversion components that will automatically execute a conversion from a source member
to one (or many) target members.
Implemented classes do not need to add metadata to the output binary result,
since metadata will be detected when the binary is added to a member in the asset.
The AdditionalProperties property is on the returning object module, is mainly used by BeforeConversion_TaskConfigurationChanges callback to adding arbitrary metadata. | |
IAutoConvertible | ||
IBaseObject |
Definition for the basis of all Data-Bound Objects.
The interface provides the basic functions for a Data-Bound object, including retrieving fields, getting the object ID, get/set of the object Name, get/set the field value by field name. | |
IBaseRelations<(Of <(<'TOwner, TTarget>)>)> |
Definition of based collection object used to store relations between 2 types of objects.
This relations will always return all members of the targets.
| |
IBatchUpdatable | This interface defines the structure of objects that allows batch update. Objects in Cartella general have real time database update, as properties being set. This makes Cartella API intuitive and easy to use. However, there are times when we don't want every property set to cause a database transaction. Here is where IBatchUpdatable coming. It allows batch of property updates to be grouped together and perform database transaction only once afterwards. This is done by set "StopEventUpdate" property to true and stop all property changes from triggering events issued FieldCollections, which is the driving force of per-property updates. | |
IBlogManager |
Interface for the Manager object in charge of select/create/update/delete BlogPost instances
| |
IBlogPost |
Represents the BlogPost object interface.
It is IFolioItem interface with a different name.
There are no definition changes from IFolioItem interface at all
| |
ICalendarEvent | ||
ICalendarEventManager | ||
ICartellaEventHooks | ||
ICartellaEvents |
CartellaEvents interface represents all events fired at the Site level.
| |
ICartellaGlobalManager | Represents the Singleton object, which is the hub os all Cartella objects, managers and events. Its main purpose is to maintain a list of SiteManager instances, also relay all events issue from the SiteManager instances. CartellaGlobalManager is designed to hold a given number of SiteManager instances and keep them around. There will be a expiration time set on each SiteManager. If within the expiration time threshold, no Methods or Properties calls happened on the SiteManager instance at all, the SiteManager instance will be automatically dropped from the pool and erased. This system allows system not need to create a SiteManager instance everytime, also in the same time, not use too much memory to store every unsed SiteManager instances. | |
ICartellaObject |
Definition for the base of all representation of fully accessible data records.
All other fully accessible data records representation types are based on this type.
This interface inherits IBaseObject, IDataUniqueObject, and IBatchUpdatable
| |
ICartellaObjectManager<(Of <(<'T>)>)> | Defines the manager interface for specific object type that is derived from ICartellaObject. All object type managers (e.g. CategoryManager, UserManager) derive from it Classes inplementing this interface will have access to DataAccess Layer, knows data access manager, can get hold of the default procedures module to locate the ObjectDateProceduresImplementaion during construction. | |
ICartellaPagedRelations<(Of <(<'TOwner, TTarget>)>)> |
Represents a Relations object with differred execution.
As objects inheriting this interface is created, on database transaction
is executed. Data transaction is only performed when getting items for specific page.
| |
ICartellaPositionedRelations<(Of <(<'TOwner, TTarget>)>)> |
Definition of based collection object used to store relations between 2 types of objects.
It stored the positioning information of its targets.
| |
ICartellaRelations<(Of <(<'TOwner, TTarget>)>)> |
Built on top of IBaseRelations with the feature of clearing up all target items in the relations object.
| |
ICategory |
Defines the interface for Category. Based on ICartellaObject interface.
| |
ICategoryManager |
Defines the interface for CategoryManager, which the manager object for Category type.
Based on ICartellaObjectManager interface
| |
IComment |
Defines the interface for Comment. Based on ICartellaObject.
Hierarchical
| |
ICommentManager |
Defines the interface for CommentManager, which the manager object for Comment type.
Based on ICartellaObjectManager interface
| |
IContentPage | ||
IContentPageManager | ||
ICustomFieldInfo | ||
IDataProcedureParameters |
Defines the interface of DataProcedureParameters.
It is a wrapper object for the collection of DbParameters to be
fed into database procedure.
It is in charge of casting a string, IField, or generic object value to the desired Database Parameter type. | |
IDatedUniqueObject | ||
IDocument |
Defines the interface for Document entity.
Based on IAssetFolioItem interface
| |
IDocumentManager |
Defines the interface for DocumentManager, the manager object for Document entities.
Based on IFolioItemManager interface.
| |
IEmailDispatcher |
This is the class used to send emails. It is called by EmailContentController.
| |
IEmailNotifier |
Emailer to send out emails with canned messages.
| |
IEmailSubmissionAgent | ||
IEntity |
Defined the interface of Entity objects, which represent user created content within Cartella.
Based on ICartellaObject interface.
| |
IEntityManager<(Of <(<'T>)>)> |
Defines the interface for EntityManager.
Based on ICartellaObjectManager interface.
Provide entity specific manager functionalities on top of CartellaObjectManager
| |
IEntityPathManager | ||
IEntityProcedures | ||
IEntityRelation | ||
IEntityRelationCollection | ||
IEntityRelationManager | ||
IEntityShareLevel |
Define the interface of EntityShareLevel. Based on ICartellaObject interface.
| |
IEntityShareLevelManager |
Defines the interface of EntityShareLevelManager.
Based on ICartellaObjectManager interface.
Please note that this manage doesn't provide Create/Delete fuctions.
Because EntityShareLevel is created/deleted together with the entity it
belongs to.
| |
IEntityType |
Defines the interface of EntityType, which is a wrapper class to Type of entity class.
| |
IEntityView | ||
IEntityViewManager | ||
IExtensibleObject | ||
IExtensibleObjectManager<(Of <(<'T>)>)> | ||
IExternalDocument | ||
IExternalDocumentManager<(Of <(<'TDoc, TFolder>)>)> | ||
IExternalFolder |
Defines the interface for Folder.
Based on IFolioItem interface.
| |
IExternalFolderManager<(Of <(<'TFolder, TDoc>)>)> |
Defines the interface for FolderManager, which is the manager object for all
Folders.
Based on IFolioItemManager interface.
| |
IExternalFolioItem | ||
IExternalFolioItemManager<(Of <(<'T>)>)> | ||
IField |
Defines the interface for the field,
based on the IFieldDefinition interface.
It is a FieldDefinition with a value.
| |
IFieldCollection |
Defines the interface for FieldCollection.
It represent of collection of fields with values.
| |
IFieldDefinition |
Defines the interface for FieldDefinition,
which represents the definition of a specific fields for an object.
| |
IFieldVisibilityConfigurable |
Provides Get/Set of FieldVisibility on implementing Cartella.Classes.ExtensibleObject.
| |
IFolio |
Defines the interface for Folio, which the base collection of
user created content in Cartella.
Based on IEntity interface.
| |
IFolioItem |
Defines the interface for FolioItem.
Base on IEntity Interface
| |
IFolioItemManager<(Of <(<'T>)>)> |
Defines the interface of FolioItemManager.
Based on IEntityManager interface
| |
IFolioManager |
Defines interface for FolioManager, the manager object for all Folios.
Based on IEntityManager interface.
| |
IFolioModule |
Defines the interface for FolioModule object,
which represents a specific collection of Folio Items
under a Folio
| |
IFolioModuleManager |
Defines interface for FolioModuleManager, the manager object for all FolioModule instances.
Based on ICartellaObjectManager interface.
| |
IFolioProcedures |
Defines interface for FolioProcedures, which is the procedures collection
for Folio object type.
Based on IEntityProcedures interface.
| |
IForumDiscussion | ||
IForumPost | ||
IForumSubItem | ||
IForumSubItemManager<(Of <(<'tInteface, tClass>)>)> | ||
IForumTopic | ||
IForumTopicManager | ||
IGallery |
Defines interface for Gallery, collection of images with positions.
Based on IAssetFolioItem interface.
| |
IGalleryManager |
Defines interface for GalleryManager, the manager object for gallery instances.
Based on IFolioItemManager interface.
| |
IGroup |
Defines the interface for Group. Based on ICartellaObject
| |
IGroupManager |
Defines the interface for GroupManager, the manager object for Group objects.
Based on ICartellaObjectManager.
| |
IGroupRole |
Defines the interface of GroupRole. Based on ICartellaObject interface.
| |
IGroupRoleManager |
Defines the interface for GroupRoleManager, the manager object for GroupRole objects.
Based on ICartellaObjectManager
| |
IHasEnumProperty | ||
IHaveOwnerFolio | ||
IIdea | ||
IIdeaManager | ||
IImage |
Defines interface for Image, the asset folio item to present a picture.
Based on IAssetFolioItem interface.
| |
IImageInformation |
Interface specifically for Image Asset types.
It is used to carry Image meta data
| |
IImageManager |
Defines interface for ImageManager, the manager object for Image entities.
Based on IFolioItemManager interface.
| |
ILicenseInfo | ||
ILicenseManager |
Defines interface for LicenseManager, the user specific manager class
in charge of managing seats in the license.
| |
ILicenseManagerBase | Represents the Session-Independent part of License management system. LicenseManagerBase is designed to be a singleton object. It holds the license information for the entire Cartella instance. It is also in charge of authentication/unauthentication of users. Please note that LicenseManagerBase is only in charge of holding the licensing information. Assignments of user/seats is done by its user specific counter part - LicenseManager. It takes a actual user to do the actual licensing works. | |
ILoggable | ||
IManager |
Base interface for all Object-related/User-specifc manager types
| |
IMedia | ||
IMediaInformation |
Interface specifically for Media Asset Binary Section
| |
IMediaManager | ||
IMetaDataDetector |
Defines the interface for services that will detect
metadata from the binary stream.
| |
IModule |
Defines the interface for Module object, which represent a specific collection of FolioItem
types under a Folio
| |
IModuleManager |
Only need to provide select all method
| |
IObjectCombination |
Empty interface, mainly used to event identifications.
Any create/delete of this type of object will mean updates
on all involved IBaseObject parties
| |
IPagedEntityChildrenList<(Of <(<'T, TKey>)>)> | ||
IPaginatedList<(Of <(<'T, TKey>)>)> | ||
IPositionedRelationProceduresExtension |
Defines the interface for inheritable positioned relations procedures.
Similar to IRelationProceduresExtension, except it is for relations objects
that track positions for targets.
| |
IPreference | ||
IPreferenceManager | ||
IProfile | ||
IProfileManager | ||
IReadonlyCartellaObject |
Definition of Data Record representations that are readonly.
| |
IReadonlyDictionary<(Of <(<'TKey, TValue>)>)> |
A dictionary only allows read access once constructed
| |
IReadonlyObjectDataProceduresImplementation |
Defines the interface for ReadonlyObjectDataProceduresImplementation - Procedures collection
for Readonly objects.
Based on IDataProceduresImplementation interface, which is the equivalent of IUserSpecificObjectDataProceduresBase.
| |
IRetrievableField |
This interface allows disabling the read-only state of a field.
This class should be implemented explicitly.
| |
IRole |
Defines the interface for a Role, based on the ICartellaObject interface.
Role is a collection of RolePermissions and can be considered as system-wide
security profile.
| |
IRoleManager |
Defines the interface for RoleManager, the manager object for Role.
Based on ICartellaObjectManager interface.
| |
IRolePermission |
Defines the interface for RolePermission. Based on IReadonlyCartellaObject interface.
| |
ISecurityManager |
Defines the interface for a system in charge of checking if a given object is
allowed for given type of access.
All security logics to be defined here.
It is a pure model with no data access.
For object, use "Allow" method to determine what can be done with given object
For Manager, only need to worry about "Create" permissions.
All method will compare the current users (or anonymous)' permission and viewing level
against object's permission and viewing level
| |
ISiteContent |
The interface represents site wide content resources.
It serves as content store of Cartella for descriptive content
| |
ISiteContentManager |
The interface represent the manager objects for SiteContent entries.
| |
ISiteManager |
Defines the interface for SiteManager. The topmost level Manager object that is instance-specific.
It is in charge of automatically creating all object managers.
It has indexed access to all manager objects.
It provides wrapper functions to create all object types.
It is also the singleton point of event relay to all Cartella activitiy events.
Each request session will create a new SiteManager object. | |
ISubscribable | ||
ISubscription | ||
ISubscriptionManager | ||
ISurveyAnswer | ||
ISurveyAnswerManager | ||
ISurveyAnswerSet | ||
ISurveyAnswerSetManager | ||
ISurveyDefinition | ||
ISurveyDefinitionManager | ||
ISurveyQuestion | ||
ISurveyQuestionManager | ||
ISurveyStep | ||
ISurveyStepManager | ||
ITrackable | ||
IUniqueObject |
Defines the interface for object with unique ID and named
| |
IUnsafePasswordOverride | ||
IUnsafeSiteManager |
This interface defines a set of functions
for a SiteManager, allowing it to authenticate an existing user object.
| |
IUser |
Defines the interface for User Object.
Based on ICartellaObject interface.
| |
IUserEmailLookup | ||
IUserFieldVisibility | ||
IUserFieldVisibilityManager | ||
IUserManager |
Defines the interface for UserManager, the manager object for User objects.
Based on ICartellaObjectManager interface.
| |
IUserRole |
Defines interface for UserRole, based on ICartellaObject interface
| |
IUserRoleManager |
Defines the interface for UserRoleManager, the manager object for UserRole objects.
Based on ICartellaObjectManager
| |
IUserState |
Defines the interface for UserState object, the context of active user instance.
This is a special object that have all properties being 100% dynamic.
Access of any property will result in database query.
The actual user state is tracked in the databse for real time license control.
| |
IUserStatus | ||
IUserStatusComment | ||
IUserViewData | ||
IValidationManager | ||
IValidationRule | ||
IVotable | ||
IVote | ||
IVoteManager | ||
IWiki | ||
IWikiManager |
Delegates
Delegate | Description | |
---|---|---|
SubscriptionNotice |
Enumerations
Enumeration | Description | |
---|---|---|
AvaliableValidationRules | ||
CartellaPermission | ||
FieldVisibility |