EntitySetController<TEntity, TKey> Class

Provides a convenient starting point for a controller that exposes an OData entity set. This is the synchronous version of AsyncEntitySetController<TEntity, TKey>.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  System.Web.Http.ApiController
    System.Web.Http.OData.ODataController
      System.Web.Http.OData.EntitySetController<TEntity, TKey>

Namespace:  System.Web.Http.OData
Assembly:  System.Web.Http.OData (in System.Web.Http.OData.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
<ODataNullValueAttribute> _
Public MustInherit Class EntitySetController(Of TEntity As Class, TKey) _
    Inherits ODataController
'Usage
Dim instance As EntitySetController(Of TEntity, TKey)

[CLSCompliantAttribute(false)]
[ODataNullValueAttribute]
public abstract class EntitySetController<TEntity, TKey> : ODataController 
where TEntity : class

[CLSCompliantAttribute(false)]
[ODataNullValueAttribute]
generic<typename TEntity, typename TKey>
where TEntity : ref class 
public ref class EntitySetController abstract : public ODataController

[<AbstractClassAttribute>]
[<CLSCompliantAttribute(false)>]
[<ODataNullValueAttribute>]
type EntitySetController<'TEntity, 'TKey when 'TEntity : not struct> =  
    class 
        inherit ODataController 
    end

JScript does not support generic types and methods.

Type Parameters

• TEntity
  The type associated with the exposed entity set's entity type.

• TKey
  The type associated with the entity key of the exposed entity set's entity type.

The EntitySetController<TEntity, TKey> type exposes the following members.

Constructors

	Name	Description
	EntitySetController<TEntity, TKey>	Initializes a new instance of the EntitySetController<TEntity, TKey> class.

Top

Properties

	Name	Description
	Configuration	(Inherited from ApiController.)
	ControllerContext	(Inherited from ApiController.)
	ModelState	(Inherited from ApiController.)
	ODataPath	Gets the OData path of the current request.
	QueryOptions	Gets the OData query options of the current request.
	Request	(Inherited from ApiController.)
	RequestContext	(Inherited from ApiController.)
	Url	(Inherited from ApiController.)
	User	(Inherited from ApiController.)

Top

Methods

	Name	Description
	BadRequest()	(Inherited from ApiController.)
	BadRequest(String)	(Inherited from ApiController.)
	BadRequest(ModelStateDictionary)	(Inherited from ApiController.)
	Conflict	(Inherited from ApiController.)
	Content<T>(HttpStatusCode, T)	(Inherited from ApiController.)
	Content<T>(HttpStatusCode, T, MediaTypeFormatter)	(Inherited from ApiController.)
	Content<T>(HttpStatusCode, T, MediaTypeFormatter, String)	(Inherited from ApiController.)
	Content<T>(HttpStatusCode, T, MediaTypeFormatter, MediaTypeHeaderValue)	(Inherited from ApiController.)
	Created<TEntity>(TEntity)	Creates an action result with the specified values that is a response to a POST operation with an entity to an entity set. (Inherited from ODataController.)
	Created<T>(String, T)	(Inherited from ApiController.)
	Created<T>(Uri, T)	(Inherited from ApiController.)
	CreatedAtRoute<T>(String, Object, T)	(Inherited from ApiController.)
	CreatedAtRoute<T>(String, IDictionary<String, Object>, T)	(Inherited from ApiController.)
	CreateEntity	This method should be overridden to create a new entity in the entity set.
	CreateLink	This method should be overridden to handle POST and PUT requests that attempt to create a link between two entities.
	Delete	This method should be overridden to handle DELETE requests for deleting existing entities from the entity set.
	DeleteLink(TKey, String, String)	This method should be overridden to handle DELETE requests that attempt to break a relationship between two entities.
	DeleteLink(TKey, String, Uri)	This method should be overridden to handle DELETE requests that attempt to break a relationship between two entities.
	Dispose()	(Inherited from ApiController.)
	Dispose(Boolean)	(Inherited from ApiController.)
	Equals	(Inherited from Object.)
	ExecuteAsync	(Inherited from ApiController.)
	Finalize	(Inherited from Object.)
	Get()	This method should be overridden to handle GET requests that attempt to retrieve entities from the entity set.
	Get(TKey)	Handles GET requests that attempt to retrieve an individual entity by key from the entity set.
	GetEntityByKey	This method should be overridden to retrieve an entity by key from the entity set.
	GetHashCode	(Inherited from Object.)
	GetKey	This method should be overridden to get the entity key of the specified entity.
	GetType	(Inherited from Object.)
	HandleUnmappedRequest	This method should be overridden to handle all unmapped OData requests.
	Initialize	(Inherited from ApiController.)
	InternalServerError()	(Inherited from ApiController.)
	InternalServerError(Exception)	(Inherited from ApiController.)
	Json<T>(T)	(Inherited from ApiController.)
	Json<T>(T, JsonSerializerSettings)	(Inherited from ApiController.)
	Json<T>(T, JsonSerializerSettings, Encoding)	(Inherited from ApiController.)
	MemberwiseClone	(Inherited from Object.)
	NotFound	(Inherited from ApiController.)
	Ok()	(Inherited from ApiController.)
	Ok<T>(T)	(Inherited from ApiController.)
	Patch	Handles PATCH and MERGE requests to partially update a single entity in the entity set.
	PatchEntity	This method should be overridden to apply a partial update to an existing entity in the entity set.
	Post	Handles POST requests that create new entities in the entity set.
	Put	Handles PUT requests that attempt to replace a single entity in the entity set.
	Redirect(String)	(Inherited from ApiController.)
	Redirect(Uri)	(Inherited from ApiController.)
	RedirectToRoute(String, Object)	(Inherited from ApiController.)
	RedirectToRoute(String, IDictionary<String, Object>)	(Inherited from ApiController.)
	ResponseMessage	(Inherited from ApiController.)
	StatusCode	(Inherited from ApiController.)
	ToString	(Inherited from Object.)
	Unauthorized(array<AuthenticationHeaderValue[])	(Inherited from ApiController.)
	Unauthorized(IEnumerable<AuthenticationHeaderValue>)	(Inherited from ApiController.)
	Updated<TEntity>	Creates an action result with the specified values that is a response to a PUT, PATCH, or a MERGE operation on an OData entity. (Inherited from ODataController.)
	UpdateEntity	This method should be overridden to update an existing entity in the entity set.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Web.Http.OData Namespace