Take the 2-minute tour ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.

I'm trying to manually build a WCF Data Service using a POCO data model and I cannot figure out how to properly expose enum values. Assuming a simple model like:

public class Order
{
   public int ID {get; set;}
   public string Description {get; set;}
   public OrderStatus Status {get; set;}
}

public enum OrderStatus
{
   New,
   InProcess,
   Complete
}

How do you expose the valuable information in the OrderStatus property via the OData WCF Data Service?

If you do nothing, the Data Service generates a runtime error (enum is invalid property). The only answer I've seen that at least resolves the error is to mark the enum property as Ignored, such as:

[System.Data.Services.IgnoreProperties("Status")]
public class Order ...

This works, but it forces you to "omit" valuable information from the service layer. Are there other options for working with enum values in WCF Data Services?

EDIT: Please notice this is WCF Data Services (aka Astoria). This is not raw WCF Services, in which case the answers are more clear.

share|improve this question
 
It's recommended to avoid enums in webservices because they create subtle backwards compatible problems. See stackoverflow.com/a/788281/52277 –  Michael Freidgeim Jul 21 '13 at 10:04
add comment

6 Answers

up vote 11 down vote accepted

Enums are currently not supported in WCF Data Services (the OData protocol doesn't support them either). The typical workaround is to use string and constant values, or integer and constant values.

share|improve this answer
 
I was afraid of that. Happy to have clear confirmation at least. I'm trying some "wrapper" workarounds so I don't have to make large changes to my model just to use Data Services. Hopefully one of the workarounds will work! –  Todd Aug 26 '10 at 4:41
 
@Vitek: Enums are a tremendously common programming construct, and it's a bizarre step backwards to not use them. Are there any plans to include enum support in future versions of the OData standard, or will WCF Data Services provide optional support when both ends are known to be on the MSFT stack? –  Eric J. Feb 6 '12 at 5:31
 
We understand that enums are common, unfortunately they never met tha bar so far. They are rather high on our list of things to do next though. –  Vitek Karas MSFT Feb 6 '12 at 9:43
 
@Vitek: I posted a more general version of this question and would appreciate any insight you can offer stackoverflow.com/questions/3570249/… BTW in spite of some rough edges, I'm a big fan of the work MSFT is doing in this area. –  Eric J. Feb 8 '12 at 0:11
 
The link in your comment points back to this question, could you please repost the riht one? :-) –  Vitek Karas MSFT Feb 8 '12 at 12:57
show 3 more comments

As follow-up, the "wrapper" approach is ultimately what worked. Essentially, a small class is written to wrap the enum and return primitive int values in the Data Service:

[IgnoreProperties("EnumValue")]
public class OrderStatusWrapper
{
    private OrderStatus _t;

    public int Value
    {
        get{ return (int)_t; }
        set { _t = (OrderStatus)value; }
    }

    public OrderStatus EnumValue
    {
        get { return _t; }
        set { _t = value; }
    }

    public static implicit operator OrderStatusWrapper(OrderStatus r)
    {
        return new OrderStatusWrapper { EnumValue = r };
    }

    public static implicit operator OrderStatus(OrderStatusWrapper rw)
    {
        if (rw == null)
            return OrderStatus.Unresolved;
        else
            return rw.EnumValue;
    }
}  

This was largely based on the advice given for working around EF4's enum limits:

http://blogs.msdn.com/b/alexj/archive/2009/06/05/tip-23-how-to-fake-enums-in-ef-4.aspx

Hope this technique helps others that follow.

share|improve this answer
3  
Replace _s with _t –  Pakman Mar 14 '12 at 20:27
add comment

Assuming DataContract Serialization, like so:

[DataContract]
public class Order
{
   [DataMember]
   public int ID {get; set;}
   [DataMember]
   public string Description {get; set;}
   [DataMember]
   public OrderStatus Status {get; set;}
}

[DataContract]
public enum OrderStatus
{
    [EnumMember]
    New,
    [EnumMember]
    InProcess,
    [EnumMember]   
    Complete
}
share|improve this answer
 
This generally works for plain WCF Services, but in this case I'm asking about WCF Data Services (formerly known as Astoria). In my tests, this solution DOES NOT work for using enums in Data Services. Have you tested this with WCF Data Services? –  Todd Aug 25 '10 at 21:34
 
Oops - apols. There is a dirty hack in the links on Troy's post which might work for you - add an extra serializable int to the entity and then cast the enum to the getter / setters (but ignore the enum) –  StuartLC Aug 25 '10 at 21:43
add comment

Maybe we can "cheat" it with the below workaround:

[System.Data.Services.IgnoreProperties("Status")]
public class Order
{
   public int ID {get; set;}
   public string Description {get; set;}
   public OrderStatus Status {get; set;}
   public int StatusValue
   {
      get
      {
           return (int)this.Status;
      }
      set
      {
          // Add validation here
          this.Status = (OrderStatus)value;
      } 
   }
}

public enum OrderStatus
{
   New,
   InProcess,
   Complete
}
share|improve this answer
 
Very near the final solution I used! –  Todd Aug 27 '10 at 21:56
add comment

You need to make the enum a Data Contract.

See here for an example: http://consultingblogs.emc.com/merrickchaffer/archive/2007/04/03/Passing-Enum-values-into-WCF-Service-operations.aspx

[Edit] Apparently, that's not always the case as seen here: http://stackoverflow.com/questions/187505/sharing-enum-with-wcf-service

share|improve this answer
 
Thanks for the quick input, but I think you missed that this is WCF Data Services, not plain WCF. I've tried the typical DataContract/EnumMember attributes, but they do not seem to work with WCF Data Services (aka Astoria). –  Todd Aug 25 '10 at 21:35
add comment

You need to write own QueryPrivider

    public object GetPropertyValue(object target, ResourceProperty resourceProperty)
    {
        object result = null;
        PropertyInfo info = target.GetType().GetProperty(resourceProperty.Name);
        if (info != null)
            result = info.GetValue(target, null);
        if (result is Enum)
            return Convert.ToInt32(result);
        return result;
    }


    public ResourceType GetResourceType(object target)
    {
        ResourceType result = null;
        Type tp = target.GetType();
        if (tp.IsEnum)
        {
            result =  ResourceType.GetPrimitiveResourceType(typeof(Int32));
            return result;
        }
        ....
        return result;
    }
share|improve this answer
add comment

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.