Class google.gdata.Ordering

Object
   |
   +--google.gdata.Ordering

class google.gdata.Ordering

Control ordering for a set of atom entries.
Defined in gdata.js

Field Detail

next

{string|undefined} next

Next element. This attribute is optional.

orderId

{string|undefined} orderId

Ordered feed id. This attribute is optional.

prev

{string|undefined} prev

Previous element. This attribute is optional.

ref

{string|undefined} ref

Other entry id. This attribute is optional.

rel

{string|undefined} rel

Order type. This attribute is optional.

REL_COMESAFTER

<static> <final> {string} REL_COMESAFTER

ComesAfter ordering.

See Also:

Constant Field Values

REL_FIRST

<static> <final> {string} REL_FIRST

First ordering.

See Also:

Constant Field Values

REL_LAST

<static> <final> {string} REL_LAST

Last ordering.

See Also:

Constant Field Values

google.gdata.Ordering

google.gdata.Ordering(<Object> opt_params)

Constructs an ordering using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: next, orderId, prev, ref, and rel.

getNext

string|undefined getNext()

Returns the next element. This attribute is optional.

Returns:
Next element or undefined for none.

getOrderId

string|undefined getOrderId()

Returns the ordered feed id. This attribute is optional.

Returns:
Ordered feed id or undefined for none.

getPrev

string|undefined getPrev()

Returns the previous element. This attribute is optional.

Returns:
Previous element or undefined for none.

getRef

string|undefined getRef()

Returns the other entry id. This attribute is optional.

Returns:
Other entry id or undefined for none.

getRel

string|undefined getRel()

Returns the order type. This attribute is optional.

Returns:
Order type or undefined for none.

setNext

void setNext(<string|undefined> next)

Sets the next element. This attribute is optional.

Parameters:
next - Next element or undefined for none.

setOrderId

void setOrderId(<string|undefined> orderId)

Sets the ordered feed id. This attribute is optional.

Parameters:
orderId - Ordered feed id or undefined for none.

setPrev

void setPrev(<string|undefined> prev)

Sets the previous element. This attribute is optional.

Parameters:
prev - Previous element or undefined for none.

setRef

void setRef(<string|undefined> ref)

Sets the other entry id. This attribute is optional.

Parameters:
ref - Other entry id or undefined for none.

setRel

void setRel(<string|undefined> rel)

Sets the order type. This attribute is optional.

Parameters:
rel - Order type or undefined for none.