com.ibm.pim.view
Interface View


public interface View

A View is applied to a particular Catalog or Hierarchy and affects which attributes can be edited or viewed in the user interface. This does not override the access privileges but is merely a presentation layer on top

Since:
6.0.0

Nested Class Summary
static class View.Type
          The type of the View
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 void delete()
          delete the view
 java.lang.String getName()
          retrieve the name of the view
 ScreenView getScreenView(ScreenType screenType)
          retrieve the ScreenView for the specified ScreenType.
 View.Type getType()
          Return the type of this view
 void save()
          save changes to any ScreenViews within this Perspective
 

Field Detail

copyright

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

getType

View.Type getType()
Return the type of this view

Returns:
the View.Type type of this view
Throws:
PIMInternalException - if an internal error occurs

getName

java.lang.String getName()
retrieve the name of the view

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

getScreenView

ScreenView getScreenView(ScreenType screenType)
retrieve the ScreenView for the specified ScreenType.

Parameters:
screenType - the screen type for which to return the ScreenView
Returns:
the ScreenView object for the corresponding screen type. Attribute Collections can be added or removed using methods on the ScreenView.
Throws:
java.lang.IllegalArgumentException - if the specified ScreenType is not applicable to this View or screenType is null.
PIMInternalException - if an internal error occurs

delete

void delete()
delete the view

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

save

void save()
save changes to any ScreenViews within this Perspective

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