PTDiffusionPagedRecordTopicOrderKey Class Reference

Introduction

An order key that specifies the sort ordering for a particular field within a record.

See Also

PTDiffusionPagedRecordTopicDetailsBuilder

PTDiffusionPagedRecordTopicOrderingPolicy

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

Inheritance diagram for PTDiffusionPagedRecordTopicOrderKey:

Properties
NSString *	fieldName
PTDiffusionPagedTopicOrder *	order
PTDiffusionPagedTopicRules *	rules

Instance Methods
(instancetype)	- initWithFieldName:order:rules:
(BOOL)	- isEqualToPagedRecordTopicOrderKey:

Method Documentation

- (instancetype) initWithFieldName:		(NSString *)	fieldName
order:		(PTDiffusionPagedTopicOrder *)	order
rules:		(nullable PTDiffusionPagedTopicRules *)	rules

Creates an order key specifying a field to sort, the sort order and any additional rules.

Parameters

fieldName	The name of the field to sort on.
order	The order of sorting.
rules	Additional rules. If this is nil then no rules is assumed.

Exceptions

NSInvalidArgumentException

If fieldName or order are nil.

Since

5.7

- (BOOL) isEqualToPagedRecordTopicOrderKey:

(nullable PTDiffusionPagedRecordTopicOrderKey *)

pagedRecordTopicOrderKey

Compares the receiver to the given paged record topic order key.

Parameters

pagedRecordTopicOrderKey

The paged record topic order key object with which to compare the receiver.

Returns

YES if the paged record topic order key is equal to the receiver, otherwise NO.

Since

5.7

Property Documentation

- (NSString*) fieldName

readnonatomicassign

The field name.

Since

5.7

- (PTDiffusionPagedTopicOrder*) order

readnonatomicassign

The order that the field is to be sorted into.

Since

5.7

- (PTDiffusionPagedTopicRules*) rules

readnonatomicassign

Additional rules used when sorting.

• If nil then no additional rules are applied to ordering.
• If not nil then supplied rules will be used.

Since

5.7