com.sapportals.wcm.repository

Interface IOrderableCollection

public interface IOrderableCollection

Interfaces for collections that support ordering.

Copyright (c) SAP AG 2003-2004

See Also:

RFC3648

Method Summary

IUri	getOrderingType() Returns information about the collection's ordering, where the following URIs are reserved: "DAV:unordered": unordered collection "DAV:custom": client-maintained ordering, no additional information about the ordering semantics available Any other URI identifies an ordering for which additional information semantics MAY be available at the given URI
void	setOrderingType(IUri orderingType) Sets the collection's ordering type.

Method Detail

getOrderingType

IUri getOrderingType()
                     throws ResourceException

Returns information about the collection's ordering, where the following URIs are reserved:

"DAV:unordered": unordered collection
"DAV:custom": client-maintained ordering, no additional information about the ordering semantics available

Any other URI identifies an ordering for which additional information semantics MAY be available at the given URI

Returns:

the ordering type

Throws:

ResourceException - Exception raised in failure situation

setOrderingType

void setOrderingType(IUri orderingType)
                     throws ResourceException

Sets the collection's ordering type. For a definition of predefined URIs, see getOrderingType().

Parameters:

orderingType - orderingType to be set

Throws:

ResourceException - Exception raised in failure situation

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM