com.ibm.pim.view
Interface ScreenViewFilter


public interface ScreenViewFilter

A ScreenView Filter applies to a particular ScreenView within a View and describes one grouping of attribute collections that will appear in a separate UI construct (tab, panel etc) The editable/viewable state for each attribute is determined at the ScreenView level.

Since:
6.0.0
See Also:
View, ScreenView, ScreenType

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.util.Collection<AttributeCollection> getAttributeCollections()
          Get the Attribute Collections for this filter
 java.util.Collection<AttributeDefinition> getAttributes()
          Get all the attributes present in this filter at the present time
 java.lang.String getName()
          Get the name of the view filter
 ScreenView getScreenView()
          Get the ScreenView to which this filter belongs
 void setAttributeCollections(java.util.List<AttributeCollection> attributeCollections)
          Set attribute collections for this filter This will overwrite the current attribute collections for the filter with the new set.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Get the name of the view filter

Returns:
the name of this view filter
Throws:
PIMInternalException - if an internal error occurs

getScreenView

ScreenView getScreenView()
Get the ScreenView to which this filter belongs

Returns:
the ScreenView object
Throws:
PIMInternalException - if an internal error occurs

getAttributes

java.util.Collection<AttributeDefinition> getAttributes()
Get all the attributes present in this filter at the present time

Returns:
a Collection of attribute definitions Note that if any of the attribute collections includes dynamic attribute lists from specs, and those specs change in the future, then at that point the list of attributes will no longer be an accurate representation.

Likewise if new attribute collections are added or removed from this data view, the list of attributes will no longer be an accurate representation If there are no attributes, an empty collection will be returned

Throws:
PIMInternalException - if an internal error occurs

getAttributeCollections

java.util.Collection<AttributeCollection> getAttributeCollections()
Get the Attribute Collections for this filter

Returns:
a Collection of attribute collections present in this ViewFilter. If there are no attribute collections, an empty collection will be returned
Throws:
PIMInternalException - if an internal error occurs

setAttributeCollections

void setAttributeCollections(java.util.List<AttributeCollection> attributeCollections)
Set attribute collections for this filter This will overwrite the current attribute collections for the filter with the new set. This must be saved via getScreenView().getView().save()

Parameters:
attributeCollections - the new set of attribute collections for this view filter
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException -
In case of a Catalog View, if the user does not have the equivalent of Permission.CATALOG_EDIT_CATALOG_VIEWS
In case of a Hierarchy View, if the user does not have the equivalent of Permission.HIERARCHY_EDIT_HIERARCHY_VIEWS
java.lang.IllegalArgumentException - if attributeCollections is null