public interface IRendererStatus extends IControlStatus, IMassDataControlStatus
IResource
and metadata
about that list across http-request-cycles, so that rendering classes such
as an ICollectionRenderer
can use this as persistence mechanism.
The status supports some basic user-resourcelist-interactions such as sorting,
filtering and selection. The status only creates new IResource
elements (which is an expensive operation) in the methods
refresh
setTypedResourceList
setParent
For the sort
method, only the ResourcePropertyComparator
attribute is used, not the SortDefinition
attribute. This attribute is
only needed by the classes which use this status as a model to persist their
data across http-requests.Modifier and Type | Field and Description |
---|---|
static FieldIdentifier |
DESELECT_ALL
Deprecated.
|
static FieldIdentifier |
ID
Deprecated.
|
static FieldIdentifier |
NAME
Deprecated.
|
static FieldIdentifier |
SELECT_ALL
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
filter()
Deprecated.
As of NetWeaver 7.1
|
ResourcePropertyComparator |
getComparator()
Deprecated.
As of NetWeaver 7.1
|
int |
getCurrentIndex()
Deprecated.
As of NetWeaver 7.1
|
FieldSet |
getFieldSet(IResource res)
Deprecated.
As of NetWeaver 7.1
|
ICollection |
getParent()
Deprecated.
As of NetWeaver 7.1
|
IPropertyColumn[] |
getPropertyColumns()
Deprecated.
As of NetWeaver 7.1
|
IResource |
getResource(int index)
Deprecated.
As of NetWeaver 7.1
|
IResourceList |
getResourceList()
Deprecated.
As of NetWeaver 7.1
|
IResourceList |
getSelectedResources()
Deprecated.
As of NetWeaver 7.1
|
SortDefinition |
getSortDefintion()
Deprecated.
As of NetWeaver 7.1
|
ITypedResourceList |
getTypedResourceList()
Deprecated.
As of NetWeaver 7.1
|
boolean |
hasMore()
Deprecated.
As of NetWeaver 7.1
|
void |
refresh()
Deprecated.
As of NetWeaver 7.1
|
void |
setComparator(ResourcePropertyComparator comp)
Deprecated.
As of NetWeaver 7.1
|
void |
setCurrentIndex(int index)
Deprecated.
As of NetWeaver 7.1
|
void |
setFilter(IResourceListFilter filter)
Deprecated.
As of NetWeaver 7.1
|
void |
setFilterParameters(IParameters filterparameters)
Deprecated.
As of NetWeaver 7.1
|
void |
setParent(ICollection parent)
Deprecated.
As of NetWeaver 7.1
|
void |
setPropertyColumns(IPropertyColumn[] columns)
Deprecated.
As of NetWeaver 7.1
|
void |
setSortDefinition(SortDefinition sd)
Deprecated.
As of NetWeaver 7.1
|
void |
setTypedResourceList(ITypedResourceList list,
IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
void |
sort()
Deprecated.
As of NetWeaver 7.1
|
execute, execute, getAction, getActions, getField, getFields, getID, getStatusInformation, setID
getEntrySize, getFieldSet, getMassFields
static final FieldIdentifier ID
static final FieldIdentifier NAME
static final FieldIdentifier SELECT_ALL
static final FieldIdentifier DESELECT_ALL
IResourceList getResourceList()
IResourceList
that does not have to be equal to either
the ITypedResourceList
or the result of the getChildren
method on the ICollection
attribute. It may be different because of
the sort
and filter
methods or any other operation the
implementing class decides to perform. As an implementation rule, a new
creation of IResource
elements to fill this list should be
avoided due to the performance overhead associated with that operation.IResourceList
that might be empty. Must not return null
.void setParent(ICollection parent) throws WcmException
filter
method of this status. If this method is called, the status will throw away
all selection information and recreate its internal list of resources. The
setTypedResourceList
shows a similar behavior. Must not be
null
.parent
- parentWcmException
- if the RepositoryFramework does soICollection getParent()
ICollection
, whose children are handled within this
status. Might be null
.ITypedResourceList getTypedResourceList()
ITypedResourceList
, whose elements are handled within this
status. Might be null
or might be of size 0.void setTypedResourceList(ITypedResourceList list, IResourceContext context) throws WcmException
ITypedResourceList
, whose elements are handled within this
status. Must not be null
but might be of size 0. The second parameter,
the context, is needed to set the IResourceContext
attribute of the
status. This is normally retrieved from an IResource
within the list,
but the list might be empty.list
- listcontext
- contextWcmException
- if the RepositoryFramework does sovoid setCurrentIndex(int index) throws WcmException
index
- indexWcmException
- if it is set to a value that
exceeds the number of IResource
s within this status. If not all elements
of the ITypedResourceList
or all children of the ICollection
have been retrieved yet (e.g. because of performance reasons), this method might trigger
a refresh of the list and increase that number.int getCurrentIndex() throws WcmException
IResource
objects.WcmException
- if it is set to a value thatIResource getResource(int index)
index
- indexIResource
that is situated at this position of the
internal list of IResource
objects. Note that this position might change
due to sort
and filter
methods. Returns null
,
if the parameter exceeds the size of the internal list.FieldSet getFieldSet(IResource res)
res
- resourceFieldSet
defined for this IResource
. This
set is needed to e.g. change the selection state of the resource.IResourceList getSelectedResources()
void setSortDefinition(SortDefinition sd)
SortDefinition
attribute of the status. Might be null
.sd
- SortDefinitionSortDefinition getSortDefintion()
SortDefinition
attribute of the status. Might be null
.void setComparator(ResourcePropertyComparator comp)
ResourcePropertyComparator
attribute of the status. Might be null
.comp
- ComparatorResourcePropertyComparator getComparator()
ResourcePropertyComparator
attribute of the status. Might be null
.void setPropertyColumns(IPropertyColumn[] columns)
null
?
sets the IPropertyColumn[]
attribute of the status. Might be null
.columns
- PropertyColumnsIPropertyColumn[] getPropertyColumns()
null
?IPropertyColumn[]
attribute of the status. Might be null
.void sort()
ResourcePropertyComparator
attribute to do this sorting. If that attribute is null
, no sorting will
be done and the list will be sorted as it was before this method was called.void filter() throws WcmException
IResource
objects will be set to false
, if and only if at least one of the two
attributes IResourceListFilter
or (IParameters
has changed since
the last call of this method.WcmException
- if the filtering class throws itvoid setFilter(IResourceListFilter filter)
ITypedResourceList
. A change of this
parameter will result in a new filtering, if the filter
method
is called afterwards. The call of this method alone does not lead to a new
filtering (and a reset of selected resources).filter
- the filter instance to use, can be null
void setFilterParameters(IParameters filterparameters)
IResourceListFilter
to determine which resources are to be filtered out. A change of this
parameter will result in a new filtering, if the filter
method
is called afterwards. The call of this method alone does not lead to a new
filtering (and a reset of selected resources).filterparameters
- determine which rules apply to filtering, can be
null
void refresh() throws WcmException
WcmException
- WcmExceptionboolean hasMore()
IResource
objects that belong to the
ICollection
or the TypedResourceList
attribute have
already been instantiated (and added to the internal resourcelist) or not.Access 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