SD.LLBLGen.Pro.ORMSupportClasses.NET20
Implementation of the ActionQuery class.
Abstract query class for the various query objects in the framework.
The interface for dynamic created queries.
Generic
Adds a new to the collection of . An output parameter can be
stored once in the collection.
The to add
Will walk all instances of this query and reflect the parameter values in the related fields.
Only output parameters are taken into account.
Wires the command of this query with the transaction passed in.
the transaction to wire the command with
Sets the command timeout.
Timeout interval, in seconds.
The connection object to use with the
The command used for this query.
The list of parameters used in the .
Array list with the instances for the relations between IEntityFields and output parameters.
CTor
Command to use
CTor
Connection object to use
Command to use
Will walk all instances of this query and reflect the parameter values in the related fields.
Only output parameters are taken into account. Used by Insert queries which retrieve Identity / sequence values back from the database
after a succesful insert.
Overloaded ToString implementation
Returns a complete textual representation of the command stored. The textual representation
will not include parameter values, but will list their names and types.
Adds a new to the collection of .
The to add
Wires the command of this query with the transaction passed in.
the transaction to wire the command with
Sets the command timeout.
Timeout interval, in seconds.
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources.
Performs the dispose action.
Flag which signals this routine if a dispose action should take place (true) or not (false)
The connection object to use with the
The command used for this query.
The list of parameters used in the .
List with the instances for the relations between entity fields and output parameters.
Interface for action queries. These queries do not return a resultset. Action queries execute Insert, Delete and Update statements.
Generic
Executes the query contained by the IQuery instance.
The number of rows affected (if applicable), otherwise 0.
When there is no command object inside the query object,
or no connection object inside the query object
when an exception was caught during query execution
Array list of ISequenceRetrievalQuery objects which are used to produce sequence values for input/output parameters in
this query. Normally this collection is empty, as it is only used when the target database provider doesn't support batched
queries (firebird/access/sqlce and others). Execute will wire the transaction if present.
Gets the parameter parameter relations for this IActionQuery. These definitions are used for insert queries in multi-target entity inserts.
CTor
Command to use
CTor
Connection object to use
Command to use
Produces a string representation of this query.
Executes the query contained by the IQuery instance. If there was nothing to execute, 0 is returned.
The number of rows affected (if applicable), otherwise 0.
When there is no command object inside the query object,
or no connection object inside the query object
when an exception was caught during query execution
Performs the dispose action.
Flag which signals this routine if a dispose action should take place (true) or not (false)
Syncs the parameter parameter relations.
Array list of ISequenceRetrievalQuery objects which are used to produce sequence values for input/output parameters in
this query. Normally this collection is empty, as it is only used when the target database provider doesn't support batched
queries (firebird/access/sqlce and others). Execute will wire the transaction if present.
Gets the parameter parameter relations for this IActionQuery. These definitions are used for insert queries in multi-target entity inserts.
Attribute to use on properties which return an entity collection in the Adapter template set.
This attribute will tell the property descriptor construction code to construct a list of
properties of the type set as the value of the attribute.
CTor
The type of the objects contained in the collection
returned by the property this attribute is applied to.
Gets typeContainedInCollection
Simple attribute which is used to mark a property in an entity collection that it has to be included in Compact XML. Compact XML is used
when the entity collection is send to/from a webservice.
Initializes a new instance of the class.
Action query which contains multiple action queries which have to be executed in the order in which they're stored.
Used for multi-target entities, like saving an inherited entity in a target-per-entity hierarchy.
Creates a new instance.
Adds the action query passed in.
Query.
Produces a string representation of this batch action query.
Executes all action queries in this batchactionquery, in the order in which they were added.
The number of rows affected (if applicable) of all queries executed combined, otherwise 0.
When there is no command object inside one or more query objects,
or no connection object inside the query object
when an exception was caught during query execution
Adds the parameter field relation.
Relation.
Reflects the output values in related fields for all actionqueries in this batchactionquery.
Wires the command of this query with the transaction passed in.
the transaction to wire the command with
Sets the command timeout.
Timeout interval, in seconds.
Performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources.
Performs the dispose action.
Flag which signals this routine if a dispose action should take place (true) or not (false)
Gets the actionQueries set in this batch action query object.
Gets the sequence retrieval queries. Not implemented in BatchActionQueries.
Gets or sets the connection for this action query object. Get will return the connection of the first action query stored.
Set will set the connection on all actionquery objects.
Gets or sets the command. Not implemented on Batch action query objects. Use the indexer instead.
Gets the parameters of all queries.
Gets the parameter field relations.
Gets or sets the ActionQuery at the specified index.
Gets the number of IActionQueries in this query.
Gets the parameter parameter relations for this IActionQuery. These definitions are used for insert queries in multi-target entity inserts.
Gets / sets quitOnPartlyFailure
Generic base class for the entity collection classes used by Selfservicing and adapter. This class is mainly written to
be able to tap into Add/Remove/Insert etc. without problems: the shipped collection classes in .NET don't have the ability to
override Add etc.
The type this collection is of (the type of the contained objects.)
empty ctor.
Deserialization CTor
ISerializable member.
Determines the index of a specific item in the .
The object to locate in the .
The index of item if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The zero-based index at which item should be inserted.
The object to insert into the .
The is read-only.
index is not a valid index in the .
item is null
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Adds an item to the .
The object to add to the .
The is read-only.
Adds the range of objects passed in.
Collection to add
Removes all items from the .
The is read-only.
Determines whether the contains a specific value.
The object to locate in the .
true if item is found in the ; otherwise, false.
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
arrayIndex is less than 0.
array is null.
array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source is greater than the available space from arrayIndex to the end of the destination array.-or-Type TEntity cannot be cast automatically to the type of the destination array.
Removes the first occurrence of a specific object from the .
The object to remove from the .
true if item was successfully removed from the ; otherwise, false.
This method also returns false if item is not found in the original .
The is read-only.
Applies sorting like IBindingList.ApplySort, on the field with the index fieldIndex and with the direction specified.
Field to sort on
the sort direction
For backwards compatibility.
Sorts the collection.
property to sort on
the sort direction
The comparer to use. If null, it will use the default comparer.
For backwards compatibility.
Gets all indices of all the entities in the current order of this collection which match the passed in filter.
The filter the entity has to match with. If null, all entities match and every index is returned
List of indices of all entities matching the filter
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
Adds an item to the .
The to add to the .
The position into which the new element was inserted.
The is read-only.-or- The has a fixed size.
Removes all items from the .
The is read-only.
Determines whether the contains a specific value.
The to locate in the .
true if the is found in the ; otherwise, false.
Determines the index of a specific item in the .
The to locate in the .
The index of value if found in the list; otherwise, -1.
Inserts an item to the at the specified index.
The zero-based index at which value should be inserted.
The to insert into the .
index is not a valid index in the .
The is read-only.-or- The has a fixed size.
value is null
Removes the first occurrence of a specific object from the .
The to remove from the .
The is read-only.-or- The has a fixed size.
Removes the item at the specified index.
The zero-based index of the item to remove.
The is read-only.
index is not a valid index in the .
Copies the elements of the to an , starting at a particular index.
The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing.
The zero-based index in array at which copying begins.
array is null.
index is less than zero.
array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source is greater than the available space from index to the end of the destination array.
The type of the source cannot be cast automatically to the type of the destination array.
Disposes this instance.
Inits the core class.
The capacity.
Inits the class.
The initial contents.
Called when [list changed].
The index.
The type of change.
Called at the start of a remove routine which removes an entity from this collection. Will raise EntityRemoving event.
The entity to remove.
true if the remove action can continue (e.g. the event wasn't canceled) otherwise false.
Called at the end of a remove routine which removes an entity from this collection. Will raise EntityRemoved event.
The entity to remove.
Called at the start of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdding event.
The entity to add.
true if the add action can continue (e.g. the event wasn't canceled) otherwise false.
Called at the end of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdded event.
The entity to add.
Event handler for the EntityContentsChanged event.
Called at the end of GetObjectData. Method is used when this object is serialized. Override this method to
tap into the serialization sequence. (binary/soap formatter specific).
The info.
The context.
Called at the end of the deserialization constructor. Method is used when this object is deserialized. Override this method to
tap into the deserialization sequence. (binary/soap formatter specific).
The info.
The context.
Removes the passed in entity from the collection without notifying the entity to remove that it has been removed from this collection.
To remove.
Sorts the collection.
descriptor for property to sort on
the sort direction
The comparer to use. If null, it will use the default comparer.
For backwards compatibility
Rebuilds the index which contains per objectid the index in this collection.
Will add a new entity to the list, will set its parent collection property so CancelEdit will remove
it from the list again, and will set its flag that it is added by databinding.
Do not call this method from your own code. This is a databinding ONLY method.
If this collection is set to ReadOnly
Sorts the collection.
Field to sort on
the sort direction
The comparer to use. If null, it will use the default comparer.
For backwards compatibility.
Performs the set related entity action on the passed in entity. This action is delegated to an inheritor.
The entity to perform the setrelated entity action on.
Performs the unset related entity action on the passed in entity. This action is delegated to an inheritor.
The entity to perform the unsetrelated entity action on.
Performs the add action to the active context for this collection
The entity.
Gets the entity description for the entity passed in.
The entity.
if true, the method will produce TEntity.GetEntityDescription, otherwise it's a no-op
Inits the core class.
Performs the add.
The item.
IComponent's Disposed event.
Event which is used in complex databinding.
Event which is raised at the start of the Remove or RemoveAt(index) routine. To cancel the remove action, set cancel to true.
Event which is raised at the End of the Remove or RemoveAt(index) routine.
Event which is raised at the start of the Add or Insert(index) routine. To cancel the addition action, set cancel to true.
Event which is raised at the End of the Add or Insert(index) routine.
Gets a value indicating whether the has a fixed size.
true if the has a fixed size; otherwise, false.
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
Gets or sets the at the specified index.
Gets the number of elements contained in the .
The number of elements contained in the .
Gets a value indicating whether access to the is synchronized (thread safe).
true if access to the is synchronized (thread safe); otherwise, false.
Gets an object that can be used to synchronize access to the .
An object that can be used to synchronize access to the .
Gets or sets the associated with the .
The object associated with the component; or null, if the component does not have a site.
Gets / sets the IConcurrencyPredicateFactory instance to use when creating entity objects during a GetMulti() call or when AddNew is called.
Gets the number of elements contained in the .
The number of elements contained in the .
Gets or sets the object at the specified index.
Gets a value indicating whether the is read-only.
true if the is read-only; otherwise, false.
When set to true, an entity passed to Add() or Insert() will be tested if it's already present. If so, the index is returned and the
object is not added again. If set to false (default: true) this check is not performed. Setting this property to true can slow down fetch logic.
DataAccessAdapter's fetch logic sets this property to false during a multi-entity fetch.
Default: true. If set to false, no new entities will be added through databinding.
Default: false. If set to true, entities can be removed through databinding.
Default: true. If set to false, entities inside this collection won't be editable in a complex databinding scenario.
Gets / sets the initial capacity of the entity collection.
Items contained by this collection. Returns simply this instance.
Returns a readonly collection of entities which are flagged as dirty.
This collection is determined on the fly, you can use this collection to remove dirty entities from this entity collection.
Gets or sets a value indicating whether [deserialization in progress].
true if [deserialization in progress]; otherwise, false.
Gets or sets a value indicating whether [surpress list changed events].
true if [surpress list changed events]; otherwise, false.
Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net
Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net
ComPlusAdapterContextBase class. Abstract class which is the base for the ComPlusAdapterContext classes used
in Adapter for hosting a COM+ aware DataAccessAdapter class.
Use the hosted DataAccessAdapter class to start a new COM+ transaction.
Interface for the COM+ context class which controls the COM+ transaction flow towards the database server, if applicable.
It contains a normal DataAccessAdapter class to do the work, and the IComPlusAdapterContext implementing class is consulted
by the DataAccessAdapter class in cases of transaction control and database connection creation.
Returns the DataAccessAdapter object related to this COM+ context. Use this adapter instance to perform persistence actions
inside the COM+ transaction this IComPlusAdapterContext implementing object is participating in.
CTor
Creates a new connection object using the connection string passed in.
Signals to commit the current transaction.
Signals to rollback the current transaction.
Creates the physical connection object
connection string to use
Usable connection object (closed)
Sets the adapter to host in this context. Adapter is already aware of this context.
Com+ context aware adapter instance
Returns the DataAccessAdapter object related to this COM+ context. Use this adapter instance to perform persistence actions
inside the COM+ transaction this IComPlusAdapterContext implementing object is participating in.
Enum definition for LLBLGenProDataSource(2) controls to signal what sorting mode they have to use for selects.
Use server-side sorting, which will use solely entity fields (default)
Use client-side sorting, which will use all properties specified, also non-field properties.
Enum to define the data cache to use for the LLBLGen Pro DataSource controls in an ASP.NET application
Data is stored in the viewstate. Default.
Data is stored in the Session object using a GUID as key.
Enum which specifies the type of object which contains the data in an LLBLGenProDataSource(2) control in an ASP.NET application
The object containing the data is an entity collection (selfservicing style or adapter style).
The object containing the data is a typed list
The object containing the data is a typed view.
Enum for compatibility level in the SqlServer DQE
Produce SQL which is compatible with SqlServer 7 and up
Produce SQL which is compatible with SqlServer 2000 and up (default)
Produce SQL which is compatible with SqlServer 2005 and up
Enum to specify what to do when the data in the related collection of an entity view changes. A change in data can be: entity added or changed.
If an entity is removed from the underlying collection, the entity is simply removed from the entity view, as the view doesn't contain any data by itself.
A set filter or sorter isn't re-applied to the changed entity/ies, so the change won't affect the order of the entities in the view nor which rows are in
the view.
The set filter and the set sorter are re-applied to the entity which caused the change. This is the default and will make the entity view
a true 'live' view on the related entity collection
The set sorter is re-applied to the entities in the view.
Enum to specify to the IConcurrencyPredicateFactory what kind of predicate to produce
The predicate type requested is for a Save action
The predicate type requested is for a Delete action
Enum definition for defining the hierarchy type of the inheritance tree
No hierarchy defined for this entity or the entity isn't the root entity.
All entities map to the single target (table/view)
Per entity a target (table/view) is defined, with just the fields of the derived entity, not the fields of the parent entity.
Enum definition to tell the UnitOfWork that the passed in callback should be executed in the slot specified.
Entities are executed in the order: Insert, Update, Delete.
Execute the callback before the first entity is inserted.
Execute the callback after the last entity has been inserted but before the first entity will be updated.
Execute the callback after the last entity has been updated but before the first entity will be deleted.
Execute the callback after the last entity has been deleted.
Enum definition for the flags which can be passed to overloads of WriteXml(). These flags control the way the format of the output.
No aspects have been specified, the defaults are used.
Produces compact XML. This xml doesn't contain type information attributes, nor non-data fields for objects. The default is verbose.
Places all strings with a < and or > in CDATA blocks. The default is not to do this.
Exports all DateTime values in the standard date/time format for XML: DateTime.ToString("yyyy-MM-ddTHH:mm:ss.fffffffzzzzzz");. The default is
to export DateTime values in ticks.
SqlServer specific enum definition for Adapter template set. Specifies for the active DataAccessAdapter object what
to do with the catalog name in persistence information set into fields.
Use default behaviour, which means that nothing is done to the catalog name specified in the persistence info.
Force the name specified in the property DataAccessAdapter.CatalogNameToUse.
Clears the catalog name specified in the persistence information. This means that the catalog name specified in the
connection string is used by SqlServer where to locate specified tables etc.. Clearing of the catalog name makes the
SqlServer DQE ignore the catalog name when generating names.
Oracle specific enum definition for Adapter template set. Specifies for the active DataAccessAdapter object what
to do with the schema name in persistence information set into fields.
Use default behaviour, which means that nothing is done to the schema name specified in the persistence info.
Force the name specified in the property DataAccessAdapter.SchemaNameToUse.
Clears the Schema name specified in the persistence information. This means that the schema name specified in the
persistence info is cleared. This results in the fact that database objects are not prefixed with a schema, and
will only result in a succesful query if global synonym equivalents are available.
Enum definition for the hint specified in the Add method of RelationCollection.
No hint specified. Use INNER unless ObeyWeakRelations is set to true.
Inner join between start and end entity of given relation
Overrules the set ObeyWeakRelations flag for this relation.
Hints a LEFT join between start and end entity in relation.
Overrules the set ObeyWeakRelations flag for this relation.
Hints a RIGHT join between start and end entity in relation.
Overrules the set ObeyWeakRelations flag for this relation.
Hints a CROSS join between start and end entity in relation.
Overrules the set ObeyWeakRelations flag for this relation.
Enum definition for the type of a PredicateExpressionElement
Element contains an Operator
Element contains an IPredicate implementing object.
The element is empty.
Enum definition for the type of a predicate instance.
This enum is stored in Predicate as an int and is used in DataAccessAdapterBase derived classes.
Undefined type.
A FieldBetweenPredicate instance
A FieldCompareNullPredicate instance
A FieldCompareValuePredicate instance
A FieldLikePredicate instance
A predicate expression object containing 0 or more predicate elements.
A FieldCompareRangePredicate instance.
A FieldFullTextSearchPredicate (SqlServer 2000 specific). Future enhancement.
A FieldCompareExpression predicate.
A FieldCompareSet predicate
Enum definition for the type of relation an EntityRelation object represents.
There is no definition for m:n relation because EntityRelation can't represent a m:n relation
A 1:n relation
A 1:1 relation
A m:1 relation
A m:n relation
Enum definition for the operator used in the FieldCompareValue Predicate.
== . The only operator useful for boolean (bit) Fields.
<=
<
>=
>
<> or !=
Enum definition for the operators used with the FieldCompareSetPredicate class.
IN (set) operator.
On MySql, don't use In with Negate set to true, as that will lead to unexpected results due to MySql not being correct in this. Use NotEqualAll instead
EXISTS(set) operator.
== (set with 1 value) operator
== ANY (set) operator
== ALL (set) operator
<= (set with 1 value) operator
<= ANY (set) operator
<= ALL (set) operator
< (set with 1 value) operator
< ANY (set) operator
< ALL (set) operator
>= (set with 1 value) operator
>= ANY (set) operator
>= ALL (set) operator
> (set with 1 value) operator
> ANY (set) operator
> ALL (set) operator
<> (set with 1 value) operator
<> ANY (set) operator
<> ALL (set) operator
Enum definition for the Operators used in PredicateExpressions
The AND operator.
The OR operator.
Enum definition for the sort operator, which can be specified with IEntityField instances to create
order by clauses.
Makes sorts Ascending
Makes sorts Descending
Enum definition for the state an Entity can be in.
Entity is new. It can be empty or filled, but is not saved (yet) to the persistent storage.
Entity is filled with its data from the persistent storage. It can be changed since the fetch.
Entity is out of sync with its physical entity in the persistent storage.
An Entity is marked OutOfSync when a succesful Save action is performed.
An Entity will re-fetch itself when in the state OutOfSync when a property
is read or Refetch() is called. The state will then be set to Fetched.
Adapter specific. If an entity has the state Deleted, it is no longer
available in the persistent storage.
Enum definition for the various aggregate functions which can be applied to fields in a retrieval query.
Useful in typed lists. Use these in combination with a groupbycollection.
Not all functions are legal on all fields. Some functions will produce errors when used with fields of a given type,
like a Sum function with a character field. This is the responsibility of the developer. Aggregate functions are
never applied to *lob fields.
Default, do not apply an aggregate function to the field.
Calculates the amount of rows for the field. Results in COUNT(field)
Calculates the amount of rows with distinct values for field. Results in COUNT(DISTINCT field).
Access, MySql: not supported
Calculates the amount of rows. Results in a COUNT(*)
Calculates the average value for the field. Results in an AVG(field)
works on numeric fields (decimal/int/float/byte/etc.) only
Calculates the average value for the distinct values for field. Results in an AVG(DISTINCT field).
Access, MySql: not supported
works on numeric fields (decimal/int/float/byte/etc.) only
Calculates the max value for field. Results in a MAX(field).
works on numeric fields (decimal/int/float/byte/etc.) only
Calculates the min value for field. Results in a MIN(field)
works on numeric fields (decimal/int/float/byte/etc.) only
Calculates the sum of all values of field. Results in a SUM(field)
works on numeric fields (decimal/int/float/byte/etc.) only
Calculates the sum of all distinct values of field. Results in a SUM(DISTINCT field).
Access, MySql: not supported
works on numeric fields (decimal/int/float/byte/etc.) only
Calculates statistical standard deviation. Results in:
SqlServer: STDEV(field)
Oracle, MySql: STDDEV(field)
Access: STDEV(field)
Firebird: not supported
Works on float fields only
Calculates statistical standard deviation over distinct values. Results in:
SqlServer: not supported
Oracle: STDDEV(DISTINCT field)
Access, Firebird, MySql: not supported
Works on float fields only
Calculates statistical variance. Results in:
SqlServer: VAR(field)
Oracle, MySql: VARIANCE(field)
Access: VAR(field)
Firebird: not supported.
Works on float fields only
Calculates statistical variance over distinct values. Results in:
SqlServer: not supported
Oracle: VARIANCE(DISTINCT field)
Access, Firebird, MySql: not supported
Works on float fields only
Enum for defining the type of the expression element in an expression object
The element contains a value
The element contains a field
The element contains an expression
The element contains a function call.
The element contains a Scalar query
Enum definition for the ExpressionOperators (ExOp). Name is shortened to limit typing.
None specified.
Add arithmetic operator
Sub(tract) arithmetic operator
Mul(tiply) arithmetic operator
Div(ision) arithmetic operator
Mod(ulo) arithmetic operator
Equal (==) logical operator
GreaterEqual (>=) logical operator
Greater (>) logical operator
LessEqual (<=) logical operator
Lesser (<) logical operator
Not Equal (!=) logical operator
And logical operator
Or logical operator
Bitwise and (&) operator
Bitwise or (|) operator
Bitwise exclusive or (Xor) (^) operator
Operator to use with FieldFullTextSearchPredicate.
SqlServer specific.
Produces a CONTAINS() statement
Produces a FREETEXT() statement
Enum definition for RDBMS hints, like table lock hints and other hints.
Hint for statements to apply to a table specification in a FROM clause. For example, in Sqlserver, if the setting is switched on, this hint
will produce (NOLOCK) as a hint to use.
Enum to define the types of parameters in a dbfunction call. Used internally to quickly call the right routine for parameter to text conversion
Parameter is a field
Parameter is a value.
Parameter is an expression.
Constant holder for the version of this library. Because the library is signed, it has a general version, like 1.0.2003.2, but
it also has an internal version, stored in this struct, which reflects the build date. Versions are always equal for the DQE's and the ORM
support classes.
Version reflects the general version of this library, for example 1.0.2003.2
Contains the build number of this version, which is build up like this: MMDDYYYY
General Context class which provides uniquing support for the object fetcher. A developer
can use this class to create a space for objects where every entity is loaded just once.
Creates a new instance.
Creates a new instance.
Flag to set existing entity fields in get. Default is true. When set to false, an existing
entity's fields is not set to the fields of the passed in entity. Fields are only set if the entity isn't dirty.
Clears this context. It removes all cached entity references from this context and also all type definitions.
Adds the specified entity to the Context. If the passed in entity is already in a context, the Add is a no-op.
Also if the entity isn't new and there is already an entity with the same PK values, the Add is a no-op.
entity to add to this context.
Adds the specified entity to the Context. If the passed in entity is already in a context, the Add is a no-op.
Also if the entity isn't new and there is already an entity with the same PK values, the Add is a no-op.
entity to add to this context.
Adds the specified collection to this context. All contained entities are added to the context as well, if they're not already in the / a context.
This will make sure that any entity added to the entity collection will be added to this context as well.
To add.
SelfServicing specific version
Adds the specified collection to this context. All contained entities are added to the context as well, if they're not already in the / a context.
This will make sure that any entity added to the entity collection will be added to this context as well.
To add.
Adapter specific version
After an entity has been saved and the transaction has been committed (or if no transaction was used: the entity was saved), this routine is called
to move entities which are in the list of new entities and which are now saved to the store.
Entity.
Routine for the framework, you don't have to call this routine yourself
Returns a readonly arraylist with all the objects of the type passed in which are currently stored in the internal object cache.
No new entities are returned. If the type is not found, an empty array list is returned.
The type of the entity for which the objects should be returned.
List with the requested data
Gets all the Type objects for which objects are located in this Context
List with the requested data
The passed in entity is checked if the contained data is already in this / a context in another entity object.
If that's the case, that entity object is returned. If the data is not in this context in another entity object,
the passed in entity is returned and added to this context.
entity to check
an already loaded entity with the same data, or the passed in entity if the data hasn't been loaded in another entity in this context
or the entity passed in is new or the existing entity is deleted and its transaction has been completed.
if toCheck is new, it is added to the new entities pool (if not already present) and its context is set to this instance.
New entities aren't yet added to the context until they're saved. A new entity passed in is returned as well.
SelfServicing specific version.
The passed in entity is checked if the contained data is already in this / a context in another entity object.
entity to check
an already loaded entity with the same data, or the passed in entity if the data hasn't been loaded in another entity in this context
or the entity passed in is new or the existing entity is deleted and its transaction has been completed.
if toCheck is new, it is added to the new entities pool (if not already present) and its context is set to this instance.
New entities aren't yet added to the context until they're saved. A new entity passed in is returned as well.
Adapter specific version
Tries to find an entity with the same PK values as passed in. The PK values have to be in the same order as they appear in the constructor of the
entity. If an entity in the context has the same PK values, that entity is returned, otherwise a new entity is returned, created with the
factory passed in, with its PK values initialized, though not fetched.
Factory to use for entity to find
Pk values. Have to be specified in the same order as the PK fields in the entity constructor created by the factory passed in.
Entity with the same PK values if that entity was already added to the context, or a new entity if no entity was previously added to
this context with the same PK values
if more/less pkvalues are passed in as there are in the PK of the entity created with the factory passed in
SelfServicing specific version
Tries to find an entity with the same PK values as passed in. The PK values have to be in the same order as they appear in the constructor of the
entity. If an entity in the context has the same PK values, that entity is returned, otherwise a new entity is returned, created with the
factory passed in, with its PK values initialized, though not fetched.
Factory to use for entity to find
Pk values. Have to be specified in the same order as the PK fields in the entity constructor created by the factory passed in.
Entity with the same PK values if that entity was already added to the context, or a new entity if no entity was previously added to
this context with the same PK values
if more/less pkvalues are passed in as there are in the PK of the entity created with the factory passed in
Adapter specific version
Removes the specified entity from the store
To remove.
generic version for both SelfServicing and Adapter.
Tries to find the passed in entity in the store, based on its contained data. It assumes the passed in entity isn't new.
Entity object which contains entity data to
Adds the entity passed in. The entity passed in is not new and the object isn't in the store as it isn't in a context yet.
It assumes that there is no entity with the same PK in the store, as that's checked by the public Add() methods.
entity to add
Inits the class.
Adds the specified entity to the Context. If the passed in entity is already in a context, the Add is a no-op.
Also if the entity isn't new and there is already an entity with the same PK values, the Add is a no-op.
entity to add to this context.
Gets / sets SetExistingEntityFieldsInGet flag. When set to false (default is true), an existing
entity's fields is not set to the fields of the passed in entity. Fields are only set if the entity isn't dirty.
Base class for DAO classes which are generated.
Interface for Data Access Objects (DAO). Every IEntity implementation has one specific Dao object
SelfServicing specific.
Adds the given fields to the database as a new entity.
The EntityField data to use for the insert.
A containing transaction, if caller is added to a transaction, or null if not.
true if the addition was succesful, false otherwise
When fields is null
Updates an existing entity using the given fields.
The EntityField data to use for the update
A containing transaction, if caller is added to a transaction, or null if not.
true if the update was succesful, false otherwise
When fields is null
Updates an existing entity using the given fields.
The EntityField data to use for the update
A containing transaction, if caller is added to a transaction, or null if not.
Predicate expression, meant for concurrency checks in an Update query
true if the update was succesful, false otherwise
When fields is null
Reads the data of the entity passed in, and returns that object. Which data is read is determined using
the set Primary Key field(s). If specified, it also processes the prefetch path.
The entity to fetch. Contained data will be overwritten.
A containing transaction, if caller is added to a transaction, or null if not.
Select filter.
the PrefetchPath which defines the graph of objects to fetch.
The context to fetch the prefetch path with.
Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to
construct the total query.
A containing transaction, if caller is added to a transaction, or null if not.
Collection to fill with the entity objects retrieved
The maximum number of items to return with this retrieval query.
If the used Dynamic Query Engine supports it, 'TOP' is used to limit the amount of rows to return.
When set to 0, no limitations are specified.
The order by specifications for the sorting of the resultset. When not specified, no sorting is applied.
The EntityFactory to use when creating entity objects during a GetMulti() call.
A predicate or predicate expression which should be used as filter for the entities to retrieve.
The set of relations to walk to construct to total query.
The page number to retrieve.
The page size of the page to retrieve.
true if succeeded, false otherwise
Retrieves in the calling Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to
construct the total query.
A containing transaction, if caller is added to a transaction, or null if not.
Collection to fill with the entity objects retrieved
The maximum number of items to return with this retrieval query.
If the used Dynamic Query Engine supports it, 'TOP' is used to limit the amount of rows to return.
When set to 0, no limitations are specified.
The order by specifications for the sorting of the resultset. When not specified, no sorting is applied.
The EntityFactory to use when creating entity objects during a GetMulti() call.
A predicate or predicate expression which should be used as filter for the entities to retrieve.
The set of relations to walk to construct to total query.
the PrefetchPath which defines the graph of objects to fetch.
The page number to retrieve.
The page size of the page to retrieve.
true if succeeded, false otherwise
Retrieves in the calling entity collection object all entity objects
which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to
construct the total query. It will also prefetch all related objects defined in the prefetchpath specified.
A containing transaction, if caller is added to a transaction, or null if not.
Collection to fill with the entity objects retrieved
The maximum number of items to return with this retrieval query.
If the used Dynamic Query Engine supports it, 'TOP' is used to limit the amount of rows to return.
When set to 0, no limitations are specified.
The order by specifications for the sorting of the resultset. When not specified, no sorting is applied.
The EntityFactory to use when creating entity objects during a GetMulti() call.
A predicate or predicate expression which should be used as filter for the entities to retrieve.
The set of relations to walk to construct to total query.
the PrefetchPath which defines the graph of objects to fetch.
true if succeeded, false otherwise
Deletes from the persistent storage all entities which match with the specified filter, formulated in
the predicate or predicate expression definition, of the type and subtypes of the entity owning this DAO.
A containing transaction, if caller is added to a transaction, or null if not.
A predicate or predicate expression which should be used as filter for the entities to delete.
Number of entities affected, if the used persistent storage has rowcounting enabled.
Not supported for deleting entities which are part of a TargetPerEntity hierarchy
Deletes from the persistent storage all 'Employee' entities which match with the specified filter, formulated in
the predicate or predicate expression definition.
A containing transaction, if caller is added to a transaction, or null if not.
A predicate or predicate expression which should be used as filter for the entities to delete.
The set of relations to walk to construct the total query.
Number of entities affected, if the used persistent storage has rowcounting enabled.
Not supported for deleting entities which are part of a TargetPerEntity hierarchy
Updates all entities of the same type or subtype of the entity entityWithNewValues directly in the persistent storage if they match the filter
supplied in filterBucket. Only the fields changed in entityWithNewValues are updated for these fields. Entities of a subtype of the type
of entityWithNewValues which are affected by the filterBucket's filter will thus also be updated.
IEntity instance which holds the new values for the matching entities to update. Only
changed fields are taken into account
A containing transaction, if caller is added to a transaction, or null if not.
A predicate or predicate expression which should be used as filter for the entities to update.
Number of entities affected, if the used persistent storage has rowcounting enabled. Use the returned value to determine if the
update succeeded (value > 0)
Updates all entities of the same type or subtype of the entity entityWithNewValues directly in the persistent storage if they match the filter
supplied in filterBucket. Only the fields changed in entityWithNewValues are updated for these fields. Entities of a subtype of the type
of entityWithNewValues which are affected by the filterBucket's filter will thus also be updated.
IEntity instance which holds the new values for the matching entities to update. Only
changed fields are taken into account
A containing transaction, if caller is added to a transaction, or null if not.
A predicate or predicate expression which should be used as filter for the entities to update.
Set of relations to walk to construct the total query
Number of entities affected, if the used persistent storage has rowcounting enabled. Use the returned value to determine if the
update succeeded (value > 0)
Executes the expression defined with the field in the fields collection specified, using the various elements defined. The expression is executed as a
scalar query and a single value is returned.
IEntityFields instance with a single field with an expression defined and eventually aggregates
A containing transaction, if caller is added to a transaction, or null if not.
filter to use
The relations to walk
The list of fields to group by on. When not specified or an empty collection is specified, no group by clause
is added to the query. A check is performed for each field in the selectList. If a field in the selectList is not present in the groupByClause
collection, an exception is thrown.
the value which is the result of the expression defined on the specified field
Executes the expression defined with the field in the fields collection specified, using the various elements defined. The expression is executed as a
scalar query and a single value is returned.
IEntityFields instance with a single field with an expression defined and eventually aggregates
A containing transaction, if caller is added to a transaction, or null if not.
filter to use
The relations to walk
The list of fields to group by on. When not specified or an empty collection is specified, no group by clause
is added to the query. A check is performed for each field in the selectList. If a field in the selectList is not present in the groupByClause
collection, an exception is thrown.
Allow duplicates in the resultset.
the value which is the result of the expression defined on the specified field
Gets the number of rows returned by a query for the fields specified, using the filter and groupby clause specified.
IEntityFields instance with a single field with an expression defined and eventually aggregates
A containing transaction, if caller is added to a transaction, or null if not.
filter to use
The relations to walk
The list of fields to group by on. When not specified or an empty collection is specified, no group by clause
is added to the query. A check is performed for each field in the selectList. If a field in the selectList is not present in the groupByClause
collection, an exception is thrown.
the number of rows in the set defined by the query elements passed in