public interface

WebProjectReferences

com.microstrategy.web.objects.WebProjectReferences

Class Overview

The WebProjectReferences interface represents the collection of project references registered with a server definition(WebServerDef) object. This interface can be used to add, remove, view, and modify the collection of project references.

Summary

Public Methods
abstract WebProjectReference add(WebProjectInstance projectInst)
Adds the given project instance to the list of projects registered to the server definition.
abstract Enumeration elements()
Returns a java.util.Enumeration object containing the items in the collection.
abstract WebProjectReference get(int i)
Returns the item in the collection with the given index.
abstract boolean isEmpty()
Returns whether the collection is empty.
abstract WebProjectReference itemByID(String id)
Returns the WebProjectReference object in the collection with the given project ID.
abstract WebProjectReference itemByName(String name)
Returns the item in the collection with the given name, if one exists.
abstract void remove(WebProjectReference projectRef)
Removes the given WebProjectReference object from the collection.
abstract int size()
Returns the number of items in the collection.

Public Methods

public abstract WebProjectReference add (WebProjectInstance projectInst)

Adds the given project instance to the list of projects registered to the server definition.

Parameters
projectInst The WebProjectInstance object to add to the collection. This object should come from one of the methods on the WebProjectSource interface.
Returns

public abstract Enumeration elements ()

Returns a java.util.Enumeration object containing the items in the collection.

Returns
  • A java.util.Enumeration containing the items in the collection.

public abstract WebProjectReference get (int i)

Returns the item in the collection with the given index.

Parameters
i The 0-based index of the item in the collection to return.
Returns
Throws
IndexOutOfBoundsException Thrown if the index does not exist in the collection.

public abstract boolean isEmpty ()

Returns whether the collection is empty.

Returns
  • True if the collection is empty, false otherwise.

public abstract WebProjectReference itemByID (String id)

Returns the WebProjectReference object in the collection with the given project ID.

Parameters
id The ID of the project to search for in the collection.
Returns
Throws
IllegalArgumentException Thrown if no object exists in the collection with the given ID.

public abstract WebProjectReference itemByName (String name)

Returns the item in the collection with the given name, if one exists.

Parameters
name The name of the project reference to return.
Returns
Throws
IllegalArgumentException Thrown if the given name does not exist in the collection.

public abstract void remove (WebProjectReference projectRef)

Removes the given WebProjectReference object from the collection. When saving the object, this will cause the given project to no longer be registered with the server definition object.

Parameters
projectRef The WebProjectReference object to remove from the collection.

public abstract int size ()

Returns the number of items in the collection.

Returns
  • The size of the collection.