public interface

WebProjectInstances

com.microstrategy.web.objects.WebProjectInstances

Class Overview

The WebProjectInstances class represents a set of projects which are contained on an Intelligence Server. It consists of a collection of WebProjectInstance objects.

Summary

Fields
public static final int[] STATUS_ACTIVE_EXECIDLE
Public Methods
abstract Enumeration<WebProjectInstance> elements()
Returns an Enumeration which can be used to step through the collection of WebProjectInstance objects.
abstract WebProjectInstances find(int[] status)
abstract WebProjectInstance get(int index)
Returns the project with the given index from the collection.
abstract boolean isEmpty()
Returns true if the collection is empty, false if it contains one or more projects.
abstract WebProjectInstance itemByDSSID(String dssId)
abstract WebProjectInstance itemByID(int projectID)
Returns the WebProjectInstance object with the given project ID.
abstract WebProjectInstance itemByName(String projectName, boolean ignoreCase)
Returns the WebProjectInstance object with the given name
abstract WebProjectInstance itemByName(String projectName)
Returns the WebProjectInstance object with the given name.
abstract int size()
Returns the number of projects within the collection.

Fields

public static final int[] STATUS_ACTIVE_EXECIDLE

Public Methods

public abstract Enumeration<WebProjectInstance> elements ()

Returns an Enumeration which can be used to step through the collection of WebProjectInstance objects.

Returns
  • A java.util.Enumeration which can be used to iterate through the collection.

public abstract WebProjectInstances find (int[] status)

Parameters
status array of EnumDSSXMLProjectStatus to filter by.
Returns
  • a new WebProjectInstances collection containing only projects with the given status values.

public abstract WebProjectInstance get (int index)

Returns the project with the given index from the collection.

Returns
Throws
IndexOutOfBoundsException Thrown if the index could not be found in the collection.

public abstract boolean isEmpty ()

Returns true if the collection is empty, false if it contains one or more projects.

Returns
  • A boolean value indicating whether the collection is empty.

public abstract WebProjectInstance itemByDSSID (String dssId)

Parameters
dssId the DSS ID of the project.
Returns
  • the project with the given DSS ID.
Throws
IllegalArgumentException thrown if no project could be found by the given DSS ID.

public abstract WebProjectInstance itemByID (int projectID)

Returns the WebProjectInstance object with the given project ID.

Parameters
projectID The ID of the project according to the Intelligence Server.
Returns
Throws
IllegalArgumentException Thrown if no project identified by the given ID exists.

public abstract WebProjectInstance itemByName (String projectName, boolean ignoreCase)

Returns the WebProjectInstance object with the given name

Parameters
projectName String containing name of project to be returned
ignoreCase boolean indicating whether the case should be ignored when matching the name of the project instance
Returns
Throws
IllegalArgumentException
IllegalArgumentException

public abstract WebProjectInstance itemByName (String projectName)

Returns the WebProjectInstance object with the given name. Project name must match provided name exactly. Case is not ignored

Parameters
projectName The name of the project to be returned.
Returns
Throws
IllegalArgumentException Thrown if no project identified by the given name exists.

public abstract int size ()

Returns the number of projects within the collection.

Returns
  • The size of the project collection.