All Classes and Interfaces
Class
Description
Accordion widget class used to create an accordion based layout.
Accordion group class used to stack groups by there header titles in an accordion layout.
Field that presents an action that can be taken on the UI such as submitting the form or invoking a script.
Field that encloses an @{link org.kuali.rice.krad.uif.element.Action} element
Action field security adds the take action flags to the standard component security
Collection filter that removes inactive lines from a collection whose line types
implement the
Inactivatable interfaceThis class represents the add AdHocRoutePerson event that is part of an eDoc in Kuali.
Defines a rule which gets invoked immediately before a document has a adHocRoutePerson added to it.
This class represents the add AdHocRouteWorkgroup event that is part of an eDoc in Kuali.
Defines a rule which gets invoked immediately before a document has an adHocRouteWorkgroup added to it.
Defines the add collection line event fired when a user adds a line in a collection in a document.
Defines a rule which gets invoked immediately before an object is added to a collection.
Add the focusId, jumpToId and jumpToName as dataAttributes to the component during the finalize phase.
This class represents the add note event that is part of an eDoc in Kuali.
Defines a rule which gets invoked immediately before a document has a note added to it.
Add templates defined on this component to the view for rendering.
Perform post-expression evaluation tasks.
Parent abstract class that allows additional characters to be allowed in child constraint
character sets, see AlphaNumericPatternConstraint, among others for example.
A ValidCharactersConstraint based on AlphaNumericValidationPattern.
Pattern for matching alpha characters
This implementation of
PropertySerializabilityEvaluator specifies that all properties of a document are serializable.This implementation of
PropertySerializabilityEvaluator specifies that all properties of a document are serializable.Pattern for matching any printable character
Component that renders a standard application header including a logo, navigation, and toolbar.
Apply authorization and presentation logic for the component.
Lifecycle phase processing task for applying the model to a component.
This class represents the approve event that is part of an eDoc in Kuali.
Defines a rule which gets invoked immediately before a document gets approved.
Assign a unique ID to the component, if one has not already been assigned.
Static utility class for handling executor configuration and spreading
ViewLifecycle
across multiple threads.A single attribute definition in the DataDictionary, which contains
information relating to the display, validation, and general maintenance of a
specific attribute of an entry.
Common class for attribute definitions in the DataDictionary, which contains
information relating to the display, validation, and general maintenance of a
specific attribute of an entry.
AttributeDefinitionConstraintProvider looks up constraints for attribute definitions by constraint type
Holds configuration for executing a dynamic query on an
InputField to
pull data for updating the UIObject that is returned for Ajax attribute queries and exposed
as JSON
Provides methods for executing
AttributeQuery instances
and preparing the AttributeQueryResult with the result of the queryImplementation of
AttributeQueryService that prepares the attribute queries and
delegates to the LookupServiceDeprecated.
Should be removed - with Spring, parent attribute definitions do not
need to be bound to a business object.
Defines a set of restrictions that are possible on an attribute
An abstract base class for type service implementations which provides default validation of attributes from the Data
Dictionary.
A module-independent representation of a type attribute containing all the information that we need
in order to validate data dictionary-based attributes.
Exception thrown when an attribute can't be found during attribute-related validation.
AttributeValueReader defines classes that encapsulate access to both dictionary metadata and object field values
KRA Audit Cluster; container for related set of audit errors.
KRA Audit Error class.
A class that implements the required accessors and legacy processing for an attribute value reader.
A class that implements the required accessor for label keys.
BaseConstraintProvider implements a simple in memory storage map of constraint resolvers
Performs overrides on the fields of a Data Dictionary bean.
The base implementation of the BeanOverride interface.
Annotation flag that the connected class is a represented by the declared name in Spring Beans created using the
custom schema.
Annotation flag that the connected method is represented by the declared name in Spring Beans created using the
custom schema.
BeanTags annotation for holding multiple BeanTag annotations, for krad beans
Provides binding configuration for an DataBinding component (attribute or
collection)
This class represents the blanketApprove event that is part of an eDoc in Kuali.
BlockUI element is used within the view element for managing element/page blocking attributes
Map implementation takes a
Set of Strings and converts to Map
where the string is the map key and value is the Boolean true, convenience
collection for expression language.A filter which at runtime reads a series of filter configurations, constructs
and initializes those filters, and invokes them when it is invoked.
Layout manager that organizes components in a single row (horizontal) or
column (vertical)
BreadcrumbItem represents a single item in the breadcrumb list that is generated by the breadcrumbs widget.
BreadcrumbOptions represents the options for the current view breadcrumbs that are displayed.
The breadcrumb widget contains various settings for setting up
Breadcrumb/History support on the view
Provides contract for implementing a bulk update withing the bulk update framework.
Default implementation of
BulkUpdateMaintainable.Provides contract for the data object of the bulk update maintenance document.
Default implementation of
BulkUpdateMaintenanceDataObject.A single BusinessObject entry in the DataDictionary, which contains information relating to the display, validation,
and general maintenance of a BusinessObject and its attributes.
Thrown when a BusinessObject is expected to implement Lookupable, but does not.
This implementation of
PropertySerializabilityEvaluator uses the <workflowProperties> defined within the data dictionary
for a document.Parent interface of all BusinessRule interfaces.
Validation capability to constrain a particular value under specific conditions.
CaseConstraint is imposed only when a certain condition is met
CaseConstraintProcessor processes 'case constraints', which are constraints that are imposed only in specific cases
CaseConstraintResolver returns the case constraint as a list for a definition implementing the capability
CaseConstrainableIndicates that the form annotated with this annotation has change tracking enabled.
Deprecated.
Pattern for matching any character in the given list (String)
Represents a HTML Checkbox control.
Represents a group of HTML checkbox controls.
Exception thrown when a class can't be found during class-related validation.
Annotation that can be used on
Component properties to indicate the property
value should be exposed in the client and populated back from the clientContains all the methods necessary for generating the js required to perform validation client
side.
CollectionConstraintProcessor is a marker interface for 'collection constraint processors'
Controller service that provides methods for working with collection groups.
Default implementation of the collection controller service.
Helper class for maintaining collection action parameters for a request.
CollectionDefinition defines a single Collection attribute definition in the DataDictionary
Provides filtering on collection data within a
CollectionGroupInterface representing an editable collection within a view.
Group that holds a collection of objects and configuration for presenting the
collection in the UI.
Builds out the
Field instances for a collection group with a
series of steps that interact with the configured CollectionLayoutManager
to assemble the fields as necessary for the layout.Process configuration from the collection group to prepare components for a new line and invokes the associated
layout manager to add the line.
Collection Group security is used to flag that permissions exist for the associated
CollectionGroup
in KIM and should be checked to determine the associated group, line, and field state.Wraps a
List and if truncated keeps the complete sizeLayout manager implementations that work with a collection (such as a table layout) should implement
this interface for building the collection component instances.
Base class for collection layout managers.
Utilities for collection layout managers
StackedPagingHelper contains method(s) to help determine the correct page display information during
a request.
Validation capability to constrain a value of type collection to a specific minimum and maximum
number of elements.
A collection size constraint is one that implements a maximum and minimum number of elements for a collection.
This class validates attributes that are collection size constrained - ones that can only have between x and y
number
ColumnCalculationInfo is used to specify which columns and what types of calculations are performed on those columns
of table collection.
Holds the information for sorting a table by a column.
Sort direction, either ASCending or DESCending.
Provides configuration for comparing an object with another object
Generates
Field instances to produce a comparison view among
objects of the same typeComplete document event
Complete document rule interface to be implemented
Exception thrown when an error occurs validating the data parsed from a DictionaryEntry's XML file.
A complex attribute definition in the DataDictictionary.
An object that looks up constraints for attribute definitions by constraint type.
Component defines basic properties and methods that all rendering element implement
Base implementation of Component which other component implementations should extend.
Spring
BeanPostProcessor that processes configured Component
instances in the dictionary.For a given
Component instance converts all component properties
of a certain type to instances of another configured Component.Perform default apply model behavior defined for the component.
Perform default finalize behavior defined for the component.
Perform default initialization defined for the component.
Factory class for creating new UIF components from their base definitions in the dictionary.
Provides modification functionality for a
ComponentBase class for
ComponentModifier implementationsHolds data about a component that might be needed to handle a post request.
Component security is used to flag permissions that exist in KIM for various component state (like edit and view)
ComponentUtils is a utility class providing methods to help create and modify
Component instances.ConfigurationBasedRegexPatternConstraint uses a patternTypeKey to get the regex used for validation by key from
the KualiConfigurationService
This interface defines methods that must be implemented by classes that you want to participate in dictionary
validation as
for example 'attribute-level' object structure definitions.
This is the marker interface for constraints.
ConstraintProcessor must be implemented by constraint processors, which validate individual constraints in the
data dictionary
ConstraintProvider determines a list of constraints for a given Constrainable definition for an attribute
in the data dictionary
ConstraintResolver provides a lookup of constraints for a specific constrainable attribute definition
Various utility methods for determining when to use constraints during states
ConstraintValidationResult is a composite class for all the different members that need to be returned when a
ConstraintProcessor
processes a Constraint.Type of component that contains a collection of other components.
Base
Container implementation which container implementations
can extendGeneral component that allows custom HTML to be inserted into the view.
Interface for content element components.
Base component class for content elements.
Utility methods related to handling context for components.
Represents an interactive element in the UI (typically an HTML control)
Base class for all
Control implementations.Deprecated.
Controller service that provides the basic entry and exit methods.
Marks KRAD framework objects that support deep copying.
Defines methods a Copyable document must implement.
Provides a lightweight "hands-free" copy implementation to replace the need for copyProperties()
in building
LifecycleElement implementations.Simple utility class that will validate the given request to determine if it has any required CSRF information,
setting appropriate response errors if not.
Constants for CSS style strings
A Css Grid Layout which only takes fields as its content and separates out the field's labels into
separate columns
Css Grid Layout manager is a layout manager which creates div "rows" and "cells" to replicate a
table look by using div elements for its items.
Css Grid Layout managers are a layout managers which creates div "rows" and "cells" to replicate a
table look by using div elements for its items.
CssGridSizes are used by CssGridLayoutManagers to determine how much "column/cell" width an item will take up in a
css grid layout.
Validation pattern for matching currency type.
Implementation of
MessageProvider that stores messages in a databaseComponents that bind to a model (hold model data) should implement this interface.
Encapsulates a bean factory and indexes to the beans within the factory for providing
framework metadata
Defines methods common to all DataDictionaryDefinition types.
Common base class for DataDictionaryDefinition types.
Defines methods common to all DataDictionaryDefinition types.
Contains common properties and methods for data dictionary entries
Exception thrown when an error occurs loading entries into the DataDictionaryEntry.
Encapsulates a set of statically generated (typically during startup)
DataDictionary indexes
A DataDictionaryMapper that simply consults the statically initialized
DataDictionaryIndex mappings
Maps one Document type to other document Type.
Provides service methods for building and validate
RemotableAttributeField definitions from data
dictionary AttributeDefinition configurationsDefines the API for interacting with the data dictionary
Component interface for data fields.
Field that renders data from the application, such as the value of a data object property
Data field security adds attribute security to the standard component security
Provides methods for checking authorization for actions
on a given data object class including the security of fields
within the class
Invoked to authorize actions requested on data objects (such as edit or view)
Generic dictionary entry for an object that does not have to implement BusinessObject.
An object that looks up constraints for an object dictionary entry by constraint type.
Content element that renders a table using the
RichTable widget configured with an Ajax (or Javascript)
data sourceInput command processor for supporting DataTables server-side processing.
A data type constraint is one that enforces a specific data type for an object.
DataTypeConstraintProcessor processes constraints of type
DataTypeConstraintA utility class for determining the data type of classes and their attributes.
DatePatternConstraint constrains a field to only allow dates which are part of the formats
defined in the system.
Used for rendering a calendar in the UI that can be used to selected dates
for field values
Evaluates expression language statements using the Spring EL engine
Creates instances of
DefaultExpressionEvaluator.An object that returns the constrainable definition itself as a list for a definition implementing the capability
Constrainable.Annotation for
Copyable fields to indicate that a delayed copy proxy should be used
instead of the original component when performing a deep copying on the field.Proxy invocation handler for delaying deep copy for framework objects that may not need to be
fully traversed by each transaction.
This class returns list containg A = Active, I = Inactive and B = Show All
The labels (values) in the List returned correspond to what is displayed next
to the radio buttons for the Active Indicator form field
Special type of group that presents the content in a modal dialog.
Holds response data for a basic dialog that has been triggered from a server call.
Common interface for all objects that can be configured in the dictionary
Common base for all objects that can be configured in the dictionary
Post processor for the data dictionary bean factory
API for classes that perform post processing of the dictionary bean definitions
Base class for dictionary bean processors that provides utility methods
This class allows a dictionary object to expose information about its fields / attributes, including the values of
those fields, with some guidance from the DataDictionaryEntry object.
DictionaryValidationResult holds dictionary validation results
Defines the API for the validating against the data dictionary.
Decorates a group with collapse/expand functionality
Outputs an empty div for placeholder purposes, including any basic component options set on
it through bean properties or by the framework (id, css, data attributes, etc.)
This is the Document interface.
Event class for document audit
audit rule marker
Authorizer class for
Document instancesDefault implementation for
DocumentAuthorizer that perform KIM permission checks to authorize the actionsBase controller class for all KRAD document view screens working with document models.
Controller service that handles document specific actions (such as workflow actions).
Default implementation of the document controller service.
Defines methods that a
DocumentEntry Service must provide, and the API for the interacting
with Document-related entries in the data dictionaryA single Document entry in the DataDictionary, which contains information relating to the display, validation, and
general maintenance of a Document (transactional or maintenance) and its attributes
Parent interface of all document-related events, which are used to drive the business rules evaluation process.
Abstract superclass for document-related events.
Base form for all
DocumentView screensDetermines what actions are applicable to the given document, irrespective of user
or other state.
Request authorization cache object which adds caching on workflow document calls
Contains all of the business rules that are common to all documents.
This object keeps track of most of the open tags while a document is serialized.
Implementations of this interface are able to serialize documents into XML that's used by the workflow engine to perform routing, searches,
etc.
Defines various operations that support the Document framework.
View type for KRAD documents.
Implementation of
ViewAuthorizer for
DocumentView instancesView helper extension for document views.
Implementation of
ViewPresentationController for
DocumentView instancesBasic controller KRAD dummy login.
A login filter which forwards to a login page that allows for the desired
authentication ID to be entered (with testing password if option enabled)
Basic form for Dummy Login.
Exception thrown when a DataDictionary entry or definition is created using a key which is already in use.
Data object class that has generic data map.
Form class for
MockView instances that holds data in generic maps.Collection filter that evaluates a configured el expression against each line
Enum inherited from the Kuali Student project to track error levels in validation.
Collection of information regarding a single error detected within a dictionary bean
Evaluate expressions for the component.
Contains the exception incident information, exception, form and
session user.
Validation capability to constrain a value to be required or not required to be non-empty.
An existence constraint is a constraint that requires (or does not require) that some non-empty value exist for this
constrained
object or field.
Deprecated.
Provides evaluation of expression language statements against a given context
Creates instances of
ExpressionEvaluator to be managed by ViewLifecycleProcessor.Defines functions that can be used in el expressions within
the UIF dictionary files
Utility class for UIF expressions
A single attribute definition in the DataDictionary, which contains
information relating to the display, validation, and general maintenance of a
specific attribute of an entry.
Component that contains one or more user interface elements and can be placed
into a
ContainerBase class for
Field implementationsField that contains a nested
Group.Deprecated.
Performs overrides on properties of fields in a Data Dictionary bean.
The super class which implementations of the FieldOverride interface will extend.
A Field Override used to delete elements from a Data Dictionary bean.
A Field Override used to insert elements into a Data Dictionary Bean.
A Field Override used to replace list elements in a Data Dictionary bean.
A Field Override used to replace value elements from a Data Dictionary bean.
Field security adds the edit in line and view in line flags to the standard component security
ValidationMessages for logic and options specific to fields.
Represents a HTML File control, generally rendered as an input control with
type 'file'.
Controller service that provides methods for working with the multi-file upload component.
Default implementation of the file controller service.
The file object interface used by the MultiFileUpload component(s), these component(s) expect objects which
implement this interface.
Class used for interactions between the controller and form when using the multifile upload widget.
Control instance that implements a callback for processing lookup search criteria.
Defines the post data to send for filtering search results for a filterable control.
Lifecycle phase processing task for finalizing a component.
Perform custom finalize behavior for the component defined by the helper.
Validation pattern for matching fixed point numbers, optionally matching negative numbers
Validation pattern for matching floating point numbers, optionally matching negative numbers
Legacy validation capability for definitions that are constrainable to some regex or set of valid characters
and that need to impose some secondary formatting validation based on a formatter class defined.
Provides configuration for
View instances that render an HTML form.Inline FreeMarker template adaptor for supporting collectionGroup.ftl
Inline FreeMarker template adaptor for supporting collectionGroup.ftl
Register inline template processing adaptors for high-traffic KRAD templates.
Inline FreeMarker rendering utilities.
Inline FreeMarker template adaptor for supporting groupWrap.ftl
Inline FreeMarker template adaptor for supporting script.ftl
Inline FreeMarker template adaptor for supporting stacked.ftl
Inline FreeMarker template adaptor for supporting template.ftl
Field whose output is produced by invoking a method or template and has no
properties (generic)
Holds all of our thread local variables and accessors for those
Layout manager interface for grid layouts.
Layout manager that organizes its components in a table based grid
Common interface for group components.
Container that holds a list of
Field or other Group
instancesRepresents a group control, which is a special control to handle
the input of a KIM Group by group name
Holds post data for the
GroupControl.Field that encloses a link to a group element.
ValidationMessages for logic and options specific to groups.
Growls sets up settings for growls global to the current view and its pages
Content element that renders a header element and optionally a
Group to
present along with the header textRenders a link tag in the head of the html document.
Widget that renders help on a component
Interface for components that support help.
The help element provides the keys to obtain a
help description from the database.
Perform custom apply model behavior for the component defined by the helper.
Perform custom finalize behavior for the component defined by the helper.
Perform custom initialization for the component defined by the helper.
Represents a HTML Hidden control, generally rendered as an input control of
type 'hidden'.
Validation capability
A simple object that keeps track of various HistoryInformation
TODO a variety of these settings are not used in the current implementation of breadcrumbs
and history, they may be removed later if they prove unuseful in future changes
HistoryFlow represents the a flow of urls.
HistoryManager stores the map of the most recentFlows and a map of flows stored by flowId concatenated with formId.
Element that presents an Icon.
Content element that encloses an iframe
IframeView is a View component that shows another website's content in an iframe.
Content element that renders a HTML
<IMG> tagField that wraps an image content element.
This service detects whether there are any records that block the inactivation of a particular record
A service that helps to print out records that block the inactivation of another BO
This interface provides read-only metadata about inactivation blocking.
Handler for incident reports
Form class for incident reports
This class returns list of boolean key value pairs.
Lifecycle phase processing task for initializing a component.
Invoke custom initialization on the container from the view helper.
Performs initialization on data fields based on attributes found in the data dictionary.
Controller for the intiated document view.
Controller for
MaintenanceDocumentView screens which operate on
MaintenanceDocument instancesTODO mark don't forget to fill this in.
Field that encapsulates data input/output captured by an attribute within the
application
Provides the contract for implementing an inquiry within the
inquiry framework
Implementation of the
Inquirable interface that uses metadata
from the data dictionary and performs a query against the database to retrieve
the data object for inquiryWidget for rendering an Inquiry link or DirectInquiry action field
Controller for inquiry views which handle initial requests for the inquiry and
actions coming from the inquiry view such as export.
Controller service that extends
ControllerService and adds
methods specific to inquiry views.Override of navigation controller service to check if the initial inquiry needs redirected and also to
retrieve the inquiry data object on the initial call.
Form class for
InquiryView screensType of
View that provides a read-only display of a record of
data (object instance)Implementation of
ViewAuthorizer for
InquiryView instancesImplementation of
ViewPresentationController for
InquiryView instancesTODO Administrator don't forget to fill this in.
Invoke finalizer methods on the component.
A custom FreeMarker directive that adds escapes to nested content to make it valid for enclosure within a JSON
string.
Annotation that can be used on a
UifDictionaryBean field to specify any expressions configured for
that field should not be picked up and processed as normal, but left as the property value to be handled
by the component itself or some other processKeyMessage object for key-value pairs that contain rich content in the value portion.
Rice module configurer for KRAD
Service locator for the KRAD Web module
Miscellaneous Utility Methods.
This class contains the exception incident information, exception, form and
session user.
This is used for sending report of an incident
This new feedback service was added to refactor
KualiExceptionIncidentService.
Used to handle session timeouts where
PessimisticLock objects should
be removed from a documentPublic entry point by which workflow communicates status changes,
level changes, and other useful changes.
Defines the interface to the business-rule evaluation service, used to evauluate document-type-specific business
rules using document-related events to drive the process.
Content element that renders a label
Pulls
Label instances out of a contained field so they will
be placed separately in the LayoutManagerManages the rendering of
Component instances within a
ContainerBase class for all layout managers
Deprecated.
This class is deprecated by default, applications should *never*
use this adapter directly
Prevents calls to "legacy" data framework services if the legacy framework
has been disabled
Exposes legacy detection functionality statically.
Constraint that restricts the length of a string to some predefined maximum and/or minimum
List implementation for internal use by a lifecycle element.
Map implementation for internal use by a lifecycle element.
Interface to be implemented by objects that participates in the view lifecycle.
Handles delivery of per-node parse state for path-based view lifecycle algorithms.
Interface that must be implemented by components that wish to be notified of a lifecycle event.
For components that can be refreshed, builds out the various paths the lifecycle needs to be run on when
the component refresh process is run.
Encapsulates a FreeMarker environment for rendering within the view lifecycle.
Used for rendering a lightbox in the UI to display action links in dialog popups.
LightTable is a light-weight collection table implementation that supports a subset of features,
Current known supported features are:
DataField
InputField with TextControl, CheckboxControl, or single SelectControl
MessageField
LinkField
ActionField
ImageField
most RichTable options
FieldGroup containing only Actions, Image, Messages, or Links
SpringEL for String properties on supported components only
SpringEL specifically for the render property
Other features are not guaranteed to work, but may work at your own risk.
Holds components and configuration for a line during the build process.
Content element that renders a link
Field that encloses a link element.
Special
Group that presents a grouping on links, which can
also include nested groupings of linksComponents that change their template (or other logic) based on whether they are rendered in a list (as
a list item) should implement this interface.
List layout manager is a layout manager for group types to output their items as either ordered or
unordered lists.
LocationSuggest widget for providing suggestions that represent locations.
Holds post data for the location suggest component.
Provides contract for implementing a lookup within the lookup framework.
View helper service that implements
Lookupable and executes a search using the
LookupService.Override of the default collection controller service to maintain selected line state.
Controller that handles requests for a
LookupView.Controller service that provides methods for supporting a lookup view.
Default implementation of the lookup controller service.
Form class containing backing data for
LookupView.Custom
InputField for criteria fields within a lookup view that adds criteria specific options.Provides search capabilities for the lookup framework.
Provides static utility methods for use within the lookup framework.
View type for lookups.
Implementation of
ViewAuthorizer for
LookupView instancesImplementation of
ViewPresentationController for
LookupView instancesProvides contract for implementing a maintenance object within the maintenance framework
Default implementation of the
Maintainable interface.Collection filter for maintenance groups that removes inactive lines if certain
conditions are met
Common interface for all maintenance documents.
Authorizer class for
MaintenanceDocument instancesDefault implementation for
MaintenanceDocumentAuthorizer that perform KIM permission checks to authorize
the actionsDocument class for all maintenance documents which wraps the maintenance object in
a
Maintainable that is also used for various callbacksController that handles requests for a
MaintenanceDocumentView.Controller service that extends
DocumentControllerService and adds
methods specific to maintenance documents.Default implementation of the maintenance document controller service.
Data dictionary entry class for
MaintenanceDocumentForm class for
MaintenanceDocumentView screensRule event interface for implementing business rules against a maintenance document.
Contains all of the business rules that are common to all maintenance documents.
Provides methods for working with
MaintenanceDocument.View type for Maintenance documents
Provides static utility methods for use within the maintenance framework
Implementation of
ViewAuthorizer for
MaintenanceDocumentView instancesImplementation of
ViewPresentationController for
MaintenanceDocumentView instancesThis abstract class can be extended by constraint processor classes that
must be processed on every validation.
a simple values finder that uses a map as the key/value source.
The displayMask element specifies the type of masking to
be used to hide the value from un-authorized users.
Defines interface for a class that mask data values
The maskLiteral element is used to completely hide the field value for
unauthorized users.
The maskTo element is to used hide the beginning part of the value for
unauthorized users.
Holds the text and metadata for a message that will be given by the system, including validation
messages, UI text (labels, instructions), and other text that has been externalized from the
system
Encapsulates a text message to be displayed
Dictionary bean processor that retrieves external messages for bean definitions and alters the bean
definitions to use the external text
Field wrapper for a Message.
API for message providers
Message Service API
Implementation of the
MessageService that allows MessageProvider implementations
to be configured for exposing external message repositoriesRich message structure utilities for parsing message content and converting it to components/content
View that presents a message to the user (for example an application error message)
A very simple implementation of
PropertySerializabilityEvaluator which simply uses the
provided PropertySerializerTrie as metadata to define what should be serialized.Renders a meta tag in the head of the html document.
Runtime exception thrown when a controller method is requested that is not accessible.
Annotation to indicate a controller method should allow access regardless of view configuration.
Extends
MethodInvoker to add properties for specifying
a method for invocation within the UIFView class for developing UI mocks.
Controller class for handling requests for
MockView instances.Service that provides helper methods for building
ModelAndView instances
and also other controller helper methods such as showing a dialog, a message view, or redirecting.Default implementation of the model and view service.
This class contains various configuration properties for a Rice module.
Loads the module locked view when a user accesses a module which has been locked for maintenance
Interceptor which checks whether the module the request was made for is locked and if so forwards the
request to the module locked controller
Defines service methods for module services
Base implementation of the module service
Comparator used for server side sorting of CollectionGroup data.
A content element that will display the collection configured with a file upload button.
Indicates
Control types that can hold more than one value for selectionBase class for controls that accept/display multiple values
Validation capability to constrain an object to has some specified acceptable number of prerequisite constraints
nested
within must occur constraints.
Must occur constraints are constraints that indicate some range of acceptable valid results.
An object that returns the list of must occur constraints for a definition implementing the capability
MustOccurConstrainable.Component that renders a navigation bar, including a branding and navigation group.
Controller service that provides methods for navigating within the application and a view.
Default implementation of the navigation controller service.
The NextPager widget is used to display previous and next links.
Configures nodes for a
TreeGroupA session listener that detects when a non-serializable attributes is added to session.
The NumberedPager widget is used to display a list of links horizontally in a page selection user interface.
Pattern for matching numeric characters, difference between NumericPatternConstraint and IntegerPatternConstraint
is that a numeric pattern constraint is for matching numeric characters and can be mixed with other characters
by setting allow flags on, while integer is for only positive/negative numbers
Provides modular support parsing path expressions using Spring's BeanWrapper expression Syntax.
Path entry interface for use with
ObjectPathExpressionParser.parsePathExpression(Object, String, PathEntry).Represents a property reference in a path expression, for use in implementing
ObjectPathExpressionParser.PathEntry.Utility methods to get/set property values and working with objects.
OptionListControl is used for listing out options from an option finder or options list.
Extends
Ordered interface to add setter for the order propertyBreadcrumbOptions specific to page.
Interface for top-level page components, to be used as items in a multi-page view.
A PageGroup represents a page of a View.
Pager widgets are used to page a set of information which has multiple pages.
ValidationMessages for logic and options specific to pages.
ParentLocation is used to provide automatic generation/determination of Views/Pages that occur before the current
View.
Represents a HTML password text control, rendered as a input field of type
'password'.
This class is a Generic ValuesFinder that builds the list of KeyValuePairs it returns
in getKeyValues() based on a BO along with a keyAttributeName and labelAttributeName
that are specified.
Service interface for documents to use the Pessimistic Locking mechanism
Push attributes to the component context.
Populate property values on the component from the expression graph.
Assigns a lifecycle element's path property
, based on the paths to the element from
LifecycleElement.setViewPath(String) and
invalid reference
LifecycleElement#setPath(String)LifecycleElementState.Populate property values on the all property replacers and component modifiers from the
expression graph.
This interface is a KFS-local wrapper for the Workflow postprocessor interface.
Invokes
on the lifecycle element.
invalid reference
Copyable#preventModification()Lifecycle phase implementation representing the pre-process phase.
Validation capability to constrain a value by requiring that some other attribute value be non-empty.
Prerequisite constraints require that some other attribute be non-empty in order for the constraint to be valid.
An object that returns the list of prerequisite constraints for a definition implementing the capability
PrerequisiteConstrainable.The primitiveAttribute element identifies one pair of
corresponding fields in the primary business object and
the related business object.
Performance monitoring log utility.
defines the information expected when a processor has processed a constraint
Process any remote fields holder that might be in the containers items.
Element which shows a visual progress bar based on percentageValue passed in or segmentPercentages passed in
Field wrapper for the ProgressBar element
Configuration for replacing a property value based on a condition
Specifies an implementation used during document workflow XML serialization that
will be able to determine whether a specific property is serializable
This abstract implementation provides a default implementation of
PropertySerializabilityEvaluatorBase.determinePropertyType(Object), which should suffice for most
use cases.This class represents metadata about the serializibility of a property during the document serialization proces..
See docs for the elements of this enum
This is a implementation of a trie/prefix tree of that contains metadata about property serializability
during the document serialization process.
A node in the trie.
Represents various types a property may be.
Controller service that provides handling for query methods suggest as performing a lookup, field suggest,
and field query.
Default implementation of the query controller service.
Widget for navigating to a lookup from a field (called a quickfinder).
Represents a group of HTML Radio controls.
A range constraint that restricts a value to a specified range
RangeConstraintProcessor enforces range constraints - that is, constraints that keep a number or a date within a
specific range
Simple utility class for implementing an object recycling factory pattern.
Annotation for
Component fields to indicate only the property
reference should be made (as opposed to a new object) when doing a component
copyThe reference element specifies the name of a reference
object that is required to exist in order for the primary
business object to be created or modified on a BO.
Controller service that handles the refresh method.
Default implementation of the refresh controller service.
If the data field has a configured property editor registers the editor with the view
post metadata.
A single Relationship definition in the DataDictionary, which contains information concerning which primitive
attributes of this
class can be used to retrieve an instance of some related Object instance
The relationship element defines how primitive attributes of this
class can be used to retrieve an instance of some related Object instance
DD: See RelationshipDefinition.java.
A placeholder in the configuration for a
Container list of items that will be invoked to
retrieve a list of RemotableAttributeField instances which will then be inserted into the containers
list at the position of the holderLifecycle phase processing task for rendering a component.
Perform actual rendering on a component during the lifecycle.
Annotation for binding to indicate a property is accessible (allows updates).
Provides cache objects for KIM authorization during a single request
Annotation for
View fields to indicate the field can be set by a
parameter of the initial requestAnnotation for binding to indicate a property is protected (should not allow updates).
Implementation of
MessageProvider that stores messages in resource filesThis class exists because rice uses a custom version of freemarker that is incompatible with Spring 4.
Decorates a HTML Table client side with various tools
Field that encloses a link to a role element.
This class represents the route event that is part of an eDoc in Kuali.
Defines a rule which gets invoked immediately before a document gets routed.
class representing the rule event to process a business rule
Created by nigupta on 4/28/2014.
View lifecycle task to run component modifiers based on the lifecycle phase.
Controller service that handles saves.
Default implementation of the save controller service.
Rule event generated for a save of a document instance.
Defines a rule which gets invoked immediately before a document gets saved.
Interface for events that can be applied on a save operation.
This class represents the save event that is part of an eDoc in Kuali.
Declares methods for retrieving the event script code
Utility class for generating JavaScript
Decorates a group with scroll functionality.
Control interface for a select box.
Represents a HTML Select control.
This object keeps track of most of the open tags while a document is serialized.
This is a marker interface for implementing session in document.
Controller class for the session timeout view.
Form class for the session timeout view.
Marker annotation for session transient fields on the UifForm
Sets data bindings to read-only at the end of the apply model phase.
A navigation group which renders a menu with items, that is shown at the side of the page with collapse.
Constrainable interface for the SimpleConstraint constraint
A simple constraint stores 'basic' constraints for a field.
Processor for simple constraint which takes out each constraining value it contains and calls the appropriate
processor
Layout manager that just renders the items one after another (no wrapping occurs).
An object that represents a simple suggestion with a label, value, and href.
An object that represents a simple suggestion with a label and a value.
This class allows a single attribute value to be exposed to the validation service, along
with some guidance about how that value should be interpreted, provided by the AttributeDefinition
that corresponds.
Indicates
Control types that have a size propertySort items in a container
The defaultSort element specifies the sequence in which the lookup search results should be displayed
Content element that renders a non-breaking space HTML
tagField that produces only a space
Widget that decorates a control transforming into a spinner
Text control that as decorated with a spinner widget (allowing the control value to be modified using the
spinner)
Layout manager interface for stacked collections.
Layout manager that works with
CollectionGroup containers and
renders the collection lines in a vertical rowStateMapping defines the methods necessary to allow for state validation to apply to a state object
Base implementation of StateMapping.
Element which shows a visual progress bar alongside a set of steps, to be used by wizard or multi-step
processes, which reflects the current progress based on value of currentStep.
Converts a string configured in the dictionary for a list property type to a List
object using the convention of commas to separate list entries
Deprecated.
Converts a string configured in the dictionary for a map property type to a Map
object using the convention of commas to separate map entries and a colon to separate
the key value pair
Adjusts the id for elements that are within a component configured with a suffix to apply for
all children (such as components that are within a collection line).
Widget that provides dynamic select options to the user as they are entering the value (also known
as auto-complete).
Holds post data for the suggest component.
Support attributes define additional attributes that can be used to generate
lookup field conversions and lookup parameters.
Synchronize client side state for the component.
Single-threaded view lifecycle processor implementation.
Widget that renders text syntax highlighted
A group that presents its child Groups as tabs.
Layout manager that works with
CollectionGroup components and renders the collection as a
Table.Implementation of table layout manager.
Holds the components that make up a row within the table layout.
Builds out a collection line into a table row.
Special
Group that renders a tab navigation sectionWidget used for configuring tab options, use componentOptions for most options.
Represents a HTML TextArea control.
Interface representing a text input control component.
Represents a HTML Text control, generally rendered as a input field of type
'text'.
Renders a toggle menu (aka sub menu, dropdown menu) of items.
Widget that renders a Tooltip on a component.
Interface for all documents that have transactional behavior.
Extension to DocumentAuthorizer interface which adds transactional document specific methods
Base class for all Transactional Document authorizers.
Base class for transactional documents
Controller service that extends
DocumentControllerService and adds
methods specific to transactional documents.Default implementation of the transactional document controller service.
Data dictionary entry class for
TransactionalDocument.Form class for
TransactionalView screensExtension to DocumentPresentationController interface which adds transactional document specific methods
Document presentation controller implementation for transactional documents.
Contains business rules that are common to all transactional documents.
View type for Transactional documents.
Extends
DocumentViewAuthorizerBase to add additional authorization behavior to Transactional documents.Extension to DocumentViewPresentationControllerBase interface which adds transactional document specific methods
Spring interceptor class that will start the Rice configured transaction on pre handle (before binding
and controller) and commit after controller execution.
Widget component for rendering a Tree
Group component that is backed by a
Tree data structure and typically
rendered as a tree in the user interfacePost processes the bean factory to handle UIF property expressions and IDs on inner beans
Bean wrapper that will auto grow paths for setting the value but not grow paths for getting
a value.
UIF handler for binding processing errors
PropertyEditor for booleans supports y/n which the spring version does not
PropertyEditor converts between date display strings and
java.util.Calendar objects using the
org.kuali.rice.core.api.datetime.DateTimeService.Controller that receives various ajax requests from the client to manager server side state
Registers standard PropertyEditors used in binding for all http requests.
General constants used within the User Interface Framework.
Enum of return types.
Base controller class for views within the KRAD User Interface Framework.
Spring controller intercepter for KRAD controllers.
Class is used to format
org.kuali.rice.core.api.util.type.KualiDecimal in the local
currencyPropertyEditor converts between date display strings and
java.sql.Date objectsPropertyEditor converts between timestamp display strings and @{DateTime} objects.
This service helps build/define default controls for the UIF based on the associated data-level metadata.
Marks any class that can be configured through the UIF dictionary
Common base class for dictionary objects that can contain dynamic expressions within the
property value
Indexes
View bean entries for retrieval.Property editor which encrypts values for display and decrypts on binding, uses the
EncryptionService to perform the encryptionController that handles table export requests.
Base form class for views within the KRAD User Interface Framework.
Manages Uif form objects for a session.
Spring Exception intercepter
Extension of key value for use within the UIF.
KeyValue that has an additional location property that takes a Url object.
Values finder that can taken the
ViewModel that provides data to the view
for conditionally setting the valid optionsClass used to format
org.kuali.rice.core.api.util.type.KualiInteger in the local currencyKeyValue that has an additional label property for hierarchical dropdowns.
Constants for parameter names that need to be retrieved from general
Map implementations (like the request, action parameters map,
component template options, component layout options)PropertyEditor converts between percentage strings and
org.kuali.rice.core.api.util.type.KualiPercent objectsConstants for property paths.
Collection of helper methods that can be exposed to a render engine.
Override of request mapping handler apapter to create a custom binder factory.
Overriding of provided spring handler mapping to allow controllers with the same mapping to exist, and override
if necessary.
Override of ServletRequestDataBinder in order to hook in the UifBeanPropertyBindingResult
which instantiates a custom BeanWrapperImpl, and to initialize the view.
Handles session timeouts for KRAD views based on the configured view session policy
PropertyEditor converts between time display strings and
java.sql.Time objectsPropertyEditor converts between date display strings and
java.sql.Timestamp objects using the
org.kuali.rice.core.api.datetime.DateTimeServiceClass is a top level BeanWrapper for a UIF View Model.
Holds preloaded view instances up to a configured size
Use this when the data dictionary cannot find a matching business object's attribute entry for a populated business
object that
runs through the data dictionary validation service and its methods.
This class represents an UnknownDocumentTypeException.
This object represents a url in the Krad framework.
Represents a user control, which is a special control to handle the input of a Person.
Holds post data for the
UserControl.Field that encloses a link to a person element.
A filter for processing user logins and creating a
UserSessionPattern for matching any printable character
A combination view controller for the Rice Dictionary Validator that handles both the setup/execution of the
validation and the output of the results.
Field that displays error, warning, and info messages for the keys that are
matched.
Deprecated.
exception thrown when a ValidationPattern is in an incorrect state.
Linear collection of identifiers for individual Spring Beans starting with the base bean and ending with the most
recent.
ValidationUtils provides static utility methods for validation processing
defines possible result values of a comparison operation
A validator for Rice Dictionaries that stores the information found during its validation.
Validation capability that tests a value against some regular expression or set of valid characters.
This is a constraint that limits attribute values to some subset of valid characters or to match a particular
regular
expression.
This class defines a constraint processor to ensure that attribute values are constrained to valid characters, as
defined by some regular expression.
An object that returns the valid characters constraint as a list for a definition implementing the capability
ValidCharactersConstrainable.This abstract class extends from ValidCharactersConstraint.
Indicates
Control types that can be configured with a static value to submit, as opposed to pulling
the value from the underlying propertyRoot of the component tree which encompasses a set of related
GroupContainer instances tied together with a common page layout
and navigation.
AttributeValueReader which can read the correct values from all InputFields which exist on the View
Performs user based authorization for actions and components contained in a
ViewImplementation of
ViewAuthorizer that verifies authorization with KIM permission checksProvides methods to query the dictionary meta-data for view entries and their
corresponding component entries
The ViewHeader component represents the header for the view.
Provides customization methods at various points of the view lifecycle.
Default Implementation of
ViewHelperServiceHolds component indexes of a
View instance for convenient retrieval during the lifecycle.Lifecycle object created during the view processing to hold event registrations.
Enumerates potential lifecycle events.
Perform the lifecycle process for the view or a component.
Represents a phase in the view lifecycle.
Base abstract implementation for a lifecycle phase.
Encapsulates the concept of creating
ViewLifecyclePhase instances during a the view
lifecycle build process.Default phase builder implementation.
Performs the pre-process phase on a view, for use prior to caching.
Interface for controlling the execution of the view lifecycle.
Abstract base lifecycle processor implementation.
Annotation for
LifecycleElement bean properties to restrict which view
lifecycle phases for which the property will be considered while initializing the successor phase queue.Represents a discrete task within the view lifecycle.
Base abstract implementation for a lifecycle task.
Utilities for working with
LifecycleElement instances.Interface that must be implemented for classes the provide the backing data (model) for a
View.Provides methods for getting property values, types, and paths within the
context of a
ViewHolds data about the rendered view that might be needed to handle a post request.
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 userImplementation of
ViewPresentationController that implements no logic by defaultProvides service methods for retrieving and updating
View instances.Holds configuration related to session handling of a view (and its related form)
Holds a configuration of CSS and JS assets that provides the base for one or more views.
Holds view index information for a view type, where the index keys are built
from the supported view type parameters
Provides methods handing
View instance of certain typesValidation service for KRAD views.
WhenConstraint is a child of a CaseConstraintComponents that provide a user interface function (besides the basic form
handing) should implement the widget interface
Base class for Widgets
A container that holds all of the
WorkflowAttributeDefinition for a document for both document searches
and routing that depends on the values that exist on the document.This interface defines the contract that must be implemented by the workflow engine.
This element is used to define a set of workflowPropertyGroups, which are used to
specify which document properties should be serialized during the document serialization
process.
This class represents an serializable property when generating workflow routing XML.
Allows for grouping of related
WorkflowProperty objects