Class ADTObject
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Facade class for the entity 'ADTObject'.
public abstract class ADTObject : ObjectBase
- Inheritance
-
objectADTObject
- Derived
Fields
EffectivePermissions
protected ReadOnlyCollection<int> EffectivePermissions
Field Value
- ReadOnlyCollection<int>
Properties
AccessMask
public ReadOnlyCollection<int> AccessMask { get; }
Property Value
- ReadOnlyCollection<int>
BindingDescription
Description property used for binding.
public string BindingDescription { get; }
Property Value
- string
Remarks
Returns GetDescription.
ClassID
The Class ID for the object
public ClassID ClassID { get; }
Property Value
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
CreationTimestamp
The date/time the object was first saved (in UTC).
[ComVisible(false)]
public DateTime CreationTimestamp { get; }
Property Value
- DateTime
DataContext
The DataContext to which this object belongs.
public DataContext DataContext { get; }
Property Value
ExtendedDescription
public virtual string ExtendedDescription { get; }
Property Value
- string
FromMaster
Indicates whether the object came from a Master.
public bool FromMaster { get; }
Property Value
- bool
IsReadOnly
Indicates whether this object is read-only.
public override sealed bool IsReadOnly { get; }
Property Value
- bool
Remarks
IsReadOnly is True if the DataContext to which the object belongs is read-only. Attempting to modify or delete an object marked read-only will produce a ReadOnlyException.
LastModified
The date/time the object was last saved (in UTC).
[ComVisible(false)]
public DateTime LastModified { get; }
Property Value
- DateTime
OID
The Object Identifier that uniquely identifies the object.
[ComVisible(false)]
public OID OID { get; }
Property Value
ParentObject
The object that owns or contains this object, if IsDependent is True.
public override ADTObject ParentObject { get; }
Property Value
SupportedSecurityActions
public virtual Dictionary<int, string> SupportedSecurityActions { get; }
Property Value
- Dictionary<int, string>
SupportedSecurityInheritanceOptions
public virtual Dictionary<SecurityInheritanceOptions, string> SupportedSecurityInheritanceOptions { get; }
Property Value
- Dictionary<SecurityInheritanceOptions, string>
Methods
AddStandardSecurityActions(Dictionary<int, string>, string)
protected static void AddStandardSecurityActions(Dictionary<int, string> collection, string className)
Parameters
| Name | Type | Description |
|---|---|---|
collection |
Dictionary<int, string> | |
className |
string |
AddSupportedSecurityAction(Dictionary<int, string>, SecurityPermission, string)
protected static void AddSupportedSecurityAction(Dictionary<int, string> collection, SecurityPermission action, string className)
Parameters
| Name | Type | Description |
|---|---|---|
collection |
Dictionary<int, string> | |
action |
SecurityPermission | |
className |
string |
CanPerform(SecurityPermission)
Determines whether the user has the necessary permission to perform a specified action on the object
public virtual bool CanPerform(SecurityPermission action)
Parameters
| Name | Type | Description |
|---|---|---|
action |
SecurityPermission |
Returns
- bool
CheckForStub(string, string)
Checks to see if the facade is a stub, and attempts to fetch the full object if so.
protected override void CheckForStub(string className, string location)
Parameters
| Name | Type | Description |
|---|---|---|
className |
string | |
location |
string |
Remarks
CheckForStub checks to see if IsStub is true. If not (IsStub==false), it returns immediately. If IsStub==true, CheckForStub checks to see if the client has View permission. If not, it throws a permission exception. If the client has permission, it calls DataManager.FetchDTO to fetch a full copy of the object from the server.
Duplicate()
Creates a new object that is a copy of the source object.
public ADTObject Duplicate()
Returns
- ADTObject
Returns an ADTObject that is a duplicate of the source object.
Remarks
Use the Duplicate method when you want to create a new object based on an existing object. For example, if you want to create a new job that is similar to an existing one, you would use the Duplicate method.
The new object generally is a complete copy of the source object (including all properties and collections), with a new OID. For some classes the copy is not exact. For example, when you duplicate a job, the new copy does not get the old job's history, log messages, or status.
GetConfigurationReport()
public string GetConfigurationReport()
Returns
- string
GetConfigurationReport(bool)
Gets a Configuration Report for the object.
public string GetConfigurationReport(bool fullDocument)
Parameters
| Name | Type | Description |
|---|---|---|
fullDocument |
bool | If true, returns a full HTML document containing the report for this object. If false, returns only an HTML fragment. |
Returns
- string
GetTopLevelOwner()
Gets the Independent object to which this object ultimately belongs.
public ADTObject GetTopLevelOwner()
Returns
- ADTObject
The Independent object at the top of the ownership chain for this object, or Null if the object is independent or if the owner cannot be found.
InitializeFromEntity()
protected virtual void InitializeFromEntity()
OnEntityReloaded()
Called when the entity is reloaded from a DTO.
protected override void OnEntityReloaded()
OnNewEntity()
Called when a new entity is created.
protected override void OnNewEntity()
ToString()
Returns a description of the object.
public override string ToString()
Returns
- string
Remarks
Returns GetDescription.
Validate(MessageCollection)
public virtual MessageType Validate(MessageCollection Errors)
Parameters
| Name | Type | Description |
|---|---|---|
Errors |
MessageCollection |
Returns
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.IsDependent
- ObjectBase.ClassName
- ObjectBase.GetObjectDescription()
- ObjectBase.GetDescription()
- ObjectBase.HideFieldValueInTextOutput(string)
- ObjectBase.FindOwningObject()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)