com.businessobjects.sdk.lcm

Class ObjectBrowser

java.lang.Object

com.businessobjects.sdk.lcm.ObjectBrowser

public class ObjectBrowser
extends Object

Browser offering resource selection for selective scenario

See Also:

package description

Method Summary

Modifier and Type	Method and Description
ObjectBrowser	addCuids(Collection<String> cuids) Adds all objects identified by specified cuid(s) as primary resources.
ObjectBrowser	addCuids(String... cuids) Adds all objects identified by specified cuid(s) as primary resources.
ObjectBrowser	addObjects(Collection<IInfoObject> objects) Adds all specified objects as primary resources.
ObjectBrowser	addObjects(IInfoObject... objects) Adds all specified objects as primary resources.
ObjectBrowser	addQuery(ObjectMatcher matcher) Adds all objects denoted by specified matcher as primary resources.
ObjectBrowser	addQuery(String query) Adds all objects returned by specified query as primary resources.
ObjectBrowser	clear() Clears all previously selected resources.
ObjectBrowser	computeDependencies() Requests for dependency computation for current set of primary resources.
ObjectBrowser	computeSecurityDependencies() Requests for security dependency computation for current set of primary resources.
Collection<String>	getCuids() Returns all previously selected resources by their cuid.
Map<IInfoObject,Set<IInfoObject>>	getDependencies() Returns forward dependencies for each and every current primary resource.
Set<IInfoObject>	getDependencies(IInfoObject primary) Returns forward dependencies for given primary resource.
Map<IInfoObject,Set<IInfoObject>>	getReverseDependencies() Returns backward dependencies for each and every current dependent resource.
ObjectBrowser	removeCuids(Collection<String> cuids) Removes objects of given cuids from current set of primary resources.
ObjectBrowser	removeCuids(String... cuids) Removes objects of given cuids from current set of primary resources.
ObjectBrowser	removeObject(IInfoObject obj) Removes given object from current set of primary resources.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCuids

public Collection<String> getCuids()
                            throws com.businessobjects.lcm.utilities.LCMException

Returns all previously selected resources by their cuid.

Returns:

selected resources as a read-only collection

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

clear

public ObjectBrowser clear()

Clears all previously selected resources.

Returns:

current browser

addQuery

public ObjectBrowser addQuery(String query)
                       throws SDKException

Adds all objects returned by specified query as primary resources.

Parameters:

query - query defining objects to be added

Returns:

current browser

Throws:

SDKException - in case of error

addCuids

public ObjectBrowser addCuids(String... cuids)

Adds all objects identified by specified cuid(s) as primary resources.

Parameters:

cuids - cuid list to be added

Returns:

current browser

addCuids

public ObjectBrowser addCuids(Collection<String> cuids)

Adds all objects identified by specified cuid(s) as primary resources.

Parameters:

cuids - cuid collection to be added

Returns:

current browser

addObjects

public ObjectBrowser addObjects(IInfoObject... objects)
                         throws SDKException

Adds all specified objects as primary resources.

Parameters:

objects - object list to be added

Returns:

current browser

Throws:

SDKException - in case of error

addObjects

public ObjectBrowser addObjects(Collection<IInfoObject> objects)
                         throws SDKException

Adds all specified objects as primary resources.

Parameters:

objects - object collection to be added

Returns:

current browser

Throws:

SDKException - in case of error

computeDependencies

public ObjectBrowser computeDependencies()
                                  throws com.businessobjects.lcm.utilities.LCMException,
                                         SDKException

Requests for dependency computation for current set of primary resources.

Computed dependencies are not added automatically to selected resources.
Note that this task is time consuming. After an initial call dependencies are valid as long as primary resources are not modified.

Returns:

current browser

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

SDKException - in case of error

computeSecurityDependencies

public ObjectBrowser computeSecurityDependencies()
                                          throws com.businessobjects.lcm.utilities.LCMException,
                                                 SDKException

Requests for security dependency computation for current set of primary resources.

Computed security dependencies are not added automatically to selected resources.
Note that this task is time consuming. After an initial call dependencies are valid as long as primary resources are not modified.

Returns:

current browser

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

SDKException - in case of error

getDependencies

public Set<IInfoObject> getDependencies(IInfoObject primary)
                                 throws com.businessobjects.lcm.utilities.LCMException,
                                        SDKException

Returns forward dependencies for given primary resource.

Note that computeDependencies() must have been called before.

Parameters:

primary - object whose dependencies are to be computed

Returns:

a set of object given primary depends on

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

SDKException - in case of error

getDependencies

public Map<IInfoObject,Set<IInfoObject>> getDependencies()
                                                  throws com.businessobjects.lcm.utilities.LCMException,
                                                         SDKException

Returns forward dependencies for each and every current primary resource.

Note that computeDependencies() must have been called before.

Returns:

a map whose keys are primary resources and values their corresponding dependencies

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

SDKException - in case of error

getReverseDependencies

public Map<IInfoObject,Set<IInfoObject>> getReverseDependencies()
                                                         throws com.businessobjects.lcm.utilities.LCMException,
                                                                SDKException

Returns backward dependencies for each and every current dependent resource.

In others words indicates by who a dependency is required. Note that computeDependencies() must have been called before.

Returns:

a map whose keys are dependent resources and values their originating primaries

Throws:

com.businessobjects.lcm.utilities.LCMException - in case of error

SDKException - in case of error

addQuery

public ObjectBrowser addQuery(ObjectMatcher matcher)
                       throws SDKException

Adds all objects denoted by specified matcher as primary resources.

Parameters:

matcher - matcher defining objects to be added

Returns:

current browser

Throws:

SDKException - in case of error

removeObject

public ObjectBrowser removeObject(IInfoObject obj)
                           throws SDKException

Removes given object from current set of primary resources.

Parameters:

obj - object to be removed

Returns:

current browser

Throws:

SDKException - in case of error

removeCuids

public ObjectBrowser removeCuids(String... cuids)

Removes objects of given cuids from current set of primary resources.

Parameters:

cuids - list of object cuids to be removed

Returns:

current browser

removeCuids

public ObjectBrowser removeCuids(Collection<String> cuids)

Removes objects of given cuids from current set of primary resources.

Parameters:

cuids - collection of object cuids to be removed

Returns:

current browser