IsValidStateTransitionRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to validate the state transition.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class IsValidStateTransitionRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class IsValidStateTransitionRequest : OrganizationRequest

Example

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.

// Create an EntityReference to represent an open case
EntityReference caseReference = new EntityReference()
{
    LogicalName = Incident.EntityLogicalName,
    Id = _caseIncidentId
};

IsValidStateTransitionRequest checkState = 
    new IsValidStateTransitionRequest();

// Set the transition request to an open case
checkState.Entity = caseReference;

// Check to see if a new state of "resolved" and 
// a new status of "problem solved" are valid
checkState.NewState = IncidentState.Resolved.ToString();
checkState.NewStatus = (int)incident_statuscode.ProblemSolved;

// Execute the request
IsValidStateTransitionResponse checkStateResponse = 
    (IsValidStateTransitionResponse)_serviceProxy.Execute(checkState);

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the IsValidStateTransitionResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the Entity property and access rights on the specified record in the Entity property. For a complete list of the required privileges, see IsValidStateTransition Privileges.

Notes for Callers

If an incident (case) or opportunity is already closed or canceled, or if an incident (case) has open activities, an exception is thrown.

Supported Entities

The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.IsValidStateTransitionRequest

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

IsValidStateTransitionRequest Members
Microsoft.Crm.Sdk.Messages Namespace
IsValidStateTransitionResponse

Other Resources

Opportunity Entities
Incident (Case) Entities
IsValidStateTransition Privileges
Sample: Validate Record State and Set State of the Record
How Role-Based Security Can Be Used to Control Access to Entities in CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) in CRM

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.