com.businessobjects.sdk.lcm

Class Host

java.lang.Object

com.businessobjects.sdk.lcm.Host

public class Host
extends Object

Host on which Promotion Management scenario are run

See Also:

package description

Method Summary

Modifier and Type	Method and Description
RunResult	getScenarioResult(String scheduledCuid) Computes result of scheduled scenario denoted by given cuid.
SchedulingStatus	getScenarioStatus(String scheduledCuid) Computes current status of scheduled scenario denoted by given cuid.
IEnterpriseSession	getSession() Returns session to current host.
ExportScenario	newExportScenario(String name) Creates a fresh export scenario of given name.
ImportScenario	newImportScenario(String name) Creates a fresh import scenario whose name is retrieved from source archive and possibly overridden by supplied name if provided.
PromoteScenario	newPromoteScenario(String name) Creates a fresh promote scenario of given name.
void	release() Releases all resources acquired by this host.
static void	setLocale(Locale locale) Overrides current locale.
Host	setProgressMonitor(IProgressMonitor progress) Sets current progress monitor.

Methods inherited from class java.lang.Object

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

Method Detail

newExportScenario

public ExportScenario newExportScenario(String name)
                                 throws com.businessobjects.lcm.utilities.LCMException,
                                        SDKException

Creates a fresh export scenario of given name.

Parameters:

name - scenario name

Returns:

a new scenario instance

Throws:

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

SDKException - in case of error

newPromoteScenario

public PromoteScenario newPromoteScenario(String name)
                                   throws com.businessobjects.lcm.utilities.LCMException,
                                          SDKException

Creates a fresh promote scenario of given name.

Parameters:

name - scenario name

Returns:

a new scenario instance

Throws:

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

SDKException - in case of error

newImportScenario

public ImportScenario newImportScenario(String name)
                                 throws com.businessobjects.lcm.utilities.LCMException,
                                        SDKException

Creates a fresh import scenario whose name is retrieved from source archive and possibly overridden by supplied name if provided.

Parameters:

name - scenario name or null

Returns:

a new scenario instance

Throws:

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

SDKException - in case of error

release

public void release()
             throws com.businessobjects.lcm.utilities.LCMException,
                    SDKException

Releases all resources acquired by this host.

Host and all its derived scenario are no longer valid after this call.

Throws:

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

SDKException - in case of error

setLocale

public static void setLocale(Locale locale)

Overrides current locale.

Parameters:

locale - new locale to be set

getSession

public IEnterpriseSession getSession()

Returns session to current host.

Returns:

a session instance

setProgressMonitor

public Host setProgressMonitor(IProgressMonitor progress)

Sets current progress monitor.

Parameters:

progress - monitor to be used

Returns:

current host

getScenarioStatus

public SchedulingStatus getScenarioStatus(String scheduledCuid)
                                   throws com.businessobjects.lcm.utilities.LCMException,
                                          SDKException

Computes current status of scheduled scenario denoted by given cuid.

Returned result is a snapshot only valid at request time; in particular process does not wait for scenario completion.

Parameters:

scheduledCuid - job cuid - this argument has been typically retrieved from schedule(...) command

Returns:

a scheduling status

Throws:

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

SDKException - in case of error

getScenarioResult

public RunResult getScenarioResult(String scheduledCuid)
                            throws com.businessobjects.lcm.utilities.LCMException,
                                   SDKException

Computes result of scheduled scenario denoted by given cuid.

Returned result is a snapshot only valid at request time. Process does not wait for scenario completion. Scenario completion may be verified through the getScenarioStatus(String) and SchedulingStatus.isComplete() commands.

Note that run result is meaningless for export scenario as no resources are actually committed.

Parameters:

scheduledCuid - job cuid - this argument has been typically retrieved from schedule(...) command

Returns:

computed run result or null if result is not yet available (when scenario is not complete)

Throws:

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

SDKException - in case of error