Share via


EntityMembersGetCriteria Class

Represents a request complex type that defines the EntityMember criteria for the operations result set.

Inheritance Hierarchy

System.Object
  Microsoft.MasterDataServices.Services.DataContracts.EntityMembersGetCriteria

Namespace:  Microsoft.MasterDataServices.Services.DataContracts
Assembly:  Microsoft.MasterDataServices.Services (in Microsoft.MasterDataServices.Services.dll)

Syntax

'Declaration
<DataContractAttribute(Name := "EntityMembersGetCriteria", Namespace := "https://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")> _
Public Class EntityMembersGetCriteria
'Usage
Dim instance As EntityMembersGetCriteria
[DataContractAttribute(Name = "EntityMembersGetCriteria", Namespace = "https://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")]
public class EntityMembersGetCriteria
[DataContractAttribute(Name = L"EntityMembersGetCriteria", Namespace = L"https://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")]
public ref class EntityMembersGetCriteria
[<DataContractAttribute(Name = "EntityMembersGetCriteria", Namespace = "https://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")>]
type EntityMembersGetCriteria =  class end
public class EntityMembersGetCriteria

The EntityMembersGetCriteria type exposes the following members.

Constructors

  Name Description
Public method EntityMembersGetCriteria Initializes a new instance of the EntityMembersGetCriteria class.

Top

Properties

  Name Description
Public property AttributeGroupId Gets or sets an attribute group as a method of identifying a desired column set.
Public property Attributes Gets or sets a list of desired attribute columns by GUID or name. If AttributeGroup is specified, only columns within the attribute group may be specified.
Public property DisplayType Gets or sets the display type.
Public property EntityId Gets or sets a GUID or the exact name of the entity.
Public property HierarchyId Gets or sets a GUID or the exact name of the hierarchy.
Public property HierarchyType Gets or sets explicit, derived, or collection.
Public property MemberReturnOption Gets or sets one of Data, Counts, or DataAndCounts. The operation response will include member data only, member counts only, or both the data and the counts as specified.
Public property MemberType Gets or sets leaf, parent, or collection members (optional if the entity GUID is specified).
Public property ModelId Gets or sets GUID or the exact name of the model.
Public property PageNumber Gets or sets the page number, based on PageSize, to retrieve (the default is 1).
Public property PageSize Gets or sets the number of records to include in a single retrieval.
Public property ParentEntityId Gets or sets the GUID or the exact name of the parent member’s entity. This is required for derived hierarchies only and is ignored for explicit hierarchies and collections.
Public property ParentMember Gets or sets the code of the parent member.
Public property SearchTerm Gets or sets a WHERE clause search criteria to filter records.
Public property SortColumnId Gets or sets the column on which the returned members are sorted.
Public property SortDirection Gets or sets ascending or descending sort direction.
Public property VersionId Gets or sets the GUID or the exact name of the version.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

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.