org.kuali.rice.krad.uif.view

Interface ViewPresentationController

All Known Implementing Classes:

DemoCollectionEditLinePresentationController, DemoInquiryViewPresentationController, DocumentViewPresentationControllerBase, InquiryViewPresentationControllerBase, LabsTravelAccountPresentationController, LookupViewPresentationControllerBase, MaintenanceViewPresentationControllerBase, TransactionalDocumentViewPresentationControllerBase, ViewPresentationControllerBase

public interface ViewPresentationController

Configured for a View instance to provide conditional authorization logic based on any variable (view configuration, system parameters, ...) that does not depend on the current user

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canEditField(View view, ViewModel model, Field field, String propertyName) Determines if the given field within the view is allowed to be edited
boolean	canEditGroup(View view, ViewModel model, Group group, String groupId)
boolean	canEditLine(View view, ViewModel model, CollectionGroup collectionGroup, String collectionPropertyName, Object line)
boolean	canEditLineField(View view, ViewModel model, CollectionGroup collectionGroup, String collectionPropertyName, Object line, Field field, String propertyName)
boolean	canEditView(View view, ViewModel model) Determines if the the given view and data is allowed to be edited
boolean	canEditWidget(View view, ViewModel model, Widget widget, String widgetId)
boolean	canPerformAction(View view, ViewModel model, Action action, String actionEvent, String actionId)
boolean	canPerformLineAction(View view, ViewModel model, CollectionGroup collectionGroup, String collectionPropertyName, Object line, Action action, String actionEvent, String actionId)
boolean	canViewField(View view, ViewModel model, Field field, String propertyName) Determines if the given field within the view is allowed to be viewed
boolean	canViewGroup(View view, ViewModel model, Group group, String groupId)
boolean	canViewLine(View view, ViewModel model, CollectionGroup collectionGroup, String collectionPropertyName, Object line)
boolean	canViewLineField(View view, ViewModel model, CollectionGroup collectionGroup, String collectionPropertyName, Object line, Field field, String propertyName)
boolean	canViewWidget(View view, ViewModel model, Widget widget, String widgetId)
boolean	fieldIsRequired(View view, ViewModel model, Field field, String propertyName) Determines if a value is required to be present for the given field (used to indicate in the client the field must be completed)
Set<String>	getActionFlags(View view, UifFormBase model)
Set<String>	getEditModes(View view, UifFormBase model)
void	setRequestAuthorizationCache(RequestAuthorizationCache requestAuthorizationCache)

Method Detail

getActionFlags

Set<String> getActionFlags(View view,
                         UifFormBase model)

getEditModes

Set<String> getEditModes(View view,
                       UifFormBase model)

canEditView

boolean canEditView(View view,
                  ViewModel model)

Determines if the the given view and data is allowed to be edited

Parameters:

view - - view instance to check whether editing is allowed

model - - object containing the view data

Returns:

boolean true if editing on the view is allowed, false otherwise

canEditField

boolean canEditField(View view,
                   ViewModel model,
                   Field field,
                   String propertyName)

Determines if the given field within the view is allowed to be edited

Parameters:

view - - view instance the field belongs to

model - - object containing the view data

field - - field instance to determine edit authorization for

propertyName - - name of the property that field corresponds with (if field is data binding)

Returns:

boolean true if editing on the field is allowed, false otherwise

canViewField

boolean canViewField(View view,
                   ViewModel model,
                   Field field,
                   String propertyName)

Determines if the given field within the view is allowed to be viewed

Parameters:

view - - view instance the field belongs to

model - - object containing the view data

field - - field instance to determine view authorization for

propertyName - - name of the property that field corresponds with (if field is data binding)

Returns:

boolean true if viewing of the field is allowed, false otherwise

fieldIsRequired

boolean fieldIsRequired(View view,
                      ViewModel model,
                      Field field,
                      String propertyName)

Determines if a value is required to be present for the given field (used to indicate in the client the field must be completed)

Parameters:

view - - view instance the field belongs to

model - - object containing the view data

field - - field instance to determine required state for

propertyName - - name of the property that field corresponds with (if field is data binding)

Returns:

boolean true if field is required, false otherwise

canEditGroup

boolean canEditGroup(View view,
                   ViewModel model,
                   Group group,
                   String groupId)

canViewGroup

boolean canViewGroup(View view,
                   ViewModel model,
                   Group group,
                   String groupId)

canEditWidget

boolean canEditWidget(View view,
                    ViewModel model,
                    Widget widget,
                    String widgetId)

canViewWidget

boolean canViewWidget(View view,
                    ViewModel model,
                    Widget widget,
                    String widgetId)

canPerformAction

boolean canPerformAction(View view,
                       ViewModel model,
                       Action action,
                       String actionEvent,
                       String actionId)

canEditLine

boolean canEditLine(View view,
                  ViewModel model,
                  CollectionGroup collectionGroup,
                  String collectionPropertyName,
                  Object line)

canViewLine

boolean canViewLine(View view,
                  ViewModel model,
                  CollectionGroup collectionGroup,
                  String collectionPropertyName,
                  Object line)

canEditLineField

boolean canEditLineField(View view,
                       ViewModel model,
                       CollectionGroup collectionGroup,
                       String collectionPropertyName,
                       Object line,
                       Field field,
                       String propertyName)

canViewLineField

boolean canViewLineField(View view,
                       ViewModel model,
                       CollectionGroup collectionGroup,
                       String collectionPropertyName,
                       Object line,
                       Field field,
                       String propertyName)

canPerformLineAction

boolean canPerformLineAction(View view,
                           ViewModel model,
                           CollectionGroup collectionGroup,
                           String collectionPropertyName,
                           Object line,
                           Action action,
                           String actionEvent,
                           String actionId)

setRequestAuthorizationCache

void setRequestAuthorizationCache(RequestAuthorizationCache requestAuthorizationCache)