public abstract class AbstractRendererStatus extends Object implements IConfigurableRendererStatus, IVolatileStatus
Modifier and Type | Class and Description |
---|---|
static class |
AbstractRendererStatus.CompleteResourceComparator
Deprecated.
As of NetWeaver 7.1
|
Modifier and Type | Field and Description |
---|---|
protected FieldSet |
actions
Deprecated.
|
protected IResourceContext |
context
Deprecated.
|
protected ITypedResourceList |
list
Deprecated.
|
DESELECT_ALL, ID, NAME, SELECT_ALL
Constructor and Description |
---|
AbstractRendererStatus()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
StatusInformation |
execute(IExecutable execution)
Deprecated.
As of NetWeaver 7.1
|
StatusInformation |
execute(String execution)
Deprecated.
As of NetWeaver 7.1
|
void |
filter()
Deprecated.
As of NetWeaver 7.1
|
IExecutable |
getAction(FieldIdentifier ident)
Deprecated.
As of NetWeaver 7.1
|
ResourcePropertyComparator |
getComparator()
Deprecated.
As of NetWeaver 7.1
|
int |
getCurrentIndex()
Deprecated.
As of NetWeaver 7.1
|
int |
getEntrySize()
Deprecated.
As of NetWeaver 7.1
|
IField |
getField(FieldIdentifier ident)
Deprecated.
As of NetWeaver 7.1
|
List |
getFields()
Deprecated.
As of NetWeaver 7.1
|
FieldSet |
getFieldSet(int index)
Deprecated.
As of NetWeaver 7.1
|
FieldSet |
getFieldSet(IResource res)
Deprecated.
As of NetWeaver 7.1
|
protected IResourceListFilter |
getFilter()
Deprecated.
As of NetWeaver 7.1
|
protected IParameters |
getFilterParameters()
Deprecated.
As of NetWeaver 7.1
|
String |
getID()
Deprecated.
As of NetWeaver 7.1
|
List |
getMassFields()
Deprecated.
As of NetWeaver 7.1
|
protected Hashtable |
getParameters()
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
|
String |
getResourceTypeMapping()
Deprecated.
As of NetWeaver 7.1
|
IResourceList |
getSelectedResources()
Deprecated.
As of NetWeaver 7.1
|
SortDefinition |
getSortDefintion()
Deprecated.
As of NetWeaver 7.1
|
StatusInformation |
getStatusInformation()
Deprecated.
As of NetWeaver 7.1
|
ITypedResourceList |
getTypedResourceList()
Deprecated.
As of NetWeaver 7.1
|
boolean |
hasMore()
Deprecated.
As of NetWeaver 7.1
|
protected void |
initializeSelectionList()
Deprecated.
As of NetWeaver 7.1
|
boolean |
isVolatile()
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 |
setID(String ID)
Deprecated.
As of NetWeaver 7.1
|
void |
setParameters(Hashtable parameters)
Deprecated.
As of NetWeaver 7.1
|
void |
setParent(ICollection collection)
Deprecated.
As of NetWeaver 7.1
|
void |
setPropertyColumns(IPropertyColumn[] columns)
Deprecated.
As of NetWeaver 7.1
|
void |
setResourceTypeMapping(String mapping)
Deprecated.
As of NetWeaver 7.1
|
void |
setSortDefinition(SortDefinition sd)
Deprecated.
As of NetWeaver 7.1
|
void |
setTypedResourceList(ITypedResourceList resourcelist,
IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
void |
sort()
Deprecated.
As of NetWeaver 7.1
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getNewInstance
getActions
protected ITypedResourceList list
protected IResourceContext context
protected FieldSet actions
public boolean isVolatile()
isVolatile
in interface IVolatileStatus
true
, if it might be deleted.public void setParameters(Hashtable parameters)
setParameters
in interface IConfigurableRendererStatus
protected Hashtable getParameters()
public String getResourceTypeMapping()
getResourceTypeMapping
in interface IConfigurableRendererStatus
public void setResourceTypeMapping(String mapping)
setResourceTypeMapping
in interface IConfigurableRendererStatus
public void setParent(ICollection collection) throws WcmException
ITypedResourceList
to null
to prevent that a resource list and a collection with children are active within the status at the
same time.setParent
in interface IRendererStatus
collection
- parentWcmException
- if the RepositoryFramework does sopublic void setTypedResourceList(ITypedResourceList resourcelist, IResourceContext context) throws WcmException
ICollection
to null
to prevent that a resource list and a collection with children are active within the status at the
same time.setTypedResourceList
in interface IRendererStatus
resourcelist
- listcontext
- contextWcmException
- if the RepositoryFramework does sopublic ICollection getParent()
IRendererStatus
ICollection
, whose children are handled within this
status. Might be null
.getParent
in interface IRendererStatus
public ITypedResourceList getTypedResourceList()
IRendererStatus
ITypedResourceList
, whose elements are handled within this
status. Might be null
or might be of size 0.getTypedResourceList
in interface IRendererStatus
public void setPropertyColumns(IPropertyColumn[] columns)
IRendererStatus
null
?
sets the IPropertyColumn[]
attribute of the status. Might be null
.setPropertyColumns
in interface IRendererStatus
columns
- PropertyColumnspublic IPropertyColumn[] getPropertyColumns()
IRendererStatus
null
?getPropertyColumns
in interface IRendererStatus
IPropertyColumn[]
attribute of the status. Might be null
.public int getCurrentIndex() throws WcmException
getCurrentIndex
in interface IRendererStatus
IResource
objects.WcmException
- if it is set to a value thatpublic void setCurrentIndex(int index) throws WcmException
IRendererStatus
setCurrentIndex
in interface IRendererStatus
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.public void setSortDefinition(SortDefinition sd)
IRendererStatus
SortDefinition
attribute of the status. Might be null
.setSortDefinition
in interface IRendererStatus
sd
- SortDefinitionpublic SortDefinition getSortDefintion()
getSortDefintion
in interface IRendererStatus
SortDefinition
attribute of the status. Might be null
.public int getEntrySize()
IMassDataControlStatus
getEntrySize
in interface IMassDataControlStatus
public void setComparator(ResourcePropertyComparator comp)
IRendererStatus
ResourcePropertyComparator
attribute of the status. Might be null
.setComparator
in interface IRendererStatus
comp
- Comparatorpublic ResourcePropertyComparator getComparator()
getComparator
in interface IRendererStatus
ResourcePropertyComparator
attribute of the status. Might be null
.public List getMassFields()
IMassDataControlStatus
FieldIdentifier
values.getMassFields
in interface IMassDataControlStatus
public void sort()
IRendererStatus
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.sort
in interface IRendererStatus
public void refresh() throws WcmException
refresh
in interface IRendererStatus
WcmException
- WcmExceptionpublic void filter() throws WcmException
IResourceList
attribute of the status
using the set IResourceListFilter
and the IParameters
.
If one of these is null
, no filtering will be done, but a logging
entry is written. Also, if the list has been filtered before and no new information
has been provided by either IResourceListFilter
IParameters
or refresh()
method 0
, because the index
as it was might exceed the number of elements left over after the filtering. filter
in interface IRendererStatus
WcmException
- if the filtering class throws itpublic void setFilter(IResourceListFilter filter)
IRendererStatus
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).setFilter
in interface IRendererStatus
filter
- the filter instance to use, can be null
protected IResourceListFilter getFilter()
public void setFilterParameters(IParameters filterparameters)
IRendererStatus
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).setFilterParameters
in interface IRendererStatus
filterparameters
- determine which rules apply to filtering, can be
null
protected IParameters getFilterParameters()
public IResourceList getResourceList()
IRendererStatus
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.getResourceList
in interface IRendererStatus
IResourceList
that might be empty. Must not return null
.public FieldSet getFieldSet(int index)
IResource
.getFieldSet
in interface IMassDataControlStatus
index
- TBD: Description of the incoming method parameterpublic FieldSet getFieldSet(IResource res)
getFieldSet
in interface IRendererStatus
res
- resourceFieldSet
defined for this IResource
. This
set is needed to e.g. change the selection state of the resource.protected void initializeSelectionList() throws WcmException
WcmException
public IResourceList getSelectedResources()
getSelectedResources
in interface IRendererStatus
public IResource getResource(int index)
getResource
in interface IRendererStatus
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.public StatusInformation execute(IExecutable execution) throws WcmException
execute
in interface IControlStatus
execution
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationpublic StatusInformation execute(String execution) throws WcmException
IExecutable
objects. If the given parameter
matches the IExecutable
's getIdentifier.getID
, this
IExecutable
must be passed to the other signature of this method.execute
in interface IControlStatus
execution
- TBD: Description of the incoming method parameterWcmException
- if no matching class could be found.public IField getField(FieldIdentifier ident)
null
, if no
such instance could be found.getField
in interface IControlStatus
ident
- TBD: Description of the incoming method parameterpublic IExecutable getAction(FieldIdentifier ident)
IExecutable
with the given ident-parameter
or null
, if no such instance could be found.getAction
in interface IControlStatus
ident
- TBD: Description of the incoming method parameterpublic List getFields()
getFields
in interface IControlStatus
public StatusInformation getStatusInformation()
null
will be used and its status
will be returned. Consequently, this method might return null
getStatusInformation
in interface IControlStatus
public boolean hasMore()
hasMore
in interface IRendererStatus
false
, if all resources are includedpublic String getID()
IControlStatus
getID
in interface IControlStatus
public void setID(String ID)
IControlStatus
setID
in interface IControlStatus
ID
- iD to be setAccess 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