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 | |
---|---|---|
EntityMembersGetCriteria | Initializes a new instance of the EntityMembersGetCriteria class. |
Top
Properties
Name | Description | |
---|---|---|
AttributeGroupId | Gets or sets an attribute group as a method of identifying a desired column set. | |
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. | |
DisplayType | Gets or sets the display type. | |
EntityId | Gets or sets a GUID or the exact name of the entity. | |
HierarchyId | Gets or sets a GUID or the exact name of the hierarchy. | |
HierarchyType | Gets or sets explicit, derived, or collection. | |
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. | |
MemberType | Gets or sets leaf, parent, or collection members (optional if the entity GUID is specified). | |
ModelId | Gets or sets GUID or the exact name of the model. | |
PageNumber | Gets or sets the page number, based on PageSize, to retrieve (the default is 1). | |
PageSize | Gets or sets the number of records to include in a single retrieval. | |
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. | |
ParentMember | Gets or sets the code of the parent member. | |
SearchTerm | Gets or sets a WHERE clause search criteria to filter records. | |
SortColumnId | Gets or sets the column on which the returned members are sorted. | |
SortDirection | Gets or sets ascending or descending sort direction. | |
VersionId | Gets or sets the GUID or the exact name of the version. |
Top
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
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.