public interface

WebProjectSettingsGroup

com.microstrategy.web.objects.WebProjectSettingsGroup

Class Overview

WebProjectSettingsGroup is a group of WebProjectSettings collections. This is designed to contain all the project settings for a given setting type and therefore there will most likely be an instantiation for each type of project setting. As such, there will not be a single enumeration to account for all values possible valid parameters to the getItemByModuleID(int) method

Summary

Public Methods
abstract boolean contains(int id)
Returns whether an item with the given ID exists in the collection.
abstract WebProjectSettingsModule get(int i)
Returns the setting collection at the given index in the collection.
abstract WebProjectSettingsModule getItemByModuleID(int id)
Returns the settings collection with the given id.
abstract int size()
Returns the number of settings collections in the collection.

Public Methods

public abstract boolean contains (int id)

Returns whether an item with the given ID exists in the collection.

Parameters
id The ID of the item to search for
Returns
  • True if the ID exists in the group, false if not.

public abstract WebProjectSettingsModule get (int i)

Returns the setting collection at the given index in the collection. Note that the setting collections are not ordered in any way.

Parameters
i The index of the object to return.
Returns

public abstract WebProjectSettingsModule getItemByModuleID (int id)

Returns the settings collection with the given id. The ID comes from whichever enumeration is associated with the settings type this group is used for

Parameters
id The ID of the item to return from the collection.
Returns
Throws
IllegalArgumentException Thrown if no item with the given ID exists in the collection.

public abstract int size ()

Returns the number of settings collections in the collection.

Returns
  • The number of settings collections in the collection.