ISubscriptionConfig Interface |
Subscription Config base interface.
Namespace: PDTec.IceNet.Domain.Subscription.BusinessObjects
Assembly: PDTec.IceNet.Domain (in PDTec.IceNet.Domain.dll) Version: 7.2.0.0 (7.2.7583.15464)
SyntaxC#
public interface ISubscriptionConfig : ISubscriptionConfigBase, IObject
The ISubscriptionConfig type exposes the following members.
Properties| 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.) |
| DefaultFrom |
Gets or sets the Default FROM attribute.
(Inherited from ISubscriptionConfigBase.) |
| Description |
Gets or sets the object description. The description can be empty.
(Inherited from IObject.) |
| EmailTitle |
Gets or sets the Email title attribute.
(Inherited from ISubscriptionConfigBase.) |
| 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.) |
| IsDefaultFromAssigned |
Gets or sets whether the DefaultFrom attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsEmailTitleAssigned |
Gets or sets whether the EmailTitle attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsLocked |
Indicates if the object is locked.
(Inherited from IObject.) |
| IsMailIntervalAssigned |
Gets or sets whether the MailInterval attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsMessagesVaultAssigned |
Gets or sets whether the MessagesVault attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsOverwriteUserAddressAssigned |
Gets or sets whether the OverwriteUserAddress attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsPortNumberAssigned |
Gets or sets whether the PortNumber attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsRedirectPageAssigned |
Gets or sets whether the RedirectPage attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsSendMailAllowedAssigned |
Gets or sets whether the SendMailAllowed attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsServerEnableSslAssigned |
Gets or sets whether the ServerEnableSsl attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsServerNameAssigned |
Gets or sets whether the ServerName attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsServerPasswordAssigned |
Gets or sets whether the ServerPassword attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsServerUserAssigned |
Gets or sets whether the ServerUser attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| IsStyleXslAssigned |
Gets or sets whether the StyleXsl attribute is assigned.
(Inherited from ISubscriptionConfigBase.) |
| 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.) |
| MailInterval |
Gets or sets the Mail interval attribute.
(Inherited from ISubscriptionConfigBase.) |
| MessagesVault |
Gets or sets the Messages vault attribute.
(Inherited from ISubscriptionConfigBase.) |
| 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.) |
| OverwriteUserAddress |
Gets or sets the Overwrite user address attribute.
(Inherited from ISubscriptionConfigBase.) |
| PortNumber |
Gets or sets the Port number attribute.
(Inherited from ISubscriptionConfigBase.) |
| RedirectPage |
Gets or sets the Redirect page attribute.
(Inherited from ISubscriptionConfigBase.) |
| SendMailAllowed |
Gets or sets the Send mail allowed attribute.
(Inherited from ISubscriptionConfigBase.) |
| ServerEnableSsl |
Gets or sets the Server enable SSL attribute.
(Inherited from ISubscriptionConfigBase.) |
| ServerName |
Gets or sets the Server name attribute.
(Inherited from ISubscriptionConfigBase.) |
| ServerPassword |
Gets or sets the Server password attribute.
(Inherited from ISubscriptionConfigBase.) |
| ServerUser |
Gets or sets the Server user name attribute.
(Inherited from ISubscriptionConfigBase.) |
| StyleXsl |
Gets or sets the Style XSL attribute.
(Inherited from ISubscriptionConfigBase.) |
Methods| 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.) |
| GetAttributes |
Gets all attributes of the Subscription Config.
(Inherited from ISubscriptionConfigBase.) |
| 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.) |
| SetAttributes |
Sets all attributes of the Subscription Config.
(Inherited from ISubscriptionConfigBase.) |
| 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.) |
| TryGetDefaultFrom |
Attempts to retrieve the DefaultFrom attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetEmailTitle |
Attempts to retrieve the EmailTitle attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetMailInterval |
Attempts to retrieve the MailInterval attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetMessagesVault |
Attempts to retrieve the MessagesVault attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetOverwriteUserAddress |
Attempts to retrieve the OverwriteUserAddress attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetPortNumber |
Attempts to retrieve the PortNumber attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetRedirectPage |
Attempts to retrieve the RedirectPage attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetSendMailAllowed |
Attempts to retrieve the SendMailAllowed attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetServerEnableSsl |
Attempts to retrieve the ServerEnableSsl attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetServerName |
Attempts to retrieve the ServerName attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetServerPassword |
Attempts to retrieve the ServerPassword attribute.
(Inherited from ISubscriptionConfigBase.) |
| TryGetServerUser |
Attempts to retrieve the ServerUser attribute.
(Inherited from ISubscriptionConfigBase.) |
| 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.) |
| TryGetStyleXsl |
Attempts to retrieve the StyleXsl attribute.
(Inherited from ISubscriptionConfigBase.) |
| UnLock |
Unlock the object.
(Inherited from IObject.) |
Extension Methods| 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.) |
See Also