public interface

RWDataSets

com.microstrategy.web.objects.rw.RWDataSets

Class Overview

Represents a collection of document data sets

Summary

Public Methods
abstract boolean canRemove(String id)
Returns true if dataset with specified ID exists and there is no any fields referring to this data set
abstract void clear()
Removes all data sets from the collection
abstract boolean containsKey(String key)
Returns true if data set with specified key exists in the collection
abstract RWDataSet get(int i)
Returns i-th data set
abstract KeyedList<RWDataSetItem> getAllItems()
abstract RWUserAttributes getAllUserAttributes()
Returns a collection of user attributes from all data sets.
abstract RWUserDEObjects getAllUserDEObjects()
abstract RWUserMetrics getAllUserMetrics()
Returns a collection of user metrics from all data sets.
abstract RWDataSet getByKey(String key)
Returns data set with specified key
abstract RWDataSet getDefault()
Returns the default RWDataSet.
abstract String getItemAlias(String objectID)
Returns the alias of object
abstract RWDataSet getJoinedDataSet()
Returns a virtual data set representing a join of all document data sets
abstract RWDataSet remove(String _id)
Removes data set from the collection
abstract RWDataSet remove(String _id, boolean _enforce)
Removes data set from the collection.
abstract RWDataSet setDefault(String id)
Makes specified data set a default one.
abstract int size()
Returns a number of data sets in the collections

Public Methods

public abstract boolean canRemove (String id)

Returns true if dataset with specified ID exists and there is no any fields referring to this data set

Parameters
id data set ID
Returns
  • true if dataset with specified ID exists and there is no any fields referring to this data set
Throws
IllegalArgumentException if collection does not contain dataset with specified ID

public abstract void clear ()

Removes all data sets from the collection

public abstract boolean containsKey (String key)

Returns true if data set with specified key exists in the collection

Parameters
key data set key
Returns
  • true if data set with specified key exists in the collection

public abstract RWDataSet get (int i)

Returns i-th data set

Parameters
i index
Returns
  • data set

public abstract KeyedList<RWDataSetItem> getAllItems ()

Throws
WebObjectsException

public abstract RWUserAttributes getAllUserAttributes ()

Returns a collection of user attributes from all data sets.

Returns
  • a collection of user attributes from all data sets.
Throws
WebObjectsException

public abstract RWUserDEObjects getAllUserDEObjects ()

Throws
WebObjectsException

public abstract RWUserMetrics getAllUserMetrics ()

Returns a collection of user metrics from all data sets.

Returns
  • a collection of user metrics from all data sets.
Throws
WebObjectsException

public abstract RWDataSet getByKey (String key)

Returns data set with specified key

Parameters
key data set key
Returns
  • data set with specified key

public abstract RWDataSet getDefault ()

Returns the default RWDataSet. Null if none are available.

public abstract String getItemAlias (String objectID)

Returns the alias of object

Parameters
objectID the ID of object
Returns
  • the alias of object
Throws
WebObjectsException

public abstract RWDataSet getJoinedDataSet ()

Returns a virtual data set representing a join of all document data sets

Returns
  • a virtual data set representing a join of all document data sets

public abstract RWDataSet remove (String _id)

Removes data set from the collection

Parameters
_id data set ID
Returns
  • removed data set object or null if collection does not contain dataset with specified ID
Throws
WebObjectsException

public abstract RWDataSet remove (String _id, boolean _enforce)

Removes data set from the collection. If the _enforce flag is true the data set will be removed even if there are some fields referring to this data set. In this case all fields referring to this data set will be removed too. If the _enforce flag is false then the WebObjectsException will be thrown if ther are fields referring to this data set

Parameters
_id data set ID
_enforce flag indicating whether to remove data set if there are fields referring to it.
Returns
  • removed data set object or null if collection does not contain dataset with specified ID
Throws
WebObjectsException if there are fields referring to this data set and _enforce flag is false.

public abstract RWDataSet setDefault (String id)

Makes specified data set a default one.

Parameters
id new default data set ID
Returns
  • new default data set.

public abstract int size ()

Returns a number of data sets in the collections

Returns
  • a number of data sets in the collections