Package com.microstrategy.web.objects

Interface WebFormSort

All Superinterfaces:

WebSort

All Known Subinterfaces:

WebFormSortConfig

public interface WebFormSort
extends WebSort

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

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
WebAttributeForm	getForm()	Returns the WebAttributeForm object which is the form used in the sort.
WebObjectInfo	getTarget()	Returns the current setting for the target of the sort.
void	setForm(WebAttributeForm form)	Sets the WebAttributeForm object which is the form used in the sort.
void	setTarget(WebObjectInfo object)	Sets the target of the sort.

Methods inherited from interface com.microstrategy.web.objects.WebSort

getKey, getPosition, getRespectParent, getSortType, getSubtotalsPosition, isAscending, setAscending, setRespectParent, setSubtotalsPosition

Method Detail

getTarget

WebObjectInfo getTarget()

Returns the current setting for the target of the sort.

Specified by:

getTarget in interface WebSort

Returns:

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

See Also:

setTarget(com.microstrategy.web.objects.WebObjectInfo)

setTarget

void setTarget(WebObjectInfo object)
        throws java.lang.IllegalArgumentException

Sets the target of the sort.

Parameters:

object - The target of the sort. This is an object of type WebObjectInfo.

Throws:

java.lang.IllegalArgumentException - Thrown if the object reference passed is null.

See Also:

getTarget()

getForm

WebAttributeForm getForm()

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

Returns:

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

See Also:

setForm(com.microstrategy.web.objects.WebAttributeForm)

setForm

void setForm(WebAttributeForm form)
      throws java.lang.IllegalArgumentException

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

Parameters:

form - The form to use when sorting.

Throws:

java.lang.IllegalArgumentException - Thrown if input parameter is null.

See Also:

getForm()