public interface

WebWorkingSet

com.microstrategy.web.objects.WebWorkingSet

Class Overview

The WebWorkingSet interface allows access the working set and base filter of a report instance. This interface allows the user to obtain the working set subject to a filter on object type, along with supplying incremental fetch capabilities for the working set folder. In addition, objects can be removed from the base report using this interface.

Summary

Public Methods
abstract void add(WebObjectInfo object)
Adds the given object to the working set.
abstract boolean canAddMDXUnit(WebMDXDisplayUnit unit)
This method will tell whether the given MDX unit is acceptable to add to the report.
abstract String getAlias(WebObjectInfo object)
Returns the alias for an object which is in the working set folder.
abstract WebAttributeForms getAllForms(WebAttribute attribute)
Returns all forms of the given attribute in the working set.
abstract int getArity(WebAttribute object)
Returns arity of a specific attribute.
abstract WebAttributeForms getBrowseFormsInWorkingSet(WebAttribute attribute)
This method returns the collection of the browse forms of the attribute which are available within the working set.
abstract WebDerivedElements getDerivedElements(WebAttribute attribute)
abstract WebElementSource getElementSource()
Returns a WebElementSource object, which can be used to browse elements within the working set.
abstract WebFilter getFilter()
Returns a WebFilter object, which contains the contents of the base filter (also known as the report filter or working set filter) of the report.
abstract WebAttributeForms getForms(WebObjectInfo object)
Retrieve the forms of a particular object in the working set.
abstract String getFormula(WebMetric object)
Retrieves the formula of a particular derived metric in working set.
abstract WebExpression getLimitSummary(int flags)
Returns a summary containing the full limit expression which constrains the working set.
abstract WebExpression getMetricsLimit()
Returns the metrics limit, which is the limit on the metrics collection.
abstract WebObjectInfo getObject(String objectID, int objectType)
Returns a corresponding WebObjectInfo object in this working set.
abstract WebObjectInfo getObjectByName(String objectName, int objectType)
Returns a corresponding WebObjectInfo object in this working set.
abstract int getObjectDataType(WebObjectInfo obj)
Return the data type of a specific object, particularly for metrics.
abstract SimpleList getObjectFilter()
This method is deprecated. Use the findTypedObjects(int[]) instead.
abstract int getSortBy()
Returns the sort by item used while retrieving the working set objects.
abstract WebAttributeForms getTemplateForms(WebAttribute attribute)
Returns the template forms of the given attribute in the working set.
abstract WebExpression getUnitLimit(WebObjectInfo object)
Returns a WebExpression object describing the unit limit on the given object in the working set.
abstract WebAttributeForms getViewForms(WebAttribute attribute)
Returns the view forms of the given attribute in the working set.
abstract WebAttributeForms getWorkingSetForms(WebAttribute attribute)
Returns the working set forms of the given attribute in the working set.
abstract WebFolder getWorkingSetObjects(int blockBegin, int blockCount)
Returns the set of working set objects for the current report instance as a WebFolder object.
abstract WebFolder getWorkingSetObjects()
Returns the set of working set objects for the current report instance as a WebFolder object.
abstract String getXDATechnicalName(WebObjectInfo object)
abstract String getXdaDimensionId(WebObjectInfo oi)
abstract String getXdaHierarchyId(WebObjectInfo oi)
abstract boolean hasDerivedElements(WebObjectInfo obj)
abstract boolean hasViewFilterOn(WebObjectInfo objectInfo)
Returns whether the report view filter contains an qualification on specified object
abstract boolean isDerivedAttribute(WebAttribute object)
Returns whether a specific attribute is derived or not.
abstract boolean isDerivedMetric(WebMetric object)
Returns whether a specific metric in working set is derived or not.
abstract boolean isFormOnView(WebAttribute attribute, WebAttributeForm form)
Returns whether the given form is in the view forms of the given attribute.
abstract boolean isFormOnWorkingSet(WebAttribute attribute, WebAttributeForm form)
Returns whether the given form is in the working set forms of the given attribute.
abstract boolean isLockedAttribute(WebAttribute object)
Returns whether a specific attribute is locked for element browser.
abstract boolean isOnTemplate(WebObjectInfo object)
Returns whether the given working set object is currently on the template.
abstract boolean isPassThrough(WebObjectInfo object)
abstract boolean isSortAsc()
Returns whether the sort by will be ascending or descending.
abstract WebObjectInfo optObject(String objectID)
abstract WebReportInstance removeUnit(WebObjectInfo object)
Removes an object from the working set of the report.
abstract WebReportInstance removeUnit(WebObjectInfo object, boolean applyNow)
Removes an object from the working set of the report.
abstract void setSortAsc(boolean ascending)
Sets the sort by item to be either ascending or descending.
abstract void setSortBy(int field)
Sets the sort by item value.
abstract void setXdaInfo(WebObjectInfo oi, String xdaDimensionId, String xdaHierarchyId)

Public Methods

public abstract void add (WebObjectInfo object)

Adds the given object to the working set.

Parameters
object The object to add to the working set.
Throws
WebObjectsException Thrown if an error occurs in the operation.
UnsupportedOperationException Thrown if the I-Server does not support this operation (it is only supported in 7.2.3 or later).
IllegalArgumentException Thrown if the object is null or already exists in the working set.

public abstract boolean canAddMDXUnit (WebMDXDisplayUnit unit)

This method will tell whether the given MDX unit is acceptable to add to the report. This is provided because when editing an MDX-based report, it is possible that the report may have a restriction on whether units in different hierarchies of the same dimension are allowed on the report. If they are not, then this method can be used to determine whether the given object is eligible for addition to the report.

Parameters
unit The WebMDXDisplayUnit object to be checked.
Returns
  • Whether the object is legal to be added to the report or not. This will also apply to child objects - for example, if a hierarchy is passed, then if this returns false, all attributes of the hierarchy are forbidden.
Throws
WebObjectsException Thrown if an error occurs when retrieving information about the object.

public abstract String getAlias (WebObjectInfo object)

Returns the alias for an object which is in the working set folder.

Parameters
object A WebObjectInfo object which is in the working set folder.
Returns
  • The alias of the given object in the working set.
Throws
IllegalArgumentException Thrown if the given object is not in the working set.

public abstract WebAttributeForms getAllForms (WebAttribute attribute)

Returns all forms of the given attribute in the working set. This will only work on Intelligence Servers 7.2.2 or later.

Parameters
attribute The attribute to return the forms for.
Returns
Throws
IllegalArgumentException Thrown if the attribute is null or does not exist in the working set.
UnsupportedOperationException Thrown if the Intelligence Server does not support retrieval of all forms from the working set.

public abstract int getArity (WebAttribute object)

Returns arity of a specific attribute.

Parameters
object The WebAttribute object.
Returns
  • arity of a specific attribute
Throws
IllegalArgumentException

public abstract WebAttributeForms getBrowseFormsInWorkingSet (WebAttribute attribute)

This method returns the collection of the browse forms of the attribute which are available within the working set.

Parameters
attribute The attribute to get the forms for. This attribute must be in the working set.
Returns
  • the collection of the browse forms.
Throws
IllegalArgumentException Thrown if
UnsupportedOperationException Thrown if the Intelligence Server is earlier than 7.2.2.

public abstract WebDerivedElements getDerivedElements (WebAttribute attribute)

public abstract WebElementSource getElementSource ()

Returns a WebElementSource object, which can be used to browse elements within the working set.

Returns

public abstract WebFilter getFilter ()

Returns a WebFilter object, which contains the contents of the base filter (also known as the report filter or working set filter) of the report. This is equivalent to getFilter(true).

Returns
  • A WebFilter object which contains the filter information for this report instance.
Throws
WebObjectsException Indicates an inability to obtain the filter definition from the Intelligence Server.

public abstract WebAttributeForms getForms (WebObjectInfo object)

Retrieve the forms of a particular object in the working set.

Parameters
object The WebObjectInfo object which is in the working set folder.
Returns
  • the WebAttributeForms object which inclues all the forms for this object. When there is no form specified for this object, this object is an empty collection.
Throws
IllegalArgumentException Thrown if the object is not of type attribute, dimension or custom group, or this object is not in workingset.
UnsupportedOperationException Thrown if the object is of type dimension and custorm group, since currently we do not support them

public abstract String getFormula (WebMetric object)

Retrieves the formula of a particular derived metric in working set.

Parameters
object The WebMetric object which is in the working set folder.
Returns
  • The formula for this derived metric.
Throws
IllegalArgumentException Thrown if the object is null, or object is not in workingset, or object is not a derived metric.

public abstract WebExpression getLimitSummary (int flags)

Returns a summary containing the full limit expression which constrains the working set. This summary cannot be edited. This expression will be made up of the combination of the unit limits on each object in the working set, and the metrics limit on the metrics collection.

Parameters
flags Which limit summary to return, from EnumWebLimitSummaryFlags.
Returns
  • A summary containing the full limit expression, built using the unit limits and the metrics limit..
Throws
WebObjectsException

public abstract WebExpression getMetricsLimit ()

Returns the metrics limit, which is the limit on the metrics collection.

Returns
  • A WebExpression object representing the limit on the metrics collection.

public abstract WebObjectInfo getObject (String objectID, int objectType)

Returns a corresponding WebObjectInfo object in this working set. The returned WebObjectInfo object will be populated with the object's definition in this working set.

Parameters
objectID The DSS ID of the object.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
Returns
  • A WebObjectInfo object corresponding to a WebObjectInfo object in this working set, with the given DSS ID and type.
Throws
IllegalArgumentException Thrown if the object could not be found in this working set, or the parameter objectID is null.

public abstract WebObjectInfo getObjectByName (String objectName, int objectType)

Returns a corresponding WebObjectInfo object in this working set. The returned WebObjectInfo object will be populated with the object's definition in this working set.

Parameters
objectName The name of the object.
objectType The type of the object. This value comes from EnumDSSXMLObjectTypes.
Returns
  • A WebObjectInfo object corresponding to a WebObjectInfo object in this working set, with the given name and type.
Throws
IllegalArgumentException Thrown if the object could not be found in this working set, or the parameter objectName is null.

public abstract int getObjectDataType (WebObjectInfo obj)

Return the data type of a specific object, particularly for metrics.

Returns
Throws
IllegalArgumentException

public abstract SimpleList getObjectFilter ()

This method is deprecated.
Use the findTypedObjects(int[]) instead.

Returns a SimpleList object, which will allow Integer objects to be added to it. These Integers should correspond to values in EnumDSSXMLObjectTypes. If this list is nonempty when getWorkingSetObjects is called, the list of objects returned will be the objects from the working set which are of one of the types set on this object. Note that this filter is applied before incremental fetch is applied.

Returns
  • A SimpleList, which can be used to view, add, and remove items from the object filter.

public abstract int getSortBy ()

Returns the sort by item used while retrieving the working set objects. From EnumWebWorkingSetSortByField

Returns
  • the sort by item used.
See Also

public abstract WebAttributeForms getTemplateForms (WebAttribute attribute)

Returns the template forms of the given attribute in the working set.

Parameters
attribute The attribute to get the forms for. This attribute must be in the working set.
Returns
  • A WebAttributeForms collection containing the template forms of the attribute. If the Intelligence Server supports form editing, this collection will be read/write.
Throws
IllegalArgumentException Thrown if the attribute is not found in the working set, or if it is null.

public abstract WebExpression getUnitLimit (WebObjectInfo object)

Returns a WebExpression object describing the unit limit on the given object in the working set.

Parameters
object The working set object to retrieve the unit limit for.
Returns
  • A WebExpression object representing the unit limit on the object.

public abstract WebAttributeForms getViewForms (WebAttribute attribute)

Returns the view forms of the given attribute in the working set. This will only work on Intelligence Servers 7.2.2 and later.

Parameters
attribute The attribute to get the view forms for. This attribute must be in the working set.
Returns
Throws
IllegalArgumentException Thrown if the attribute is null or not found in the working set.
UnsupportedOperationException Thrown if the Intelligence Server does not support view form retrieval from the working set.

public abstract WebAttributeForms getWorkingSetForms (WebAttribute attribute)

Returns the working set forms of the given attribute in the working set.

Parameters
attribute The attribute to get the forms for. This attribute must be in the working set.
Returns
  • A WebAttributeForms collection containing the working set forms of the attribute. If the Intelligence Server supports form editing, this collection will be read/write.
Throws
IllegalArgumentException Thrown if the attribute is not found in the working set, or if it is null.

public abstract WebFolder getWorkingSetObjects (int blockBegin, int blockCount)

Returns the set of working set objects for the current report instance as a WebFolder object. If the object filter was set, then the objects returned will be only those objects in the working set which fit the filter criteria. Note that this method supports incremental fetch. The incremental fetch boundaries will be applied after applying the filter. If the sortBy parameter is set, then the list of objects in the folder will be sorted.

Parameters
blockBegin The first object in the working set collection to return.
blockCount The total number of objects to return from the working set collection.
Returns
  • A WebFolder object, containing the objects in this report's working set.
Throws
WebObjectsException Thrown if an error occurs in obtaining the working set objects.

public abstract WebFolder getWorkingSetObjects ()

Returns the set of working set objects for the current report instance as a WebFolder object. If the object filter was set, then the objects returned will be only those objects in the working set which fit the filter criteria. If the sortBy parameter is set, then the list of objects in the folder will be sorted.

Returns
  • A WebFolder object, containing the objects in this report's working set.
Throws
WebObjectsException Thrown if an error occurs in obtaining the working set objects.

public abstract String getXDATechnicalName (WebObjectInfo object)

public abstract String getXdaDimensionId (WebObjectInfo oi)

public abstract String getXdaHierarchyId (WebObjectInfo oi)

public abstract boolean hasDerivedElements (WebObjectInfo obj)

Throws
IllegalArgumentException
UnsupportedOperationException

public abstract boolean hasViewFilterOn (WebObjectInfo objectInfo)

Returns whether the report view filter contains an qualification on specified object

public abstract boolean isDerivedAttribute (WebAttribute object)

Returns whether a specific attribute is derived or not.

Parameters
object The WebAttribute object.
Returns
  • true if this attribute is derived, else returns false.
Throws
IllegalArgumentException Thrown if the object is null.

public abstract boolean isDerivedMetric (WebMetric object)

Returns whether a specific metric in working set is derived or not.

Parameters
object The WebMetric object which is in the working set folder.
Returns
  • true if this metric is derived metric, else returns false.
Throws
IllegalArgumentException Thrown if the object is null, or object is not in workingset.

public abstract boolean isFormOnView (WebAttribute attribute, WebAttributeForm form)

Returns whether the given form is in the view forms of the given attribute.

Parameters
attribute The attribute in the working set to check.
form The form to check for within the view forms.
Returns
  • Whether the given form is in the view forms of the given attribute. If the attribute or form is invalid, this method will return false.
Throws
UnsupportedOperationException Thrown if the Intelligence Server is earlier than 7.2.2.

public abstract boolean isFormOnWorkingSet (WebAttribute attribute, WebAttributeForm form)

Returns whether the given form is in the working set forms of the given attribute.

Parameters
attribute The attribute in the working set to check.
form The form to check for within the working set.
Returns
  • Whether the given form is in the working set forms of the given attribute. If the attribute or form is invalid, this method will return false.
Throws
UnsupportedOperationException Thrown if the Intelligence Server is earlier than 7.2.2.

public abstract boolean isLockedAttribute (WebAttribute object)

Returns whether a specific attribute is locked for element browser.

Parameters
object The WebAttribute object.
Returns
  • true if this attribute is locked, else returns false;
Throws
IllegalArgumentException

public abstract boolean isOnTemplate (WebObjectInfo object)

Returns whether the given working set object is currently on the template.

Parameters
object The WebObjectInfo object to search for on the template.
Returns
  • True if the object is found, false otherwise.

public abstract boolean isPassThrough (WebObjectInfo object)

public abstract boolean isSortAsc ()

Returns whether the sort by will be ascending or descending.

Returns
  • whether the sort by will be ascending or descending.

public abstract WebObjectInfo optObject (String objectID)

Throws
IllegalArgumentException

public abstract WebReportInstance removeUnit (WebObjectInfo object)

Removes an object from the working set of the report. This will also cause any other manipulations made to be applied to the report. Returns the resultant report instance.

Parameters
object A WebObjectInfo object referring to the object to remove from the working set of the report.
Returns
Throws
IllegalArgumentException Thrown if the input parameter is null, or input object does not represent an object in the workingset.
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract WebReportInstance removeUnit (WebObjectInfo object, boolean applyNow)

Removes an object from the working set of the report. The applyNow parameter will determine whether the changes will be applied immediately, or simply added to the string of manipulations on the report instance without sending the changes to the Intelligence Server. If the applyNow parameter is true, a new WebReportInstance object will be returned, which will refer to a report instance on the Intelligence Server with the requested changes. If the applyNow parameter is false, the report instance which owns the WebWorkingSet object will be returned. This object should already be held by the user, and thus should not be of any importance in this use case.

Parameters
object A WebObjectInfo object referring to the object to remove from the working set of the report.
applyNow Tells the API whether to apply the change now by sending all changes to the Intelligence Server or simply add the manipulation to the current report instance without applying the changes.
Returns
Throws
IllegalArgumentException Thrown if the input parameter is null, or input object does not represent an object in the workingset.
WebObjectsException Signals an error when sending the changes to the Intelligence Server.
WebReportValidationException Signals a report validation error from the Intelligence Server.

public abstract void setSortAsc (boolean ascending)

Sets the sort by item to be either ascending or descending.

Parameters
ascending Indicates whether the sort by is ascending or descending.

public abstract void setSortBy (int field)

Sets the sort by item value. From EnumWebWorkingSetSortByField

Parameters
field The value of the sort by item.
See Also

public abstract void setXdaInfo (WebObjectInfo oi, String xdaDimensionId, String xdaHierarchyId)