Csla.IDataPortal< T > Interface Template Reference

Interface defining the members of the data portal type. More...

Inheritance diagram for Csla.IDataPortal< T >:

Public Member Functions
Task< T >	CreateAsync (params object?[]? criteria)
	Starts an asynchronous data portal operation to create a business object.
Task< T >	FetchAsync (params object?[]? criteria)
	Starts an asynchronous data portal operation to create a business object.
Task< T >	UpdateAsync (T obj)
	Called by a factory method in a business class or by the UI to update an object.
Task< T >	ExecuteAsync (T command)
	Called by a factory method in a business class or by the UI to execute a command object.
Task< T >	ExecuteAsync (params object?[]? criteria)
	Execute a command on the logical server.
Task	DeleteAsync (params object?[]? criteria)
	Called by a factory method in a business class or by the UI to delete an object.
T	Create (params object?[]? criteria)
	Called by a factory method in a business class to create a new object, which is loaded with default values from the database.
T	Fetch (params object?[]? criteria)
	Called by a factory method in a business class to retrieve an object, which is loaded with values from the database.
T	Execute (T obj)
	Called to execute a Command object on the server.
T	Execute (params object?[]? criteria)
	Execute a command on the logical server.
T	Update (T obj)
	Called by the business object's Save() method to insert, update or delete an object in the database.
void	Delete (params object?[]? criteria)
	Called by a Shared (static in C#) method in the business class to cause immediate deletion of a specific object from the database.

Detailed Description

Interface defining the members of the data portal type.

Template Parameters

T

Type Constraints

T

:

ICslaObject

Member Function Documentation

Create()

T Csla.IDataPortal< T >.Create

(

params object??[]

criteria

)

Called by a factory method in a business class to create a new object, which is loaded with default values from the database.

Parameters

criteria

Object-specific criteria.

Returns

A new object, populated with default values.

Implemented in Csla.DataPortal< T >.

CreateAsync()

Task< T > Csla.IDataPortal< T >.CreateAsync

(

params object??[]

criteria

)

Starts an asynchronous data portal operation to create a business object.

Parameters

criteria

Criteria describing the object to create.

Implemented in Csla.DataPortal< T >.

Delete()

void Csla.IDataPortal< T >.Delete

(

params object??[]

criteria

)

Called by a Shared (static in C#) method in the business class to cause immediate deletion of a specific object from the database.

Parameters

criteria

Object-specific criteria.

Implemented in Csla.DataPortal< T >.

DeleteAsync()

Task Csla.IDataPortal< T >.DeleteAsync

(

params object??[]

criteria

)

Called by a factory method in a business class or by the UI to delete an object.

Parameters

criteria

Object-specific criteria.

Implemented in Csla.DataPortal< T >.

Execute() [1/2]

T Csla.IDataPortal< T >.Execute

(

params object??[]

criteria

)

Execute a command on the logical server.

Parameters

criteria

Criteria provided to the command object.

Returns

The resulting command object.

Implemented in Csla.DataPortal< T >.

Execute() [2/2]

T Csla.IDataPortal< T >.Execute

(

T

obj

)

Called to execute a Command object on the server.

To be a Command object, the object must inherit from CommandBase.

Note that this method returns a reference to the updated business object. If the server-side DataPortal is running remotely, this will be a new and different object from the original, and all object references MUST be updated to use this new object.

On the server, the Command object's DataPortal_Execute() method will be invoked and on an ObjectFactory the Execute method will be invoked. Write any server-side code in that method.

Parameters

obj	A reference to the Command object to be executed.

Returns

A reference to the updated Command object.

Exceptions

ArgumentNullException

obj is null.

Implemented in Csla.DataPortal< T >.

ExecuteAsync() [1/2]

Task< T > Csla.IDataPortal< T >.ExecuteAsync

(

params object??[]

criteria

)

Execute a command on the logical server.

Parameters

criteria

Criteria provided to the command object.

Returns

The resulting command object.

Implemented in Csla.DataPortal< T >.

ExecuteAsync() [2/2]

Task< T > Csla.IDataPortal< T >.ExecuteAsync

(

T

command

)

Called by a factory method in a business class or by the UI to execute a command object.

Parameters

command

Command object to execute.

Exceptions

ArgumentNullException

command is null.

Implemented in Csla.DataPortal< T >.

Fetch()

T Csla.IDataPortal< T >.Fetch

(

params object??[]

criteria

)

Called by a factory method in a business class to retrieve an object, which is loaded with values from the database.

Parameters

criteria

Object-specific criteria.

Returns

An object populated with values from the database.

Implemented in Csla.DataPortal< T >.

FetchAsync()

Task< T > Csla.IDataPortal< T >.FetchAsync

(

params object??[]

criteria

)

Starts an asynchronous data portal operation to create a business object.

Parameters

criteria

Criteria describing the object to create.

Implemented in Csla.DataPortal< T >.

Update()

T Csla.IDataPortal< T >.Update

(

T

obj

)

Called by the business object's Save() method to insert, update or delete an object in the database.

Note that this method returns a reference to the updated business object. If the server-side DataPortal is running remotely, this will be a new and different object from the original, and all object references MUST be updated to use this new object.

Parameters

obj	A reference to the business object to be updated.

Returns

A reference to the updated business object.

Exceptions

ArgumentNullException

obj is null.

Implemented in Csla.DataPortal< T >.

UpdateAsync()

Task< T > Csla.IDataPortal< T >.UpdateAsync

(

T

obj

)

Called by a factory method in a business class or by the UI to update an object.

Parameters

obj	Object to update.

Exceptions

ArgumentNullException

obj is null.

Implemented in Csla.DataPortal< T >.

---

The documentation for this interface was generated from the following file:

• csla/Source/Csla/IDataPortalT.cs