org.olat.core.id.context
Interface BusinessControl

All Known Implementing Classes:

StackedBusinessControl

public interface BusinessControl

Description:
use for e.g. a key to store stuff, and to get a context for the search engine, to later open the correct navigational paths.

the business control is a immutable object.

usage:

    final ores = ... (a OLATResourceable)
    ContextEntry ce = new ContextEntry() {
                        public OLATResourceable getOLATResourceable() {
                                return ores;
                        }};
                WindowControl bwControl = BusinessControlFactory.getInstance().createBusinessWindowControl(ce, wControl);
 

Initial Date: 14.06.2006

Author:

Felix Jost

Field Summary

static java.lang.String	DELIMITER_TAG
static java.lang.String	END_TAG
static java.lang.String	START_TAG

Method Summary

void	dropLauncherEntries() used when the current contextentry cannot be resolved (e.g.
java.lang.String	getAsString() Get String represation of BusinessControl.
boolean	hasContextEntry() if still some more context entries for spawning are available
ContextEntry	popLauncherContextEntry() pop context entry for further processing, this is used for spawning controllers
void	setCurrentContextEntry(ContextEntry cw) set new context entry which reflects latest state of a controller, which can be reactivated

Field Detail

START_TAG

static final java.lang.String START_TAG

See Also:

Constant Field Values

END_TAG

static final java.lang.String END_TAG

See Also:

Constant Field Values

DELIMITER_TAG

static final java.lang.String DELIMITER_TAG

See Also:

Constant Field Values

Method Detail

getAsString

java.lang.String getAsString()

Get String represation of BusinessControl. Used to save it as string (serializing)

Returns:

popLauncherContextEntry

ContextEntry popLauncherContextEntry()

pop context entry for further processing, this is used for spawning controllers

Returns:

setCurrentContextEntry

void setCurrentContextEntry(ContextEntry cw)

set new context entry which reflects latest state of a controller, which can be reactivated

Parameters:

cw -

dropLauncherEntries

void dropLauncherEntries()

used when the current contextentry cannot be resolved (e.g. a coursenode that no longer is accessible or existing)

hasContextEntry

boolean hasContextEntry()

if still some more context entries for spawning are available

Returns: