public final class JanusHeadedStatusFlipSide extends Object implements IConfigurableRendererStatus
DESELECT_ALL, ID, NAME, SELECT_ALL
Constructor and Description |
---|
JanusHeadedStatusFlipSide() |
JanusHeadedStatusFlipSide(FlexUICacheHierarchical flexcache) |
Modifier and Type | Method and Description |
---|---|
StatusInformation |
execute(IExecutable executable)
carries out the action described by the given parameter.
|
StatusInformation |
execute(String execution)
different signature for this method.
|
void |
filter()
filters the internal list of resources.
|
IExecutable |
getAction(FieldIdentifier ident)
returns the
IExecutable with the given ident-parameter or
null , if no such instance could be found. |
List |
getActions()
returns a list with all
IExecutable s defined by the
implementing class |
ResourcePropertyComparator |
getComparator() |
int |
getCurrentIndex() |
int |
getEntrySize()
returns the number of entries that are managed within this status
|
IField |
getField(FieldIdentifier ident)
returns the field with the given ident-parameter or
null , if
no such instance could be found. |
List |
getFields()
returns a list with all fields defined by the implementing class
|
FieldSet |
getFieldSet(int index)
returns all fields available for the instance of the managed type at this
index of the internal list.
|
FieldSet |
getFieldSet(IResource res) |
FlexUICacheHierarchical |
getFlexcache() |
String |
getID()
returns the ID under which this status was registered by the Service
|
List |
getMassFields()
returns all fields that will be available for the managed types of this
class.
|
IConfigurableRendererStatus |
getNewInstance() |
ICollection |
getParent()
returns the
ICollection , whose children are handled within this
status. |
IPropertyColumn[] |
getPropertyColumns()
TODO what about
null ? |
IResource |
getResource(int index) |
IResourceList |
getResourceList()
returns an
IResourceList that does not have to be equal to either
the ITypedResourceList or the result of the getChildren
method on the ICollection attribute. |
String |
getResourceTypeMapping() |
IResourceList |
getSelectedResources() |
SortDefinition |
getSortDefintion() |
StatusInformation |
getStatusInformation()
returns the status of the implementing class.
|
ITypedResourceList |
getTypedResourceList()
returns the
ITypedResourceList , whose elements are handled within this
status. |
boolean |
hasMore()
flag telling if all
IResource objects that belong to the
ICollection or the TypedResourceList attribute have
already been instantiated (and added to the internal resourcelist) or not. |
boolean |
isRefreshTriggered() |
void |
refresh()
reloads resources from RF
revokes all selections
|
void |
resetRefreshTrigger() |
void |
setComparator(ResourcePropertyComparator comp)
sets the
ResourcePropertyComparator attribute of the status. |
void |
setCurrentIndex(int index)
sets the index-attribute of the status to the given value.
|
void |
setFilter(IResourceListFilter filter)
sets the class, that is used to filter out resources from the given
parent-collection or the
ITypedResourceList . |
void |
setFilterParameters(IParameters filterparameters)
sets the parameters, that are used by the
IResourceListFilter
to determine which resources are to be filtered out. |
void |
setFlexCache(FlexUICacheHierarchical flexcache) |
void |
setID(String id)
sets the ID under which this status was registered by the service this
field is set by the service and must not be altered afterwards.
|
void |
setParameters(Hashtable parameters) |
void |
setParent(ICollection parent)
sets the collection whose children are to be handled within this status.
|
void |
setPropertyColumns(IPropertyColumn[] columns)
TODO what about
null ? |
void |
setResourceTypeMapping(String mapping) |
void |
setSortDefinition(SortDefinition sd)
sets the
SortDefinition attribute of the status. |
void |
setTypedResourceList(ITypedResourceList list,
IResourceContext context)
sets the
ITypedResourceList , whose elements are handled within this
status. |
void |
sort()
sorts the internal list of resources.
|
public JanusHeadedStatusFlipSide(FlexUICacheHierarchical flexcache)
public JanusHeadedStatusFlipSide()
public void setFlexCache(FlexUICacheHierarchical flexcache)
public StatusInformation execute(IExecutable executable) throws WcmException
IControlStatus
execute
in interface IControlStatus
executable
- TBD: Description of the incoming method parameterWcmException
- Exception raised in failure situationpublic StatusInformation execute(String execution) throws WcmException
IControlStatus
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
- Exception raised in failure situationpublic IExecutable getAction(FieldIdentifier ident)
IControlStatus
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 getActions()
IControlStatus
IExecutable
s defined by the
implementing classgetActions
in interface IControlStatus
public IField getField(FieldIdentifier ident)
IControlStatus
null
, if
no such instance could be found.getField
in interface IControlStatus
ident
- TBD: Description of the incoming method parameterpublic List getFields()
IControlStatus
getFields
in interface IControlStatus
public String getID()
IControlStatus
getID
in interface IControlStatus
public StatusInformation getStatusInformation()
IControlStatus
null
will be used and
its status will be returned. Consequently, this method might return
null
getStatusInformation
in interface IControlStatus
public void setID(String id)
IControlStatus
setID
in interface IControlStatus
id
- iD to be setpublic FlexUICacheHierarchical getFlexcache()
public void filter() throws WcmException
IRendererStatus
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.filter
in interface IRendererStatus
WcmException
- if the filtering class throws itpublic ResourcePropertyComparator getComparator()
getComparator
in interface IRendererStatus
ResourcePropertyComparator
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 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.public ICollection getParent()
IRendererStatus
ICollection
, whose children are handled within this
status. Might be null
.getParent
in interface IRendererStatus
public IPropertyColumn[] getPropertyColumns()
IRendererStatus
null
?getPropertyColumns
in interface IRendererStatus
IPropertyColumn[]
attribute of the status. Might be null
.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 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 IResourceList getSelectedResources()
getSelectedResources
in interface IRendererStatus
public SortDefinition getSortDefintion()
getSortDefintion
in interface IRendererStatus
SortDefinition
attribute of the status. Might be null
.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 boolean hasMore()
IRendererStatus
IResource
objects that belong to the
ICollection
or the TypedResourceList
attribute have
already been instantiated (and added to the internal resourcelist) or not.hasMore
in interface IRendererStatus
public void refresh() throws WcmException
IRendererStatus
refresh
in interface IRendererStatus
WcmException
- WcmExceptionpublic boolean isRefreshTriggered()
public void resetRefreshTrigger()
public void setComparator(ResourcePropertyComparator comp)
IRendererStatus
ResourcePropertyComparator
attribute of the status. Might be null
.setComparator
in interface IRendererStatus
comp
- Comparatorpublic 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 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
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
public void setParent(ICollection parent) throws WcmException
IRendererStatus
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
.setParent
in interface IRendererStatus
parent
- parentWcmException
- if the RepositoryFramework does sopublic void setPropertyColumns(IPropertyColumn[] columns)
IRendererStatus
null
?
sets the IPropertyColumn[]
attribute of the status. Might be null
.setPropertyColumns
in interface IRendererStatus
columns
- PropertyColumnspublic void setSortDefinition(SortDefinition sd)
IRendererStatus
SortDefinition
attribute of the status. Might be null
.setSortDefinition
in interface IRendererStatus
sd
- SortDefinitionpublic void setTypedResourceList(ITypedResourceList list, IResourceContext context) throws WcmException
IRendererStatus
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.setTypedResourceList
in interface IRendererStatus
list
- listcontext
- contextWcmException
- if the RepositoryFramework does sopublic 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 int getEntrySize()
IMassDataControlStatus
getEntrySize
in interface IMassDataControlStatus
public FieldSet getFieldSet(int index)
IMassDataControlStatus
IndexOutOfBoundsException
if no field set exists for the given index.getFieldSet
in interface IMassDataControlStatus
index
- TBD: Description of the incoming method parameterpublic List getMassFields()
IMassDataControlStatus
FieldIdentifier
values.getMassFields
in interface IMassDataControlStatus
public IConfigurableRendererStatus getNewInstance()
getNewInstance
in interface IConfigurableRendererStatus
public String getResourceTypeMapping()
getResourceTypeMapping
in interface IConfigurableRendererStatus
public void setParameters(Hashtable parameters)
setParameters
in interface IConfigurableRendererStatus
public void setResourceTypeMapping(String mapping)
setResourceTypeMapping
in interface IConfigurableRendererStatus
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