CanBeReferencingRequest CanBeReferencingRequest CanBeReferencingRequest CanBeReferencingRequest Class

Definition

Contains the data that is needed to check whether an entity can be the referencing entity in a one-to-many relationship.

For the Web API use the CanBeReferencing Action.

public ref class CanBeReferencingRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class CanBeReferencingRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type CanBeReferencingRequest = class
    inherit OrganizationRequest
Public NotInheritable Class CanBeReferencingRequest
Inherits OrganizationRequest
Inheritance
CanBeReferencingRequestCanBeReferencingRequestCanBeReferencingRequestCanBeReferencingRequest
Attributes

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface.


public bool EligibleCreateOneToManyRelationship(string referencedEntity, 
    string referencingEntity)
{
    //Checks whether the specified entity can be the primary entity in one-to-many
    //relationship.
CanBeReferencedRequest canBeReferencedRequest = new CanBeReferencedRequest
    {
        EntityName = referencedEntity
    };

CanBeReferencedResponse canBeReferencedResponse =(CanBeReferencedResponse)svc.Execute(canBeReferencedRequest);

if (!canBeReferencedResponse.CanBeReferenced) { Console.WriteLine( "Entity {0} can't be the primary entity in this one-to-many relationship", referencedEntity); }

//Checks whether the specified entity can be the referencing entity in one-to-many //relationship. CanBeReferencingRequest canBereferencingRequest = new CanBeReferencingRequest { EntityName = referencingEntity };

CanBeReferencingResponse canBeReferencingResponse =(CanBeReferencingResponse)svc.Execute(canBereferencingRequest);

if (!canBeReferencingResponse.CanBeReferencing) { Console.WriteLine("Entity {0} can't be the referencing entity in this one-to-many relationship", referencingEntity); }

if (canBeReferencedResponse.CanBeReferenced == true && canBeReferencingResponse.CanBeReferencing == true) { return true; } else { return false; } }

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

relationships#WorkWithRelationships4 relationshipsVB#WorkWithRelationships4

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the CanBeReferencingResponse class.

Privileges and Access Rights

To perform this action, the caller must have the required privileges, as listed in CanBeReferencing message privileges.

Notes for Callers

Constructors

CanBeReferencingRequest() CanBeReferencingRequest() CanBeReferencingRequest() CanBeReferencingRequest()

Initializes a new instance of the CanBeReferencingRequest class.

Properties

EntityName EntityName EntityName EntityName

Gets or sets the logical entity name. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also