RtAssociationExtendedQueryOptions
Namespace: Meshmakers.Octo.Runtime.Contracts.Repositories.Query
Represents extended query options for runtime associations.
public record RtAssociationExtendedQueryOptions : RtAssociationBaseQueryOptions, IEquatable<RtAssociationBaseQueryOptions>, IEquatable<RtAssociationExtendedQueryOptions>
Inheritance Object → RtAssociationBaseQueryOptions → RtAssociationExtendedQueryOptions
Implements IEquatable<RtAssociationBaseQueryOptions>, IEquatable<RtAssociationExtendedQueryOptions>
Properties
RoleId
Gets if defined a value indicating to filter by a specific role id
public RtCkId<CkAssociationRoleId> RoleId { get; }
Property Value
RtCkId<CkAssociationRoleId>
RelatedRtCkTypeId
Gets if defined a value indicating to filter by a specific related type id
public RtCkId<CkTypeId> RelatedRtCkTypeId { get; }
Property Value
RtCkId<CkTypeId>
RelatedRtId
Defines if set a value indicating to filter by a specific related runtime entity id
public Nullable<OctoObjectId> RelatedRtId { get; }
Property Value
Direction
Gets the graph direction of the association.
public GraphDirections Direction { get; }
Property Value
GraphDirections
Skip
Gets if defined a value indicating how many associations are skipped
public Nullable<int> Skip { get; }
Property Value
Take
Gets if defined a value indicating how many associations are taken.
public Nullable<int> Take { get; }
Property Value
GlobalFilter
Represents global filter settings for the query.
public GlobalRtAssociationFilter GlobalFilter { get; }
Property Value
Methods
Create(GraphDirections)
Creates a new instance of RtAssociationBaseQueryOptions.
public static RtAssociationExtendedQueryOptions Create(GraphDirections direction)
Parameters
direction GraphDirections
The graph direction for query
Returns
RtAssociationExtendedQueryOptions
Create(GraphDirections, Nullable<Int32>, Nullable<Int32>)
Creates a new instance of RtAssociationBaseQueryOptions.
public static RtAssociationExtendedQueryOptions Create(GraphDirections direction, Nullable<int> skip, Nullable<int> take)
Parameters
direction GraphDirections
The graph direction for query
skip Nullable<Int32>
Number of items to skip
take Nullable<Int32>
Number of items to take
Returns
RtAssociationExtendedQueryOptions
Create(GraphDirections, RtCkId<CkAssociationRoleId>, RtCkId<CkTypeId>, RtCkId<CkTypeId>, Nullable<Int32>, Nullable<Int32>)
Creates a new instance of RtAssociationExtendedQueryOptions.
public static RtAssociationExtendedQueryOptions Create(GraphDirections direction, RtCkId<CkAssociationRoleId> roleId, RtCkId<CkTypeId> originTypeId, RtCkId<CkTypeId> targetTypeId, Nullable<int> skip, Nullable<int> take)
Parameters
direction GraphDirections
The graph direction for query
roleId RtCkId<CkAssociationRoleId>
Filter by role id
originTypeId RtCkId<CkTypeId>
Filter by origin type id
targetTypeId RtCkId<CkTypeId>
Filter by target type id
skip Nullable<Int32>
Number of items to skip
take Nullable<Int32>
Number of items to take
Returns
RtAssociationExtendedQueryOptions
Create(GraphDirections, RtCkId<CkAssociationRoleId>, RtCkId<CkTypeId>, Nullable<OctoObjectId>, Nullable<Int32>, Nullable<Int32>)
Creates a new instance of RtAssociationExtendedQueryOptions.
public static RtAssociationExtendedQueryOptions Create(GraphDirections direction, RtCkId<CkAssociationRoleId> roleId, RtCkId<CkTypeId> relatedRtCkTypeId, Nullable<OctoObjectId> relatedRtId, Nullable<int> skip, Nullable<int> take)
Parameters
direction GraphDirections
The graph direction for query
roleId RtCkId<CkAssociationRoleId>
Filter by role id
relatedRtCkTypeId RtCkId<CkTypeId>
Filter by related type id
relatedRtId Nullable<OctoObjectId>
Filter by related runtime entity id
skip Nullable<Int32>
Number of items to skip
take Nullable<Int32>
Number of items to take