com.businessobjects.sdk.plugin.desktop.universe
Interface IUniverseBase

All Known Subinterfaces:

IUniverse

public interface IUniverseBase

This interface contains methods that allow you to manage universe metrics.

The information that you can retrieve through this interface includes database connection parameters, universe relationship structure, and principal (user and user group) rights.

Method Summary

void	applyOverload(IInfoObject overloadObj, int principalID, boolean isGrant)
java.lang.String	buildUniverseIdString()
IInfoObject	computeAggregatedOverload(int principalID, IInfoObjects noOrderOverloads, boolean bUseExplicitRights)
IInfoObject	getAggregatedOverload(int principalID)
boolean	getAndOrOption()
java.util.Set	getCoreUniverses() Returns the core universes that are assigned to this universe object.
java.util.Set	getDataConnections() Returns the data connections assigned to this universe object.
java.util.Set	getDerivedUniverses() Returns the derived universes that are assigned to this universe object.
int	getLockerID() Returns the locker ID for this universe object.
int	getRevisionNumber() Returns the revision number that is assigned to this universe object.
java.lang.String	getShortName()
java.util.Set	getUserGroupOrderedIDs()
java.util.Set	getWebis() Returns a collection of identifiers that represent Web Intelligence documents that are assigned to this universe object.
void	setLockerID(int lockerID) Sets the locker ID for this universe object.
void	setRevisionNumber(int revNum) Sets the revision number that is assigned to this universe object.
void	setShortName(java.lang.String shortName)

Method Detail

getWebis

java.util.Set getWebis()
                       throws SDKException

Returns a collection of identifiers that represent Web Intelligence documents that are assigned to this universe object.

Returns:

A set of IDs that correspond to the Web Intelligence documents that belong to this universe.

Throws:

SDKException - Throws exception if property is not found

getDerivedUniverses

java.util.Set getDerivedUniverses()
                                  throws SDKException

Returns the derived universes that are assigned to this universe object.

A derived universe inherits objects and classes from core universes. For more information on universes, see the BusinessObjects Designer's Guide.

Note:A universe can be defined from one or more universes.

Returns:

A set of IDs that correspond to the derived universes that belong to this universe object.

Throws:

SDKException - Throws exception if property is not found

getDataConnections

java.util.Set getDataConnections()
                                 throws SDKException

Returns the data connections assigned to this universe object.

Returns:

A set of IDs that represent the data connections assigned to this universe.

Throws:

SDKException - Throws exception if property is not found

getCoreUniverses

java.util.Set getCoreUniverses()
                               throws SDKException

Returns the core universes that are assigned to this universe object.

A core universe is the building block, or base, for a derived universe. For more information on universes, see the BusinessObjects Designer's Guide.

Note:A universe can be defined from one or more universes.

Returns:

A set of IDs that represent the core universes that belong to this universe object.

Throws:

SDKException - Throws exception if property is not found

getUserGroupOrderedIDs

java.util.Set getUserGroupOrderedIDs()
                                     throws SDKException

Throws:

SDKException

getAggregatedOverload

IInfoObject getAggregatedOverload(int principalID)
                                  throws SDKException

Throws:

SDKException

applyOverload

void applyOverload(IInfoObject overloadObj,
                   int principalID,
                   boolean isGrant)
                   throws SDKException

Throws:

SDKException

getRevisionNumber

int getRevisionNumber()
                      throws SDKException

Returns the revision number that is assigned to this universe object.

The revision number indicates the amount of times a universe has been exported to a universe domain.

Returns:

An int that indicates the revision number.

Throws:

SDKException - Throws exception if property is not found

setRevisionNumber

void setRevisionNumber(int revNum)

Sets the revision number that is assigned to this universe object.

The revision number indicates the amount of times a universe has been exported to a universe domain.

Parameters:

revNum - An int that represents the revision number.

getLockerID

int getLockerID()
                throws SDKException

Returns the locker ID for this universe object.

Identifies the ID of the user who has locked the universe.

Returns:

An int that represents the ID of the user who has locked this universe. If the value is 0 is returned the universe has not been locked.

Throws:

SDKException - Throws exception if property is not found

setLockerID

void setLockerID(int lockerID)

Sets the locker ID for this universe object.

Identifies the ID of the user who has locked the universe.

Parameters:

lockerID - An int that specifies the ID of the user who has locked the universe. 0 specifies that the universe is not locked.

getShortName

java.lang.String getShortName()
                              throws SDKException

Throws:

SDKException

setShortName

void setShortName(java.lang.String shortName)

getAndOrOption

boolean getAndOrOption()

computeAggregatedOverload

IInfoObject computeAggregatedOverload(int principalID,
                                      IInfoObjects noOrderOverloads,
                                      boolean bUseExplicitRights)
                                      throws SDKException

Throws:

SDKException

buildUniverseIdString

java.lang.String buildUniverseIdString()
                                       throws SDKException

Throws:

SDKException