Package com.microstrategy.web.objects.rw

Interface RWDataSets

public interface RWDataSets

Represents a collection of document data sets

Since:

MicroStrategy Web 8.0.0

Method Summary

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

Method Detail

size

int size()

Returns a number of data sets in the collections

Returns:

a number of data sets in the collections

get

RWDataSet get(int i)

Returns i-th data set

Parameters:

i - index

Returns:

data set

getByKey

RWDataSet getByKey(java.lang.String key)

Returns data set with specified key

Parameters:

key - data set key

Returns:

data set with specified key

containsKey

boolean containsKey(java.lang.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

canRemove

boolean canRemove(java.lang.String id)
           throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - if collection does not contain dataset with specified ID

remove

RWDataSet remove(java.lang.String _id)
          throws WebObjectsException

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

remove

RWDataSet remove(java.lang.String _id,
                 boolean _enforce)
          throws WebObjectsException

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.

clear

void clear()

Removes all data sets from the collection

getDefault

RWDataSet getDefault()

Returns the default RWDataSet. Null if none are available.

setDefault

RWDataSet setDefault(java.lang.String id)

Makes specified data set a default one.

Parameters:

id - new default data set ID

Returns:

new default data set.

getAllItems

KeyedList<RWDataSetItem> getAllItems()
                              throws WebObjectsException

Throws:

WebObjectsException

getAllUserMetrics

RWUserMetrics getAllUserMetrics()
                         throws WebObjectsException

Returns a collection of user metrics from all data sets.

Returns:

a collection of user metrics from all data sets.

Throws:

WebObjectsException

getJoinedDataSet

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

getAllUserAttributes

RWUserAttributes getAllUserAttributes()
                               throws WebObjectsException

Returns a collection of user attributes from all data sets.

Returns:

a collection of user attributes from all data sets.

Throws:

WebObjectsException

getAllUserDEObjects

RWUserDEObjects getAllUserDEObjects()
                             throws WebObjectsException

Throws:

WebObjectsException

getItemAlias

java.lang.String getItemAlias(java.lang.String objectID)
                       throws WebObjectsException

Returns the alias of object

Parameters:

objectID - the ID of object

Returns:

the alias of object

Throws:

WebObjectsException