PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey Class Reference

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

Public Member Functions
	PagedRecordOrderKey (string fieldName)
	Constructor. More...
	PagedRecordOrderKey (string fieldName, PagedTopicOrder order)
	Constructor. More...
	PagedRecordOrderKey (string fieldName, PagedTopicOrder order, IPagedTopicRules rules)
	Constructor. More...
override int	GetHashCode ()
	Serves as a hash function for a particular type. More...
override bool	Equals (object obj)
	Determines whether the specified T:System.Object is equal to the current T:System.Object. More...
override string	ToString ()
	Returns a string that represents the current object. More...

Properties
string	FieldName [get, set]
	Returns the field name. More...
PagedTopicOrder	Order [get, set]
	Returns the order that the field is to be sorted into. More...
IPagedTopicRules	Rules [get, set]
	Returns the fules for the field. More...

Detailed Description

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

Deprecated since 5.9.

Constructor & Destructor Documentation

PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.PagedRecordOrderKey

(

string

fieldName

)

Constructor.

Creates an order key that specifies a field should be sorted in ascending order with no additional rules.

Parameters

fieldName

The name of the field to sort on.

PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.PagedRecordOrderKey	(	string	fieldName,
		PagedTopicOrder	order
	)

Constructor.

Creates an order key specifying a field to sort and the order.

Parameters

fieldName	The name of the field to sort on.
order	The order of sorting. If null then PagedTopicOrder.ASCENDING

is assumed.

PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.PagedRecordOrderKey	(	string	fieldName,
		PagedTopicOrder	order,
		IPagedTopicRules	rules
	)

Constructor.

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. If null then PagedTopicOrder.ASCENDING

is assumed.

Parameters

rules

Additional rules. If this is null then PagedTopicRules.NO_RULES

is assumed.

Member Function Documentation

override bool PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.Equals

(

object

obj

)

Determines whether the specified T:System.Object is equal to the current T:System.Object.

Returns

true if the specified T:System.Object is equal to the current T:System.Object; otherwise, false.

Parameters

obj	The object to compare with the current object.

override int PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.GetHashCode

(

)

Serves as a hash function for a particular type.

Returns

A hash code for the current T:System.Object.

override string PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.ToString

(

)

Returns a string that represents the current object.

Returns

A string that represents the current object.

Property Documentation

string PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.FieldName

getset

Returns the field name.

PagedTopicOrder PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.Order

getset

Returns the order that the field is to be sorted into.

IPagedTopicRules PushTechnology.ClientInterface.Client.Topics.PagedRecordOrderKey.Rules

getset

Returns the fules for the field.

---

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

• UCIStack/Client/Topics/PagedRecordOrderKey.cs