org.kuali.rice.krad.uif.service

Interface ViewDictionaryService

All Known Implementing Classes:

ViewDictionaryServiceImpl

public interface ViewDictionaryService

Provides methods to query the dictionary meta-data for view entries and their corresponding component entries

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
Inquirable	getInquirable(Class<?> dataObjectClass, String viewName) Queries the dictionary to find the InquiryView configured for the data object class and returns the configured Inquirable for the view.
Integer	getResultSetLimitForLookup(Class<?> dataObjectClass, LookupForm form) Attempts to find an associated LookupView for the given data object class and if found returns the configured result set limit, if multiple lookup views are found the default is used unless the specific view can be found by view ID
ViewSessionPolicy	getViewSessionPolicy(String viewId) Retrieves the ViewSessionPolicy instance associated with the given view id
boolean	isInquirable(Class<?> dataObjectClass) Indicates whether the given data object class has an associated InquiryView configured and thus can have inquiry links built
boolean	isLookupable(Class<?> dataObjectClass) Indicates whether the given data object class has an associated LookupView configured and thus can have quickfinders associated with the class
boolean	isMaintainable(Class<?> dataObjectClass) Indicates whether the given data object class has an associated MaintenanceDocumentView configured
boolean	isSessionStorageEnabled(String viewId) Indicates whether session storage is enabled for the view associated with the given id

Method Detail

getInquirable

Inquirable getInquirable(Class<?> dataObjectClass,
                       String viewName)

Queries the dictionary to find the InquiryView configured for the data object class and returns the configured Inquirable for the view. If more than one inquiry view exists for the data object class, the one that matches the given viewName, or the default if viewName is blank is used

Parameters:

dataObjectClass - - class for the inquiry data object

viewName - - name of the inquiry view, can be blank in which case the 'default' name will be used

Returns:

Inquirable configured inquirable for the view, or null if view is not found

isInquirable

boolean isInquirable(Class<?> dataObjectClass)

Indicates whether the given data object class has an associated InquiryView configured and thus can have inquiry links built

Parameters:

dataObjectClass - - object class to get inquiry view for

Returns:

boolean true if the class has an inquiry view, false if no inquiry view exists for the class

isLookupable

boolean isLookupable(Class<?> dataObjectClass)

Indicates whether the given data object class has an associated LookupView configured and thus can have quickfinders associated with the class

Parameters:

dataObjectClass - - object class to get lookup view for

Returns:

boolean true if the class has an lookup view, false if no lookup view exists for the class

isMaintainable

boolean isMaintainable(Class<?> dataObjectClass)

Indicates whether the given data object class has an associated MaintenanceDocumentView configured

Parameters:

dataObjectClass - - object class to get maintenance view for

Returns:

boolean true if the class has an maintenance view, false if no maintenance view exists for the class

getResultSetLimitForLookup

Integer getResultSetLimitForLookup(Class<?> dataObjectClass,
                                 LookupForm form)

Attempts to find an associated LookupView for the given data object class and if found returns the configured result set limit, if multiple lookup views are found the default is used unless the specific view can be found by view ID

Parameters:

dataObjectClass - - object class to get lookup view for

form - - the LookupForm

Returns:

Integer configured result set limit for lookup, or null if not found (note property could also be null on the view itself)

getViewSessionPolicy

ViewSessionPolicy getViewSessionPolicy(String viewId)

Retrieves the ViewSessionPolicy instance associated with the given view id

Parameters:

viewId - id for the view whose session policy should be retrieved

Returns:

view session policy instance for view or null if view not found for the given id

isSessionStorageEnabled

boolean isSessionStorageEnabled(String viewId)

Indicates whether session storage is enabled for the view associated with the given id

Parameters:

viewId - id for the view to check

Returns:

true if session storage is enabled, false if not enabled or the view was not found