public interface

WebFormSort

implements WebSort
com.microstrategy.web.objects.WebFormSort
Known Indirect Subclasses

Class Overview

This interface represents a sort of type(from EnumDSSXMLSortType): DssXmlSortAttributeForm or DssXmlSortDimensionForm. This class contains properties which apply for only the above sort types.

Summary

Public Methods
abstract WebAttributeForm getForm()
Returns the WebAttributeForm object which is the form used in the sort.
abstract WebObjectInfo getTarget()
Returns the current setting for the target of the sort.
abstract void setForm(WebAttributeForm form)
Sets the WebAttributeForm object which is the form used in the sort.
abstract void setTarget(WebObjectInfo object)
Sets the target of the sort.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebSort

Public Methods

public abstract WebAttributeForm getForm ()

Returns the WebAttributeForm object which is the form used in the sort.

Returns

public abstract WebObjectInfo getTarget ()

Returns the current setting for the target of the sort.

Returns
  • A WebObjectInfo object corresponding to the target of the sort. This may be null if it has not been set.

public abstract void setForm (WebAttributeForm form)

Sets the WebAttributeForm object which is the form used in the sort.

Parameters
form The form to use when sorting.
Throws
IllegalArgumentException Thrown if input parameter is null.
See Also

public abstract void setTarget (WebObjectInfo object)

Sets the target of the sort.

Parameters
object The target of the sort. This is an object of type WebObjectInfo.
Throws
IllegalArgumentException Thrown if the object reference passed is null.
See Also