Skip to main content
.NET 6.0+

BaseObjectSpace Members

A base class for the classes that implement the IObjectSpace interface.

Constructors

Name Description
BaseObjectSpace(ITypesInfo, IEntityStore) Creates a new instance of the BaseObjectSpace class.

Fields

Name Description
CompositeKeyPropertyType static For internal use.
ThrowExceptionForNotRegisteredEntityType static Certain Object Space methods have the Type parameters. This static field indicates whether these methods throw the ArgumentException when a passed type is not registered in the Object Space Provider’s entity store. Set this field to true to diagnose issues related to the incorrect use of the Object Space type (for example, when a persistent Object Space is used to manipulate non-persistent objects).

Properties

Name Description
CanFilterByNonPersistentMembers For internal use.
Connection Gets the connection to the underlying data source.
Database Gets the name of the database.
IsCommitting Indicates whether the Object Space is currently committing the changes made to its object(s).
IsConnected Indicates whether the BaseObjectSpace 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.
LockingCheckEnabled Specifies whether or not the additional locking check is performed.
ModifiedObjects Returns a collection of objects that have been created, modified or deleted in the current object context.
NonPersistentChangesEnabled Specifies whether the BaseObjectSpace is marked as modified (see BaseObjectSpace.IsModified) when a non-persistent property is changed.
Owner Specifies the current Object Space’s root View or the root Object Space if the current Object Space is added to the AdditionalObjectSpaces collection.
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 a particular collection 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.
CompleteAllTasksAsync() For internal use.
Contains(Object) Indicates whether a specified object belongs to the current Object Space.
ConvertExpressionsStringToExpressionsList(String) static Returns the list of DataViewExpression objects converted from the passed semicolon-separated expressions list.
ConvertSortingToString(IList<SortProperty>) static Returns the string representation of a given sort list.
ConvertStringToSorting(String) static Converts the sorting string into the sorting list.
CreateByKeyCriteria(ITypeInfo, Object) static For internal use.
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 the 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 persistent objects.
CreateServerCollection(Type, CriteriaOperator) Creates and initializes a new instance of the EFServerCollection or XPServerCollectionSource class with criteria-specific options.
Delete(IList) Marks the specified persistent objects and their aggregated objects as deleted from the database.
Delete(Object) Marks the specified persistent object and its aggregated objects as deleted from persistent storage.
Dispose() Releases all resources used by an BaseObjectSpace object.
EnableObjectDeletionOnRemove(Object, Boolean) Enables/disables the deletion of persistent objects from the data source when they are removed from the specified collection.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Evaluate(Type, CriteriaOperator, CriteriaOperator) Evaluates the specified criteria for business objects of the given type.
FindObject(Type, CriteriaOperator, Boolean) Searches for the first object of the specified type, matching the specified criteria.
FindObject(Type, CriteriaOperator) Searches for the first object of the specified type, matching the specified criteria.
FindObject<ObjectType>(CriteriaOperator, Boolean) Searches for the first object of the type designated by the specified generic type parameter, matching the specified criteria.
FindObject<ObjectType>(CriteriaOperator) Searches for the first object of the type designated by the specified generic type parameter, matching the specified criteria.
FindObjectSpaceByObject(Object) static Returns the Object Space used to load and save a specified persistent object. This method is for internal use.
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) Returns the criteria applied to a specific object’s associated collection property.
GetCollectionObjectType(Object)
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.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetIntermediateObjectReferences(Object, out Object, out Object) For internal use.
GetKeyPropertyName(Type) Gets the name of the specified type’s key property.
GetKeyPropertyType(Type) Gets the key property type of the specified business type.
GetKeyValue(ITypesInfo, Object) static Returns the key property’s value of the specified persistent object.
GetKeyValue(Object) Returns the key property’s value of the specified object.
GetKeyValueAsString(ITypesInfo, Object) static
GetKeyValueAsString(Object) Returns the key property’s value of the specified object, converted to a string representation.
GetListServer(Object) For internal use.
GetObject(Object) Retrieves an object that corresponds to an IObjectRecord wrapper or object from another Object Space.
GetObject<ObjectType>(ObjectType) Retrieves an 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) Returns an IList collection of objects of the specified type, retrieved to the current Object Space.
GetObjects<T>() Returns an IList collection of objects of the specified type, retrieved to the current Object Space.
GetObjects<T>(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<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.
GetObjectsCriteria(ITypeInfo, IList) Constructs a criteria that can be used to select the specified list of business objects.
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.
GetType() Gets the Type of the current instance. Inherited from Object.
IsCollectionLoaded(Object) Indicates whether a particular collection is loaded with objects from the database.
IsDeletedObject(Object) Indicates whether the specified persistent object is deleted from the database.
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.
IsIntermediateObject(Object) For internal use.
IsKnownType(Type) Returns the boolean value indicating whether or not the specified type is known by the BaseObjectSpace.
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 current object context or the transaction currently in progress.
IsObjectToSave(Object) Indicates whether the specified object has been added, deleted or modified, but not committed in the current object context or the transaction currently in progress.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ObjectKeyValuesEqual(ITypeInfo, Object, Object) static
ParseCriteria(String) Tries to convert the specified string representation of an expression to its CriteriaOperator equivalent.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Refresh() Updates the persistent objects belonging to the current Object Space.
ReloadCollection(Object) Clears the specified collection.
ReloadObject(Object) Updates the specified object in the current Object Space with data from the data source.
RemoveFromModifiedObjects(Object) Removes the specified object from the object context or 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.
SetModified(Object) Sets the state of the specified object to be Modified.
SetPrefetchPropertyNames(Object, String[]) Loads specified delayed properties and child collections in each object of a given list.
SetTopReturnedObjectsCount(Object, Int32) Sets the maximum number of objects that can be retrieved from the specified collection in a data store.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
Committed Raised after saving changes made to persistent objects belonging to the current Object Space to the database.
Committing Occurs before saving the persistent objects belonging to the current Object Space 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 process for committing changes made to persistent objects with a custom one.
CustomDeleteObjects Occurs to replace the default process of deleting persistent objects with a custom one.
CustomRefresh Occurs to replace the default process of refreshing persistent objects with a custom one.
CustomRollBack Occurs to replace the default process of persistent objects rollback with a custom one.
Disposed Occurs before an Object Space is disposed of.
ModifiedChanged Occurs when the current Object Space’s BaseObjectSpace.IsModified state is changed.
ModifiedChanging Occurs before the IsModified property is changed to true. Handle this event to cancel the property change or force the IsModified property to change.
ObjectChanged Raised when a persistent object is created, changed or deleted.
ObjectDeleted Occurs after the specified objects have been deleted.
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 has been reloaded from the database.
ObjectSaved Occurs after saving changes made to a specified persistent object to the database.
ObjectSaving Raised 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 when the BaseObjectSpace.Rollback or BaseObjectSpace.Refresh method is called.
RollingBack Occurs before rolling back the changes made to the current Object Space’s persistent objects.
See Also