Click or drag to resize

IObject Interface

The representation of an object of any type.

Namespace:  PDTec.IceNet.Core.Model
Assembly:  PDTec.IceNet.Core (in PDTec.IceNet.Core.dll) Version: 7.2.0.0 (7.2.7583.15464)
Syntax
C#
Copy
public interface IObject

The IObject type exposes the following members.

Properties
  NameDescription
Public propertyChangedBy
Gets the name of the user who changed the object last.
Public propertyChangedOn
Gets the point of time the object was changed last.
Public propertyCreatedBy
Gets the name of the user who created the object.
Public propertyCreatedOn
Gets the point of time the object was created.
Public propertyDescription
Gets or sets the object description. The description can be empty.
Public propertyFolder
Gets the containing folder.
Public propertyId
Gets the object ID. The ID is generated by the platform and cannot be modified.
Public propertyIsLocked
Indicates if the object is locked.
Public propertyIsValid
Indicates if the object instance is valid. The object becomes invalid if the Destroy method has been called.
Public propertyLockedBy
Gets the name of the user who holds a lock on the object, empty string if the object is not locked.
Public propertyLockedOn
Gets the lock timestamp, if object is locked. DateTime.MinValue if not.
Public propertyName
Gets or sets the object name. The name cannot be an empty string. It is modifiable and does not have to be unique.
Public propertyObjType
Gets the object type.
Top
Methods
  NameDescription
Public methodAddKey
Adds a new key to the object. The key must be unique within the system context (e.g. unique per database).
Public methodAsT Obsolete.
Casts to a Business Object interface.
Public methodCastT
Casts to a Business Object interface. Throws an exception if the Business Object interface is not available for this object.
Public methodChangeObjType
Change the object type.
Public methodCopyTo
Copies the object. Attributes of the object are copied, relationships not.
Public methodDeleteKey
Removes a key from the object.
Public methodDestroy
Deletes the object (and its relationships).
Public methodGetAttrValue(IAttrDef)
Retrieves the specified attribute value.
Public methodGetAttrValue(String, String)
Retrieves the specified attribute value.
Public methodGetAttrValue(IAttrDef, Boolean) Obsolete.
Retrieves the specified attribute value and indicates if the value is assigned.
Public methodGetAttrValue(String, String, Boolean) Obsolete.
Retrieves the specified attribute value and indicates if the value is assigned.
Public methodGetAttrValues
Get all attribute values of the object.
Public methodGetFolder
Retrieves the object's folder.
Public methodGetKeys
Retrieves the object's (unique) keys.
Public methodGetLockInfo
Retrieves information about the object's lock status.
Public methodGetObjType
Retrieve the object type.
Public methodGetRelationships(RelDirection)
Retrieves all attached relationships of a specific direction (regardless of their relationship type).
Public methodGetRelationships(String, RelDirection)
Retrieves all attached relationships of a specific role (relationship type/direction combination).
Public methodGetRelationships(IRelType, RelDirection)
Retrieves all attached relationships of a specific relationship type in a specific direction.
Public methodGetSingleRelationship(String, RelDirection)
Retrieves a single relationship (omit the array overhead).
Public methodGetSingleRelationship(IRelType, RelDirection)
Retrieves a single relationship (omit the array overhead).
Public methodGetTableAttrTemplateRow
Gets a table attribute template row.
Public methodGetTableAttrValues
Gets the table attribute values.
Public methodIsOf(String)
Indicates if the object conforms to a specific object type directly or indirectly (is a subtype of).
Public methodIsOf(IObjType)
Indicates if the object conforms to a specific object type directly or indirectly (is a subtype of).
Public methodLock
Lock the object.
Public methodMoveTo
Moves the object to another folder.
Public methodQueryInterface
Cast to a Business Object interface.
Public methodReload
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).
Public methodSetAttrValue(IAttrDef, Object)
Stores the specified attribute value.
Public methodSetAttrValue(String, String, Object)
Stores the specified attribute value.
Public methodSetAttrValues
Set multiple attribute values with a single method call.
Public methodSetRelationshipIndex
Re-position a relationship within the object/reltype/direction order.
Public methodSetRelationshipIndices
Re-order all relationships of a object/reltype/direction context.
Public methodSetTableAttrValues
Sets the table attribute values.
Public methodTouch
Updates the ChangedBy and ChangedOn information.
Public methodTryCastT
Casts to a Business Object interface.
Public methodTryGetAttrValue(IAttrDef, Boolean)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(IAttrDef, DateTime)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(IAttrDef, Double)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(IAttrDef, Int64)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(IAttrDef, Object)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(IAttrDef, String)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(String, String, Boolean)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(String, String, DateTime)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(String, String, Double)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(String, String, Int64)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(String, String, Object)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetAttrValue(String, String, String)
Attempts to get the specified attribute value and indicates if the value is assigned.
Public methodTryGetSingleRelationship(String, RelDirection, IRelationship)
Tries to retrieves a single relationship.
Public methodTryGetSingleRelationship(IRelType, RelDirection, IRelationship)
Tries to retrieves a single relationship.
Public methodUnLock
Unlock the object.
Top
Extension Methods
  NameDescription
Public Extension MethodGetFolderId
Gets the folder ID without unneccessarily retrieving the full folder information.
(Defined by ModelExtensions.)
Public Extension MethodGetRepository
Gets the corresponding repository for an object.
(Defined by ModelExtensions.)
Public Extension MethodIsConnected(String, RelDirection)Overloaded.
Detects whether an object is connected by at least one relationship of a specific type.
(Defined by ModelExtensions.)
Public Extension MethodIsConnected(IRelType, RelDirection)Overloaded.
Detects whether an object is connected by at least one relationship of a specific type.
(Defined by ModelExtensions.)
Top
Examples

This example shows how to create objects.

C#
Copy
IObjType pObjType = Repository.GetObjTypeByName("PDTec.ICR.SportsCar");
IFolder  pFolder  = Repository.GetFolderByKey("ICR.Data.Cars");

Repository.ExecuteTransaction(delegate()
{
    // Create an object...
    IObject pNewObject = Repository.pObjType.CreateObject(pFolder, "Porsche 911", "");

    // ...[do something with the new object]...

});
Examples

This example shows how to retrieve objects.

C#
Copy
// Retrieve an object (identified by an object ID)...
IObject pObject    = Repository.GetObject(objectId);

// ...[do something with the object]...
See Also