com.sapportals.wcm.service.reporting

Interface IScopeController

public interface IScopeController

Controls user selection of resource identifiers as scope intput to report execution.

Copyright (c) SAP AG 2004

Nested Class Summary

static interface

IScopeController.IScopeEntry A scope list entry.

Field Summary

static int	SCOPE_MODE_ANY
static int	SCOPE_MODE_LIST
static int	SCOPE_MODE_NONE

Method Summary

RID	getBrowseLocation() In case this controller has scope mode SCOPE_MODE_ANY, returns the best starting location for browsing resources.
String	getScopeLabel() Get a label suitable for user interfaces, for the scope list.
List	getScopeList() In case this controller has scope mode SCOPE_MODE_LIST, returns the list of available scopes as list of IScopeController.IScopeEntrys.
int	getScopeMode() Gives the scope mode of this controller.
boolean	prefersSingleSelection() Gives preference whether single or mutiple scopes should be selected as input to a report.

Field Detail

SCOPE_MODE_NONE

public static final int SCOPE_MODE_NONE

See Also:

Constant Field Values

SCOPE_MODE_ANY

public static final int SCOPE_MODE_ANY

See Also:

Constant Field Values

SCOPE_MODE_LIST

public static final int SCOPE_MODE_LIST

See Also:

Constant Field Values

Method Detail

getScopeMode

public int getScopeMode()

Gives the scope mode of this controller. The following modes are defined:

• SCOPE_MODE_NONE: when the report operates independant of scope information.
• SCOPE_MODE_ANY: when the report operates, in principle, on any resource.
• SCOPE_MODE_LIST: when the report operates on a defined set of resources.

Returns:

scope mode of this controller

prefersSingleSelection

public boolean prefersSingleSelection()

Gives preference whether single or mutiple scopes should be selected as input to a report. A report must always be prepared to handle input with more than one RID. For certain reports however, selecting a single resource may be the prefered way of operation.

Returns:

if single scope selections are prefered

getScopeList

public List getScopeList()
                  throws ResourceException

In case this controller has scope mode SCOPE_MODE_LIST, returns the list of available scopes as list of IScopeController.IScopeEntrys. The list may contain each RID only once in a IScopeController.IScopeEntry.

For all other scope modes, the list may be null

Returns:

list of IScopeController.IScopeEntrys

Throws:

ResourceException - on failure to retrieve entry list

getScopeLabel

public String getScopeLabel()

Get a label suitable for user interfaces, for the scope list. If no label is available, null may be returned.

Returns:

label for scope list or null if none available.

getBrowseLocation

public RID getBrowseLocation()
                      throws ResourceException

In case this controller has scope mode SCOPE_MODE_ANY, returns the best starting location for browsing resources. This may be null if the controller does not care where browsing should start.

Returns:

suitable location for browsing scope resources or null

Throws:

ResourceException - on failure to determine location