|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScreenView
A ScreenView is a component of a View and denotes the particular attribute collections that are in effect on this type of screen when the owning View is selected. It can break these down into separate UI constructs (such as tabs or panels) using ScreenViewFilters
View
,
ScreenType
,
ScreenViewFilter
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
ScreenViewFilter |
addFilter(java.lang.String name)
Add an empty filter with the specified name to the end of the list. |
ScreenViewFilter |
addFilter(java.lang.String name,
int position)
Add an empty filter with the specified name to the specified location in the list Attribute Collections can be added to the filter via ScreenViewFilter.addAttributeCollection or ScreenViewFilter.setAttributeCollections |
java.util.Collection<AttributeCollection> |
getAttributeCollections()
Get all attribute collections on this screen view, editable and viewable |
java.util.Collection<AttributeDefinition> |
getAttributes()
Get all viewable and editable attributes from the union of all viewable and editable attribute collections on this screen view. |
java.util.Collection<AttributeCollection> |
getEditableAttributeCollections()
Get the editable attribute collections for this screen view |
java.util.Collection<AttributeDefinition> |
getEditableAttributes()
Get all editable attributes from the editable attribute collections on this screen view at the present time. |
ScreenViewFilter |
getFilter(java.lang.String name)
Retrieve a filter on this screen view by name |
java.util.List<ScreenViewFilter> |
getFilters()
Get all view filters currently set against this screen view |
ScreenType |
getScreenType()
get the type of screen to which this screen view corresponds |
View |
getView()
Get the View to which this ScreenView belongs |
java.util.Collection<AttributeCollection> |
getViewableAttributeCollections()
Get the viewable attribute collections for this screen view |
java.util.Collection<AttributeDefinition> |
getViewableAttributes()
Get all viewable attributes from the union of all viewable attribute collections on this screen view at the present time. |
void |
setEditableAttributeCollections(java.util.Collection<AttributeCollection> attributeCollections)
Set the editable attribute collections for this screen view This will override any existing editable attribute collections that are currently set |
void |
setFilters(java.util.Collection<ScreenViewFilter> filters)
Set the filters for this screen view, overwriting any existing filters set for this data view. |
void |
setViewableAttributeCollections(java.util.Collection<AttributeCollection> attributeCollections)
Set the viewable attribute collections for this screen view This will override any existing viewable attribute collections that are currently set |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
View getView()
PIMInternalException
- if an internal error occursjava.util.Collection<AttributeCollection> getViewableAttributeCollections()
PIMInternalException
- if an internal error occursjava.util.Collection<AttributeCollection> getEditableAttributeCollections()
java.lang.UnsupportedOperationException
- if this Screen View is linked to a screen type which does not
support Editable Attribute Collections
PIMInternalException
- if an internal error occursvoid setEditableAttributeCollections(java.util.Collection<AttributeCollection> attributeCollections)
attributeCollections
- the attribute collections to set
java.lang.UnsupportedOperationException
- if this Screen View is linked to a screen type which does not
support Editable AttributeCollections
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 any of the input parameters is nullvoid setViewableAttributeCollections(java.util.Collection<AttributeCollection> attributeCollections)
attributeCollections
- the attribute collections to set
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 any of the input parameters is nulljava.util.Collection<AttributeDefinition> getAttributes()
PIMInternalException
- if an internal error occursjava.util.Collection<AttributeDefinition> getViewableAttributes()
PIMInternalException
- if an internal error occursjava.util.Collection<AttributeDefinition> getEditableAttributes()
java.lang.UnsupportedOperationException
- if this Screen View is linked to a screen type which does not
support Editable Attribute Collections
PIMInternalException
- if an internal error occursjava.util.Collection<AttributeCollection> getAttributeCollections()
PIMInternalException
- if an internal error occursScreenViewFilter getFilter(java.lang.String name)
name
- the filter name to return
PIMInternalException
- if an internal error occurs
java.lang.IllegalArgumentException
- if name is emptyjava.util.List<ScreenViewFilter> getFilters()
PIMInternalException
- if an internal error occursScreenViewFilter addFilter(java.lang.String name)
name
- the name for the new filter to be added to this screen view.
The filter will be added at the end of the current list of
filters Changes must be saved via getView().save()
PIMInternalException
- if an internal error occurs, or if a filter with the
specified name already exists
PIMAuthorizationException
- Permission.CATALOG_EDIT_CATALOG_VIEWS
Permission.HIERARCHY_EDIT_HIERARCHY_VIEWS
java.lang.IllegalArgumentException
- if name is null or emptyScreenViewFilter addFilter(java.lang.String name, int position)
name
- the name for the new filter to be added to this screen view.position
- an integer representing the position at which to insert the
new filter. (0 means the beginning of the list, 1 means
between the first and second filters, etc) Changes must be
saved via getView().save()
PIMInternalException
- if an internal error occurs, or if a filter with the
specified name already exists
PIMAuthorizationException
- Permission.CATALOG_EDIT_CATALOG_VIEWS
Permission.HIERARCHY_EDIT_HIERARCHY_VIEWS
java.lang.IllegalArgumentException
- if the integer is not a valid position for insertion or if
name is null or emptyvoid setFilters(java.util.Collection<ScreenViewFilter> filters)
filters
- a new Collection of ScreenViewFilters for this screen view
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Permission.CATALOG_EDIT_CATALOG_VIEWS
Permission.HIERARCHY_EDIT_HIERARCHY_VIEWS
java.lang.IllegalArgumentException
- if filters is nullScreenType getScreenType()
PIMInternalException
- if an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |