Share via


ProcedureConfiguration Class

 

Represents a Procedure that is exposed in the model

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

Inheritance Hierarchy

System.Object
  System.Web.OData.Builder.ProcedureConfiguration
    System.Web.OData.Builder.ActionConfiguration
    System.Web.OData.Builder.FunctionConfiguration

Syntax

public abstract class ProcedureConfiguration
public ref class ProcedureConfiguration abstract 
[<AbstractClass>]
type ProcedureConfiguration = class end
Public MustInherit Class ProcedureConfiguration

Properties

Name Description
System_CAPS_pubproperty BindingParameter

Gets the binding parameter.

System_CAPS_pubproperty EntitySetPath

The EntitySetPathExpression that entities are returned from.

System_CAPS_pubproperty FollowsConventions

Gets a value indicating whether procedure links follow OData conventions.

System_CAPS_pubproperty FullyQualifiedName

The FullyQualifiedName is the ContainerQualifiedName further qualified using the Namespace. Typically this is not required, because most services have at most one container with the same name.

System_CAPS_pubproperty IsBindable

Can the procedure be bound to a url representing the BindingParameter.

System_CAPS_pubproperty IsComposable

Can the procedure be composed upon. For example can a URL that invokes the procedure be used as the base url for a request that invokes the procedure and does something else with the results

System_CAPS_pubproperty IsSideEffecting

Does the procedure have side-effects.

System_CAPS_pubproperty Kind

The Kind of procedure, which can be either Action, Function or ServiceOperation

System_CAPS_protproperty LinkFactory

Gets or sets the currently registered procedure link factory.

System_CAPS_protproperty ModelBuilder

Gets or sets the ODataModelBuilder used to create this configuration.

System_CAPS_pubproperty Name

The Name of the procedure

System_CAPS_pubproperty Namespace

The Namespace by default is the ModelBuilder's Namespace.

System_CAPS_pubproperty NavigationSource

The Navigation Source that are returned from.

System_CAPS_pubproperty OptionalReturn

Gets or sets a value indicating whether the return is optional or not.

System_CAPS_pubproperty Parameters

The parameters the procedure takes

System_CAPS_pubproperty ReturnType

The type returned when the procedure is invoked.

System_CAPS_pubproperty Title

The Title of the procedure. When customized, the title of the procedure will be sent back when the OData client asks for an entity or a feed in JSON full metadata.

Methods

Name Description
System_CAPS_pubmethod AddParameter(String, IEdmTypeConfiguration)

Adds a new non-binding parameter.

System_CAPS_pubmethod CollectionEntityParameter<TElementEntityType>(String)

Adds a new non-binding collection of entity type parameter.

System_CAPS_pubmethod CollectionParameter<TElementType>(String)

Adds a new non-binding collection parameter

System_CAPS_pubmethod EntityParameter<TEntityType>(String)

Adds a new non-binding entity type parameter.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Parameter<TParameter>(String)

Adds a new non-binding parameter

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

System.Web.OData.Builder Namespace

Return to top