EntityMembersGetCriteria Class

Definition

The criteria use to retrieve members.

public ref class EntityMembersGetCriteria : Microsoft::MasterDataServices::Services::DataContracts::DataContractBase
[System.Runtime.Serialization.DataContract(Name="EntityMembersGetCriteria", Namespace="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")]
public class EntityMembersGetCriteria : Microsoft.MasterDataServices.Services.DataContracts.DataContractBase
[<System.Runtime.Serialization.DataContract(Name="EntityMembersGetCriteria", Namespace="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")>]
type EntityMembersGetCriteria = class
    inherit DataContractBase
Public Class EntityMembersGetCriteria
Inherits DataContractBase
Inheritance
EntityMembersGetCriteria
Attributes

Remarks

The EntityMembersGetCriteria specifies the criteria to use to identify the members that are to be retrieved.

Constructors

EntityMembersGetCriteria()

Default constructor

Properties

AttributeGroupId

Specifies the attribute group identifier of the members to retrieve.

Attributes

Specifies the attributes of the members to retrieve.

ChangesetId

Specifies the Changeset identifier of the members to retrieve.

ChangeSetId

Specifies the change set identifier of the members to retrieve.

DisplayType
Obsolete.

Specifies the display type of the members to retrieve.

EntityId

Specifies the entity identifier of the members to retrieve.

ExcludeAuditInfo

Specifies whether exclude auditing information.

HierarchyId

Specifies the hierarchy of the members to retrieve, when retrieving members under another in a hierarchy

HierarchyLevelNumber

Specifies the number of the derived hierarchy level, where zero is the top level. Used when retrieving members under another member in a derived hierarchy.

HierarchyType

Specifies the hierarchy type of the members to retrieve, when retrieving members under another in a hierarchy. This element MUST be used in conjunction with ParentMember and HierarchyId.

IncludeUnchangedValue

Specifies whether to combine the pending changes with the existing attribute values. The element can only be set to "true" when the ChangesetId is specified.

MemberReturnOption

Specifies the return options of the members to retrieve.

MemberType

Specifies the member type of the members to retrieve.

ModelId

Specifies the model identifier of the members to retrieve.

PageNumber

Specifies the page number of the members to retrieve.

PageSize

Specifies the page size of the members to retrieve.

ParentEntityId

Specifies the parent entity identifier of the members to retrieve when retrieving members under another in a hierarchy. This element MUST be used in conjunction with ParentMember and HierarchyId

ParentMember

Specifies the parent member Code of the members to retrieve when retrieving members under another member in a hierarchy. This element MUST be used in conjunction with HierarchyId.

SearchTerm

Specifies the search criteria of the members to retrieve.

SortColumnId

Specifies the sort column of the members to retrieve.

SortDirection

Specifies the sort direction of the members to retrieve.

VersionId

Specifies the version of the members to retrieve.

Methods

SetProperty<T>(T, T, String)

Changes the property to the given value.
Returns whether the new value is different from the old value.

(Inherited from DataContractBase)
SetProperty<T>(T, T, String, Boolean)

Changes the property to the given value.
Returns whether the new value is different from the old value.

(Inherited from DataContractBase)

Applies to