<PTDiffusionPagedTopicDetailsBuilder> Protocol Reference

Introduction

All paged topic details builders conform to this protocol.

See Also

PTDiffusionTopicDetails

Deprecated:

Since 5.9. Will be removed in a future release.

Since

5.7

Inheritance diagram for <PTDiffusionPagedTopicDetailsBuilder>:

Instance Methods
(void)	- orderWithComparatorName:
(void)	- orderWithDuplicatesPolicy:comparatorName:
(void)	- unordered
Instance Methods inherited from <PTDiffusionTopicDetailsBuilder>
(void)	- setPropertyValue:forKey:
(BOOL)	- removePropertyForKey:
(nullable NSString *)	- propertyValueForKey:

Additional Inherited Members
Properties inherited from <PTDiffusionTopicDetailsBuilder>
NSString *	reference
BOOL	tidiesOnUnsubscribe
NSDictionary< NSString *, NSString * > *	properties

Method Documentation

- (void) orderWithComparatorName:

(NSString *)

comparatorName

Specifies comparator ordering is to be applied to the topic.

This allows ordering to be specified which will be handled by a class at the server which is used to determine the order.

The comparator name should be the full class name of a Java class available at the server which is either of generic type String or Record depending upon the subtype. An instance of this class will be instantiated at the server for the topic to use for determining the line order.

Calling this method would replace any previously specified ordering policy.

A duplicates policy of 'not allowed' is assumed.

Parameters

comparatorName

The full class name of the comparator.

Exceptions

NSInvalidArgumentException

if comparatorName is nil or of zero length.

Since

5.7

- (void) orderWithDuplicatesPolicy:		(PTDiffusionPagedTopicDuplicates *)	duplicatesPolicy
comparatorName:		(NSString *)	comparatorName

Specifies comparator ordering is to be applied to the topic.

This allows ordering to be specified which will be handled by a class at the server which is used to determine the order.

The comparator name should be the full class name of a Java class available at the server which is either of generic type String or Record depending upon the subtype. An instance of this class will be instantiated at the server for the topic to use for determining the line order.

Calling this method would replace any previously specified ordering policy.

Parameters

duplicatesPolicy	The duplicate policy to use.
comparatorName	The full class name of the comparator.

Exceptions

NSInvalidArgumentException

if duplicatesPolicy is nil, or comparatorName is nil or of zero length.

Since

5.7

- (void) unordered

This specifies that the topic ordering should be set to unordered.

This is the default mode but this method may be used to remove any ordering policy previously specified.

Since

5.7