public final class ResourcePropertyAmalgamation extends Object
Thread
s and the different rendering classes involved
in the rendering of a single iView
. This class must not be persisted
via HttpRequest
s but rather be refilled for every request-cycle.
It is only intended to speed up parallel calls to the repository framework by
centralizing all calls for IProperty
s of an IResource
by first checking, if this property has already been retrieved from the RF and
- if so - returning it instead of passing the call again to the RF. It also checks
if an earlier call to the RF has been unsuccessful. If so, it will simply return
null
and not try again to retrieve this property. This mechanism
must only be used for the display of information. Any decision to edit the underlying
IResource
must only be made using the original properties retrieved
by the IResource
's method getProperties
or the like.Modifier and Type | Class and Description |
---|---|
static class |
ResourcePropertyAmalgamation.Mode
Deprecated.
As of NetWeaver 7.1
|
class |
ResourcePropertyAmalgamation.UnavailableEntries
Deprecated.
As of NetWeaver 7.1
|
Modifier and Type | Field and Description |
---|---|
static ResourcePropertyAmalgamation.Mode |
ADD
Deprecated.
|
static ResourcePropertyAmalgamation.Mode |
UPDATE
Deprecated.
|
Constructor and Description |
---|
ResourcePropertyAmalgamation()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
add(IResource resource,
IPropertyMap map,
ResourcePropertyAmalgamation.Mode mode)
Deprecated.
As of NetWeaver 7.1
|
void |
add(IResource resource,
IProperty prop,
ResourcePropertyAmalgamation.Mode mode)
Deprecated.
As of NetWeaver 7.1
|
boolean |
declareUnavailable(IResource resource,
IPropertyName name)
Deprecated.
As of NetWeaver 7.1
|
IPropertyNameList |
declareUnavailable(IResource resource,
IPropertyNameList list)
Deprecated.
As of NetWeaver 7.1
|
IPropertyMap |
getProperties(IResource resource)
Deprecated.
As of NetWeaver 7.1
|
IPropertyMap |
getProperties(IResource resource,
IPropertyNameList list)
Deprecated.
As of NetWeaver 7.1
|
IProperty |
getProperty(IResource resource,
IPropertyName name)
Deprecated.
As of NetWeaver 7.1
|
ResourceCommandAmalgamation |
getResourceCommandAmalg()
Deprecated.
|
void |
readProperties(IResourceList resources,
IPropertyNameList names)
Deprecated.
As of NetWeaver 7.1
|
void |
remove(IResource resource)
Deprecated.
As of NetWeaver 7.1
|
public static final ResourcePropertyAmalgamation.Mode ADD
public static final ResourcePropertyAmalgamation.Mode UPDATE
public void add(IResource resource, IProperty prop, ResourcePropertyAmalgamation.Mode mode)
IProperty
to the map of available properties for
the given IResource
. If the mode is ADD
, the property
will only be added, if no property with this key already exists for this resource
in this class. If the mode is UPDATE
, an eventually already existing
value will be replaced with the given property. A NullPointerException
is thrown, if one of the parameters is null
resource
- Description of the Parameterprop
- Description of the Parametermode
- Description of the Parameterpublic void readProperties(IResourceList resources, IPropertyNameList names)
public void add(IResource resource, IPropertyMap map, ResourcePropertyAmalgamation.Mode mode)
IPropertyMap
to the map of available properties
for the given IResource
. If the mode is ADD
, the properties
of the given map will only be added, if no property with this key already exist
for this resource in this class. If the mode is UPDATE
, an eventually
already existing value will be replaced with the property in the given map.
A NullPointerException
is thrown, if one of the parameters is null
.resource
- Description of the Parametermap
- Description of the Parametermode
- Description of the Parameterpublic IPropertyMap getProperties(IResource resource)
add
method, these properties
will be returned as well. If an exception occurs when trying to load the properties
from the framework, it will be shown in the logging as a warning. An empty IPropertyMap
will be returned. Additional calls of this method will not be routed to the
framework.resource
- Description of the Parameterpublic IProperty getProperty(IResource resource, IPropertyName name)
null
will be returned. At the same time,
this resource/name tuple will be marked as an unavailable property. If the same
combination is requested at a later time, no call to the framework is done.
If one of the parameters is null
, a NullPointerException
will be thrownresource
- Description of the Parametername
- Description of the Parameternull
public ResourceCommandAmalgamation getResourceCommandAmalg()
public IPropertyMap getProperties(IResource resource, IPropertyNameList list)
null
, a NullPointerException
will be thrownresource
- Description of the Parameterlist
- Description of the Parameterpublic void remove(IResource resource)
resource
- Description of the Parameterpublic IPropertyNameList declareUnavailable(IResource resource, IPropertyNameList list)
null
, or a NullPointerException
is thrownresource
- the resource for which the properties are to be declared unavailablelist
- the properties that are to be declared unavailablenull
.public boolean declareUnavailable(IResource resource, IPropertyName name)
false
. Both given parameters
must not be null
, or a NullPointerException
is thrownresource
- the resource for which the property is to be declared unavailablename
- the property that is to be declared unavailableAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
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