public class SettingsContainer extends Object
ISettingInfo
instances as well
as a map of IResourceBasedInfo
instances.
If the setting for the requested SettingInfoKey
or RID
does not exist, it is created, added to the map and returned to the calling class.Constructor and Description |
---|
SettingsContainer(Locale locale) |
Modifier and Type | Method and Description |
---|---|
List |
flavorList() |
List |
getGlobalTypes() |
SettingInfoKey.Source[] |
getMergeMode() |
IResourceBasedInfo |
getResourceBasedInfo(RID rid) |
IResourceBasedInfo |
getResourceBasedInfo(String type) |
IResourceBasedInfo |
getResourceTypeBasedInfo(String type) |
ISettingInfo |
getSetting(SettingInfoKey key)
returns an already existing
ISettingInfo stored in the class'
local map or creates a new instance and stores it in its map. |
Status |
getStatus() |
Status |
getStatus(SettingInfoKeyList list) |
SettingInfoKeyList |
keys() |
Locale |
locale() |
List |
parameterNameList() |
List |
ridList() |
void |
setMergeMode(SettingInfoKey.Source[] mode) |
List |
sourceList() |
List |
typeList() |
public SettingsContainer(Locale locale)
locale
- is needed for a future translation extension of the
rendering information. Classes adding information to this container
might not have access to the current locale at the time they need
to add information here. Must not be null
public SettingInfoKey.Source[] getMergeMode()
public void setMergeMode(SettingInfoKey.Source[] mode)
public IResourceBasedInfo getResourceBasedInfo(RID rid)
rid
- must not be null
public IResourceBasedInfo getResourceBasedInfo(String type)
type
- is the type of the ITypedResourceList
that
is used to retrieve the customizing settings for the current rendering.
Must not be null
.public IResourceBasedInfo getResourceTypeBasedInfo(String type)
public List getGlobalTypes()
List
instance that holds String
representations of all RID
s and resourcelisttypes that
have been added to the container using the getResourceBasedInfo(RID)
getResourceBasedInfo(java.lang.String)
methods.public Locale locale()
null
.public ISettingInfo getSetting(SettingInfoKey key)
ISettingInfo
stored in the class'
local map or creates a new instance and stores it in its map.key
- ISettingInfo
, that might be newly created, but never
null
public SettingInfoKeyList keys()
SettingInfoKeyList
that
includes all keys that have been added using the
getSetting(SettingInfoKey)
methodpublic List ridList()
RID
instances that
have been part of the SettingInfoKey
instances
used in the getSetting(SettingInfoKey)
method.public List typeList()
public List flavorList()
IFlavor
instances that
have been part of the SettingInfoKey
instances
used in the getSetting(SettingInfoKey)
method.public List sourceList()
Source
instances as
String
representations, that have been part
of the SettingInfoKey
instances
used in the getSetting(SettingInfoKey)
method.public List parameterNameList()
IParameterName
instances that
have been part of the SettingInfoKey
instances
used in the getSetting(SettingInfoKey)
method.public Status getStatus(SettingInfoKeyList list)
list
- ISettingInfo
instances that are mapped to the keys in the given list.
The default return value should be Status.OK
.
The returned status reflects the highest severity any of these
ISettingInfo
instances indicate.
Must not return null
.public Status getStatus()
Status.OK
. It reflects the highest severity any of its contained
classes indicates, either ISettingInfo
or IResourceBasedInfo
.
Must not return null
.Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice