IDocumentation Interface |
Namespace: PDTec.IceNet.Domain.Development.BusinessObjects
Assembly: PDTec.IceNet.Domain (in PDTec.IceNet.Domain.dll) Version: 7.2.0.0 (7.2.7583.15464)
SyntaxC#
public interface IDocumentation : IDocumentationBase, IObject
The IDocumentation type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Author |
Gets or sets the Author attribute.
(Inherited from IDocumentationBase.) |
| 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.) |
| Company |
Gets or sets the Company attribute.
(Inherited from IDocumentationBase.) |
| 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.) |
| DocumentationLogo |
Gets or sets the File connected by a Logo relationship in Forward direction.
(Inherited from IDocumentationBase.) |
| DocumentationMarkupText |
Gets or sets the Documentation Markup Text attribute.
(Inherited from IDocumentationBase.) |
| DocumentedPackages |
Gets the collection of Package objects connected by a Documented Packages relationship in Forward direction.
(Inherited from IDocumentationBase.) |
| Folder |
Gets the containing folder.
(Inherited from IObject.) |
| FooterText |
Gets or sets the Footer Text attribute.
(Inherited from IDocumentationBase.) |
| HeaderText |
Gets or sets the Header Text attribute.
(Inherited from IDocumentationBase.) |
| Id |
Gets the object ID. The ID is generated by the platform and
cannot be modified.
(Inherited from IObject.) |
| IsAuthorAssigned |
Gets or sets whether the Author attribute is assigned.
(Inherited from IDocumentationBase.) |
| IsCompanyAssigned |
Gets or sets whether the Company attribute is assigned.
(Inherited from IDocumentationBase.) |
| IsDocumentationMarkupTextAssigned |
Gets or sets whether the DocumentationMarkupText attribute is assigned.
(Inherited from IDocumentationBase.) |
| IsFooterTextAssigned |
Gets or sets whether the FooterText attribute is assigned.
(Inherited from IDocumentationBase.) |
| IsHeaderTextAssigned |
Gets or sets whether the HeaderText attribute is assigned.
(Inherited from IDocumentationBase.) |
| IsLocked |
Indicates if the object is locked.
(Inherited from IObject.) |
| IsPublishingPathAssigned |
Gets or sets whether the PublishingPath attribute is assigned.
(Inherited from IDocumentationBase.) |
| IsValid |
Indicates if the object instance is valid. The object becomes
invalid if the Destroy method has been called.
(Inherited from IObject.) |
| IsVersionAssigned |
Gets or sets whether the Version attribute is assigned.
(Inherited from IDocumentationBase.) |
| 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.) |
| OverviewCharts |
Gets the collection of Chart objects connected by a Overview Charts relationship in Forward direction.
(Inherited from IDocumentationBase.) |
| PublishingPath |
Gets or sets the Publishing Path attribute.
(Inherited from IDocumentationBase.) |
| Version |
Gets or sets the Version attribute.
(Inherited from IDocumentationBase.) |
Methods| Name | Description | |
|---|---|---|
 | AddDocumentedPackages |
Adds pItem to the collection of Package objects connected by Documented Packages relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| 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.) |
| AddOverviewCharts |
Adds pItem to the collection of Chart objects connected by Overview Charts relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| AsT | Obsolete.
Casts to a Business Object interface.
(Inherited from IObject.) |
| BuildHtml | |
| BuildHtmlZip | |
| BuildXml | |
| BuildXmlZip | |
| 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.) |
| ClearDocumentedPackages |
Clears the collection of Package objects connected by Documented Packages relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| ClearOverviewCharts |
Clears the collection of Chart objects connected by Overview Charts relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| ContainsDocumentedPackages |
Determines whether pItem is contained in the collection of Package objects connected by Documented Packages relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| ContainsOverviewCharts |
Determines whether pItem is contained in the collection of Chart objects connected by Overview Charts relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| 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 Documentation.
(Inherited from IDocumentationBase.) |
| 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.) |
| GetMarkupText | |
| 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.) |
| GetTableAttributes |
Gets the table attributes of the Documentation.
(Inherited from IDocumentationBase.) |
| GetTableAttributesTemplateRow |
Creates a Documentation table attribute row.
(Inherited from IDocumentationBase.) |
| GetTableAttrTemplateRow |
Gets a table attribute template row.
(Inherited from IObject.) |
| GetTableAttrValues |
Gets the table attribute values.
(Inherited from IObject.) |
| InsertDocumentedPackages |
Inserts pItem into the collection of Package objects connected by Documented Packages relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| InsertOverviewCharts |
Inserts pItem into the collection of Chart objects connected by Overview Charts relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| 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.) |
| RemoveDocumentedPackages |
Removes pItem from the collection of Package objects connected by Documented Packages relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| RemoveOverviewCharts |
Removes pItem from the collection of Chart objects connected by Overview Charts relationships in Forward direction.
(Inherited from IDocumentationBase.) |
| SaveMarkupText | |
| SetAttributes |
Sets all attributes of the Documentation.
(Inherited from IDocumentationBase.) |
| 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.) |
| SetTableAttributes |
Sets the table attributes of the Documentation.
(Inherited from IDocumentationBase.) |
| 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.) |
| TryGetAuthor |
Attempts to retrieve the Author attribute.
(Inherited from IDocumentationBase.) |
| TryGetCompany |
Attempts to retrieve the Company attribute.
(Inherited from IDocumentationBase.) |
| TryGetDocumentationMarkupText |
Attempts to retrieve the DocumentationMarkupText attribute.
(Inherited from IDocumentationBase.) |
| TryGetFooterText |
Attempts to retrieve the FooterText attribute.
(Inherited from IDocumentationBase.) |
| TryGetHeaderText |
Attempts to retrieve the HeaderText attribute.
(Inherited from IDocumentationBase.) |
| TryGetPublishingPath |
Attempts to retrieve the PublishingPath attribute.
(Inherited from IDocumentationBase.) |
| 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.) |
| TryGetVersion |
Attempts to retrieve the Version attribute.
(Inherited from IDocumentationBase.) |
| 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