IFileCheckinEventImpl Interface |
Namespace: PDTec.IceNet.Core.Model.File
public interface IFileCheckinEventImpl : ICustomObjectEventImpl<FileCheckinEventArgs>, IObjectEventImpl, IObject
The IFileCheckinEventImpl type exposes the following members.
Name | Description | |
---|---|---|
ChangedBy |
Gets the name of the user who changed the object last.
(Inherited from IObject.) | |
ChangedOn |
Gets the point of time the object was changed last.
(Inherited from IObject.) | |
CreatedBy |
Gets the name of the user who created the object.
(Inherited from IObject.) | |
CreatedOn |
Gets the point of time the object was created.
(Inherited from IObject.) | |
Description |
Gets or sets the object description. The description can be empty.
(Inherited from IObject.) | |
Folder |
Gets the containing folder.
(Inherited from IObject.) | |
Id |
Gets the object ID. The ID is generated by the platform and
cannot be modified.
(Inherited from IObject.) | |
IsLocked |
Indicates if the object is locked.
(Inherited from IObject.) | |
IsValid |
Indicates if the object instance is valid. The object becomes
invalid if the Destroy method has been called.
(Inherited from IObject.) | |
LockedBy |
Gets the name of the user who holds a lock on the object, empty
string if the object is not locked.
(Inherited from IObject.) | |
LockedOn |
Gets the lock timestamp, if object is locked. DateTime.MinValue if not.
(Inherited from IObject.) | |
Name |
Gets or sets the object name. The name cannot be an empty string. It is
modifiable and does not have to be unique.
(Inherited from IObject.) | |
ObjType |
Gets the object type.
(Inherited from IObject.) |
Name | Description | |
---|---|---|
AddKey |
Adds a new key to the object. The key must be unique
within the system context (e.g. unique per database).
(Inherited from IObject.) | |
AsT | Obsolete.
Casts to a Business Object interface.
(Inherited from IObject.) | |
CastT |
Casts to a Business Object interface. Throws an exception if the Business Object
interface is not available for this object.
(Inherited from IObject.) | |
ChangeObjType |
Change the object type.
(Inherited from IObject.) | |
CopyTo |
Copies the object. Attributes of the object are copied, relationships not.
(Inherited from IObject.) | |
DeleteKey |
Removes a key from the object.
(Inherited from IObject.) | |
Destroy |
Deletes the object (and its relationships).
(Inherited from IObject.) | |
Execute |
This method is called when the custom BO event is triggered.
(Inherited from ICustomObjectEventImplArgs.) | |
GetAttrValue(IAttrDef) |
Retrieves the specified attribute value.
(Inherited from IObject.) | |
GetAttrValue(String, String) |
Retrieves the specified attribute value.
(Inherited from IObject.) | |
GetAttrValue(IAttrDef, Boolean) | Obsolete.
Retrieves the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
GetAttrValue(String, String, Boolean) | Obsolete.
Retrieves the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
GetAttrValues |
Get all attribute values of the object.
(Inherited from IObject.) | |
GetFolder |
Retrieves the object's folder.
(Inherited from IObject.) | |
GetKeys |
Retrieves the object's (unique) keys.
(Inherited from IObject.) | |
GetLockInfo |
Retrieves information about the object's lock status.
(Inherited from IObject.) | |
GetObjType |
Retrieve the object type.
(Inherited from IObject.) | |
GetRelationships(RelDirection) |
Retrieves all attached relationships of a specific direction (regardless of their relationship type).
(Inherited from IObject.) | |
GetRelationships(String, RelDirection) |
Retrieves all attached relationships of a specific role (relationship type/direction combination).
(Inherited from IObject.) | |
GetRelationships(IRelType, RelDirection) |
Retrieves all attached relationships of a specific relationship type in a
specific direction.
(Inherited from IObject.) | |
GetSingleRelationship(String, RelDirection) |
Retrieves a single relationship (omit the array overhead).
(Inherited from IObject.) | |
GetSingleRelationship(IRelType, RelDirection) |
Retrieves a single relationship (omit the array overhead).
(Inherited from IObject.) | |
GetTableAttrTemplateRow |
Gets a table attribute template row.
(Inherited from IObject.) | |
GetTableAttrValues |
Gets the table attribute values.
(Inherited from IObject.) | |
IsOf(String) |
Indicates if the object conforms to a specific object type directly
or indirectly (is a subtype of).
(Inherited from IObject.) | |
IsOf(IObjType) |
Indicates if the object conforms to a specific object type directly
or indirectly (is a subtype of).
(Inherited from IObject.) | |
Lock |
Lock the object.
(Inherited from IObject.) | |
MoveTo |
Moves the object to another folder.
(Inherited from IObject.) | |
QueryInterface |
Cast to a Business Object interface.
(Inherited from IObject.) | |
Reload |
Refreshes the object data from secondary storage (e.g. database)
if available. Use this method to retrieve up-to-date audit information
(ChangedBy, ChangedOn properties).
(Inherited from IObject.) | |
SetAttrValue(IAttrDef, Object) |
Stores the specified attribute value.
(Inherited from IObject.) | |
SetAttrValue(String, String, Object) |
Stores the specified attribute value.
(Inherited from IObject.) | |
SetAttrValues |
Set multiple attribute values with a single method call.
(Inherited from IObject.) | |
SetRelationshipIndex |
Re-position a relationship within the object/reltype/direction order.
(Inherited from IObject.) | |
SetRelationshipIndices |
Re-order all relationships of a object/reltype/direction context.
(Inherited from IObject.) | |
SetTableAttrValues |
Sets the table attribute values.
(Inherited from IObject.) | |
Touch |
Updates the ChangedBy and ChangedOn information.
(Inherited from IObject.) | |
TryCastT |
Casts to a Business Object interface.
(Inherited from IObject.) | |
TryGetAttrValue(IAttrDef, Boolean) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(IAttrDef, DateTime) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(IAttrDef, Double) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(IAttrDef, Int64) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(IAttrDef, Object) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(IAttrDef, String) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(String, String, Boolean) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(String, String, DateTime) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(String, String, Double) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(String, String, Int64) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(String, String, Object) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetAttrValue(String, String, String) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) | |
TryGetSingleRelationship(String, RelDirection, IRelationship) |
Tries to retrieves a single relationship.
(Inherited from IObject.) | |
TryGetSingleRelationship(IRelType, RelDirection, IRelationship) |
Tries to retrieves a single relationship.
(Inherited from IObject.) | |
UnLock |
Unlock the object.
(Inherited from IObject.) |
Name | Description | |
---|---|---|
GetFolderId |
Gets the folder ID without unneccessarily retrieving the full folder information.
(Defined by ModelExtensions.) | |
GetRepository |
Gets the corresponding repository for an object.
(Defined by ModelExtensions.) | |
IsConnected(String, RelDirection) | Overloaded.
Detects whether an object is connected by at least one relationship of a specific type.
(Defined by ModelExtensions.) | |
IsConnected(IRelType, RelDirection) | Overloaded.
Detects whether an object is connected by at least one relationship of a specific type.
(Defined by ModelExtensions.) |
This example explains how to define and trigger custom business objects events. We implement a FileCheckin event triggered by the IFile BO that signals the successful checkin of binary content and provides the possibility to execute additional functionality after the checkin.
The following code shows how to define a custom event interface. We use FileCheckinEventArgs as its EventArgs type:
/// <summary> /// Interface to implement a FileCheckin event triggered by the IFile business object. /// This event is triggered after succesfull Write, Connect and Append actions. /// The execution sequence order is <c>SupertypesFirst</c>. /// </summary> public interface IFileCheckinEventImpl : ICustomObjectEventImpl<FileCheckinEventArgs> { }
The following code shows how to trigger the event inside the implementation of the BO method implementation of the interface IFile:
public ContentVersion WriteContent( bool newVersion, string description, string vaultName, string filename, byte[] aContent) { ContentVersion sContentVersion; // Store binary content in vault and create ContentVersion instance... // // <BO Implementation> // // Update object data (externsion, timestamps)... SetAttrValue("Core.File", "Extension", Path.GetExtension(filename)); Touch(); // Trigger the FileCheckin event... TriggerEvent<IFileCheckinEventImpl, FileCheckinEventArgs>(new FileCheckinEventArgs(FileCheckinAction.Write, sContentVersion), ObjectEventOrder.SupertypesFirst); // Done... return sContentVersion; }
This example explains how to implement custom business objects events. We use the FileCheckin event triggered by the IFile BO to write the size and filename of the currently checked-in file into the description of the object after successful checkin of binary content.
The following code shows how to implement the custom event interface IFileCheckinEventImpl:
public class CFileCheckinEventImpl : CObjectImplBase, IFileCheckinEventImpl { public CFileCheckinEventImpl(IRepository pRepository, IObjectImpl pObject) : base(pRepository, pObject) { } public void Execute(FileCheckinEventArgs eventData) { Description = string.Format( "Current file: {0}, {1} bytes", eventData.ContentVersion.FileName, eventData.ContentVersion.ContentSize); } }
The following code shows how to register the event implementation with a specific object type "PDTec.ICR.BookingReceipt". The event is only executed on objects of type "PDTec.ICR.BookingReceipt" or subtypes. The behavior of any other File objects remain unchanged.
[ObjectImpl(ObjTypeName="PDTec.ICR.BookingReceipt", Interface=typeof(IFileCheckinEventImpl))] public class CFileCheckinEventImplFactory : IObjectImplFactory { public IObject CreateObject(IRepository pRepository, IObjectImpl pBaseImpl) { return new CFileCheckinEventImpl(pRepository, pBaseImpl); } }