Diffusion .NET API  5.9.24
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Pages
PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD > Interface Template Reference

The builder interface for paged topic details. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD >:
PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD > PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedRecordTopicDetailsBuilder PushTechnology.ClientInterface.Client.Topics.IPagedStringTopicDetailsBuilder

Public Member Functions

TB Order (string comparatorName)
 Specifies PagedTopicOrdering.COMPARATOR ordering is to be applied to the topic. More...
 
TB Order (PagedTopicDuplicates duplicatesPolicy, string comparatorName)
 Specifies PagedTopicOrdering.COMPARATOR ordering is to be applied to the topic. More...
 
TB Unordered ()
 This specifies that the topic ordering should be set to PagedTopicOrdering.UNORDERED. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TB, out TD >
new TB SetReference (string reference)
 Sets the initial value of the topic reference. More...
 
new TB SetTidyOnUnsubscribe (bool tidy)
 Sets the 'tidy on unsubscribe' flag. More...
 
new TB SetProperty (string key, string value)
 Sets a topic property. More...
 
new TB Reset ()
 Resets the builder to its initial values. More...
 
- Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.ITopicDetailsBuilder< out TD >
new TD Build ()
 Build the content. More...
 

Detailed Description

The builder interface for paged topic details.

Type Constraints
TB :IPagedTopicDetailsBuilder 
TB :TB 
TB :TD 
TD :ITopicDetails 

Member Function Documentation

TB PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD >.Order ( string  comparatorName)

Specifies PagedTopicOrdering.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 class name should be the full class name of a Java class available at the server which is either of generic type string or IRecord depending on 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 PagedTopicDuplicates.NOT_ALLOWED is assumed.

Parameters
comparatorNameThe full comparator class name.
Returns
This builder.
TB PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD >.Order ( PagedTopicDuplicates  duplicatesPolicy,
string  comparatorName 
)

Specifies PagedTopicOrdering.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 class name should be the full class name of a Java class available at the server which is either of generic type string or IRecord depending on 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
duplicatesPolicyThe duplicate policy to use. If this is null, then PagedTopicDuplicates.NOT_ALLOWED is assumed.
comparatorNameThe full comparator class name.
Returns
This builder.
TB PushTechnology.ClientInterface.Client.Topics.IPagedTopicDetailsBuilder< out TB, out TD >.Unordered ( )

This specifies that the topic ordering should be set to PagedTopicOrdering.UNORDERED.

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

Returns
This builder.

The documentation for this interface was generated from the following file: