Package com.microstrategy.web.objects

Interface WebProjectInstances

public interface WebProjectInstances

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

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int[]	STATUS_ACTIVE_EXECIDLE

Method Summary

Modifier and Type	Method	Description
java.util.Enumeration<WebProjectInstance>	elements()	Returns an Enumeration which can be used to step through the collection of WebProjectInstance objects.
WebProjectInstances	find(int[] status)
WebProjectInstance	get(int index)	Returns the project with the given index from the collection.
boolean	isEmpty()	Returns true if the collection is empty, false if it contains one or more projects.
WebProjectInstance	itemByDSSID(java.lang.String dssId)
WebProjectInstance	itemByID(int projectID)	Returns the WebProjectInstance object with the given project ID.
WebProjectInstance	itemByName(java.lang.String projectName)	Returns the WebProjectInstance object with the given name.
WebProjectInstance	itemByName(java.lang.String projectName, boolean ignoreCase)	Returns the WebProjectInstance object with the given name
int	size()	Returns the number of projects within the collection.

Field Detail

STATUS_ACTIVE_EXECIDLE

static final int[] STATUS_ACTIVE_EXECIDLE

Since:

MicroStrategy Web 9.0.0

Method Detail

size

int size()

Returns the number of projects within the collection.

Returns:

The size of the project collection.

isEmpty

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.

get

WebProjectInstance get(int index)
                throws java.lang.IndexOutOfBoundsException

Returns the project with the given index from the collection.

Returns:

A WebProjectInstance object contained at the given index in the collection.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the index could not be found in the collection.

elements

java.util.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.

itemByID

WebProjectInstance itemByID(int projectID)
                     throws java.lang.IllegalArgumentException

Returns the WebProjectInstance object with the given project ID.

Parameters:

projectID - The ID of the project according to the Intelligence Server.

Returns:

A WebProjectInstance object corresponding to the given project ID.

Throws:

java.lang.IllegalArgumentException - Thrown if no project identified by the given ID exists.

itemByName

WebProjectInstance itemByName(java.lang.String projectName)
                       throws java.lang.IllegalArgumentException

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:

A WebProjectInstance object corresponding to the given project name.

Throws:

java.lang.IllegalArgumentException - Thrown if no project identified by the given name exists.

itemByDSSID

WebProjectInstance itemByDSSID(java.lang.String dssId)
                        throws java.lang.IllegalArgumentException

Parameters:

dssId - the DSS ID of the project.

Returns:

the project with the given DSS ID.

Throws:

java.lang.IllegalArgumentException - thrown if no project could be found by the given DSS ID.

Since:

MicroStrategy Web 9.0.0

find

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.

Since:

MicroStrategy Web 9.0.0

itemByName

WebProjectInstance itemByName(java.lang.String projectName,
                              boolean ignoreCase)
                       throws java.lang.IllegalArgumentException

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:

WebProjectInstance object representing the project with the name provided

Throws:

java.lang.IllegalArgumentException

Since:

MicroStrategy Web 9.0.0