Skip to main content
.NET 6.0+

IObjectSpace Members

Declares members implemented by Object Space.

Properties

Name Description
Database Gets the name of the database used when a connection associated with the current Object Space’s container for in-memory objects is opened.
IsCommitting Indicates whether the Object Space is currently committing the changes made to its object(s).
IsConnected Indicates whether the Object Space’s container for in-memory objects is connected to the database.
IsDeleting Indicates whether the current Object Space is about to delete an object(s).
IsDisposed Gets a value indicating whether an Object Space has been disposed of.
IsModified Specifies whether objects belonging to the current Object Space are modified.
IsReloading Gets a boolean value indicating whether or not the Object Space is reloading.
ModifiedObjects Returns a collection of objects that have been created, modified or deleted after they were retrieved or committed.
NonPersistentChangesEnabled
Owner Specifies an object that owns the current Object Space.
ServiceProvider Gets the IServiceProvider used to access the application’s services.
TypesInfo Gets information on the business classes added to the Application Model (see IModelBOModel).

Methods

Name Description
ApplyCriteria(Object, CriteriaOperator) Filters the specified collection according to the specified criteria on the server side.
ApplyFilter(Object, CriteriaOperator) Filters a particular collection on the client side.
CanApplyCriteria(Type) Indicates whether collections of a particular type can be filtered on the server side.
CanApplyFilter(Object) Indicates whether a particular collection can be filtered on the client side.
CanInstantiate(Type) Indicates whether instances of a particular type can be created.
CommitChanges() Saves all the changes made to the persistent objects belonging to the current Object Space to the database.
Contains(Object) Indicates whether a specified object belongs to the current Object Space.
CreateCollection(Type, CriteriaOperator, IList<SortProperty>) Creates and initializes a collection of objects of the specified type, filtered according to the specified criteria and sorted according to the given sorting list.
CreateCollection(Type, CriteriaOperator) Creates and initializes a collection of objects of the specified type, filtered according to the specified criteria.
CreateCollection(Type) Creates and initializes a collection of objects of the specified type.
CreateDataView(Type, IList<DataViewExpression>, CriteriaOperator, IList<SortProperty>) Returns a list of data records retrieved from a database without loading complete business classes (a data view).
CreateDataView(Type, String, CriteriaOperator, IList<SortProperty>) Returns a list of data records retrieved from a database without loading complete business classes (a data view). Values in each data record can be obtained from specific business class properties directly, or be evaluated by the database server using complex expressions.
CreateInstantFeedbackCollection(Type, CriteriaOperator) Creates an InstantFeedback mode collection that contains the specified type objects filtered according to the criteria.
CreateNestedObjectSpace() Creates a nested Object Space.
CreateObject(Type) Creates an object of the specified type.
CreateObject<ObjectType>() Creates an object of the type designated by the specified generic type parameter.
CreateParseCriteriaScope() Used when parsing a CriteriaOperator represented by a string and containing references to persistent objects.
CreateServerCollection(Type, CriteriaOperator) Creates a Server mode collection of objects specified by the objectType parameter.
Delete(IList) Deletes the specified persistent objects and their aggregated objects from the database.
Delete(Object) Marks the specified persistent object and its aggregated objects as deleted from a persistent storage.
Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable.
EnableObjectDeletionOnRemove(Object, Boolean) Enables/disables the deletion of persistent objects from the data source when they are removed from the specified collection.
Evaluate(Type, CriteriaOperator, CriteriaOperator) Evaluates the specified criteria for business objects of the given type.
FindObject(Type, CriteriaOperator, Boolean) Searches for the first object that matches the specified criteria and is of the specified type.
FindObject(Type, CriteriaOperator) Searches for the first object that matches the specified criteria and is of the specified type. The search takes uncommitted changes into account.
FindObject<ObjectType>(CriteriaOperator, Boolean) Searches for the first object that matches the specified criteria. The object’s type is designated by the specified generic type parameter.
FindObject<ObjectType>(CriteriaOperator) Searches for the first object that matches the specified criteria. The object’s type is designated by the specified generic type parameter. The search takes uncommitted changes into account.
FirstOrDefault<ObjectType>(Expression<Func<ObjectType, Boolean>>, Boolean) Searches for the first object that matches the specified lambda expression. The generic parameter determines the object’s type. This method takes uncommitted changes into account.
FirstOrDefault<ObjectType>(Expression<Func<ObjectType, Boolean>>) Searches for the first object that matches the specified lambda expression. The generic parameter determines the object’s type.
GetAssociatedCollectionCriteria(Object, IMemberInfo) Specifies the criteria applied to a specific object’s associated collection property.
GetCollectionSorting(Object) Returns the sort settings for a particular collection.
GetCriteria(Object) Returns the criteria used to filter a particular collection on the server side.
GetDisplayableProperties(Object) Gets the properties considered visible by the specified collection.
GetEvaluatorContextDescriptor(Type) Creates an instance of the EvaluatorContextDescriptor that is used to supply metadata on the specified type to the ExpressionEvaluator objects.
GetExpressionEvaluator(EvaluatorContextDescriptor, CriteriaOperator) Creates an ExpressionEvaluator object that is used to evaluate whether objects of the specified type satisfy a particular criteria.
GetExpressionEvaluator(Type, CriteriaOperator) Creates an ExpressionEvaluator object that is used to evaluate whether objects of the specified type satisfy a particular criteria.
GetFilter(Object) Returns the criteria used to filter a particular collection on the client side.
GetKeyPropertyName(Type) Gets the name of the specified type’s key property.
GetKeyPropertyType(Type) Gets the key property type of objects of the specified type.
GetKeyValue(Object) Returns the key property’s value of the specified persistent object.
GetKeyValueAsString(Object) Returns the key property’s value of the specified object, converted to a string representation.
GetObject(Object) Retrieves an object that corresponds to an IObjectRecord wrapper or object from another Object Space.
GetObject<ObjectType>(ObjectType) Gets an object similar to the specified object from another Object Space, to the current Object Space. The returned object is cast by the type designated by the specified generic type parameter.
GetObjectByHandle(String) Returns the object with the specified handle.
GetObjectByKey(Type, Object) Returns the persistent object that has the specified value for its key property.
GetObjectByKey<ObjectType>(Object) Returns a persistent object of the type designated by the specified generic type parameter, with the specified value for its key property.
GetObjectHandle(Object) Returns an object’s handle.
GetObjectKey(Type, String) Converts the key property value string representation into its actual type.
GetObjects(Type, CriteriaOperator, Boolean) Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.
GetObjects(Type, CriteriaOperator, IList<SortProperty>, Boolean) Returns a sorted IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.
GetObjects(Type, CriteriaOperator) Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.
GetObjects(Type) Retrieves objects of the specified type from the current Object Space. Returns an IList collection.
GetObjects<T>() Retrieves objects of the specified type from the current Object Space. Returns an IList collection.
GetObjects<T>(CriteriaOperator, Boolean) Returns an IList collection of objects via the current Object Space.
GetObjects<T>(CriteriaOperator, IList<SortProperty>, Boolean) Returns a sorted IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.
GetObjects<T>(CriteriaOperator) Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.
GetObjectsCount(Type, CriteriaOperator) Returns the number of objects specified.
GetObjectsQuery<T>(Boolean) Gets a queryable data structure that provides functionality to evaluate queries against a specific business object type.
GetObjectsToDelete(Boolean) Returns a collection of persistent objects that will be deleted when the current transaction is committed, including objects that will be deleted in the parent transaction(s), optionally.
GetObjectsToSave(Boolean) Returns a collection of persistent objects that will be saved when the current transaction is committed, including objects that will be saved in the parent transaction(s), optionally.
GetObjectType(Object) Returns the type of the specified business object.
GetTopReturnedObjectsCount(Object) Returns the maximum number of objects to be retrieved by the specified collection from a data store.
IsCollectionLoaded(Object) Indicates whether a particular collection is loaded with objects from the database.
IsDeletedObject(Object) Indicates whether the specified persistent object is deleted and committed.
IsDeletionDeferredType(Type) Returns a value that indicates if the deferred deletion is enabled for persistent objects of a given type.
IsDisposedObject(Object) Determines whether an object has been disposed of.
IsKnownType(Type) Returns the boolean value indicating whether or not the specified type is known by the IObjectSpace.
IsNewObject(Object) Indicates whether a specified object has been created but has not been saved to the database.
IsObjectDeletionOnRemoveEnabled(Object) Indicates whether the deletion of persistent objects from the data source when they are removed from the specified collection is enabled.
IsObjectFitForCriteria(Object, CriteriaOperator) Specifies whether the specified object satisfies the specified criteria.
IsObjectFitForCriteria(Type, Object, CriteriaOperator) Specifies whether a particular object satisfies the specified criteria.
IsObjectToDelete(Object) Indicates whether the specified object has been deleted but not committed in the transaction currently in progress.
IsObjectToSave(Object) Indicates whether the specified object has been added, deleted or modified, but not committed in the transaction currently in progress.
ParseCriteria(String) Tries to convert the specified string representation of an expression to its CriteriaOperator equivalent.
Refresh() Updates the persistent objects belonging to the current Object Space.
ReloadCollection(Object) Clears the specified collection.
ReloadObject(Object) Updates the specified object with data from the data source.
RemoveFromModifiedObjects(Object) Removes the specified object from the list of objects to be committed.
Rollback(Boolean) Cancels the changes made to the persistent objects belonging to the current Object Space.
SetCollectionSorting(Object, IList<SortProperty>) Applies the specified sorting to a given collection.
SetDisplayableProperties(Object, String) Changes the properties considered visible by a particular collection.
SetModified(Object, IMemberInfo) Sets the state of the specified object to be Modified and adds the passed object to the track list to be committed.
SetModified(Object) Sets the state of the specified object to Modified and adds this object to the track list of changes that should be committed.
SetTopReturnedObjectsCount(Object, Int32) Returns the maximum number of objects to be retrieved by the specified collection from a data store.

Events

Name Description
Committed Occurs after persistent object changes are stored in the database.
Committing Occurs before persistent objects are saved to the database.
ConfirmationRequired Occurs when performing refresh or rollback operations with the current Object Space’s persistent objects.
Connected Occurs after a connection to a database has been established.
CustomCommitChanges Replaces the default commit logic with a custom one.
CustomDeleteObjects The IObjectSpace.Delete method raises the CustomDeleteObjects event. Handle this event to replace the default persistent object deletion logic with custom logic.
CustomRefresh Replace the default processes of refreshing persistent objects with a custom one.
CustomRollBack Replaces the default process of persistent objects rollback with a custom one.
Disposed Occurs after an Object Space has been disposed of.
ModifiedChanged Occurs when the current Object Space’s IObjectSpace.IsModified state is changed.
ObjectChanged Occurs when a persistent object is created, deleted or changed (when the objects’ INotifyPropertyChanged.PropertyChanged event occurs).
ObjectDeleted Occurs after the specified objects have been deleted from the dataset.
ObjectDeleting Occurs when the specified objects are about to be deleted.
ObjectEndEdit Occurs after ending an edit operation taking place on the specified object.
ObjectReloaded Occurs after an object is reloaded from the database.
ObjectSaved Occurs after saving changes made to a specified persistent object to the database.
ObjectSaving Occurs before saving changes made to a specified persistent object to the database.
Refreshing Occurs before refreshing the current Object Space’s persistent objects.
Reloaded Occurs after the current Object Space reconnects to the database.
RollingBack Occurs before rolling back the changes made to the current Object Space’s persistent objects.
See Also