MessageInfo

Name MessageInfo
Usage MessageService
getMessage getMessages getMessagesByGroups updateMessage addMessage
Type Complex

Description

Refer to interface javadoc

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
key Key String Unique key to this object. Unlike an Id this key can be
explicitly set by the application and is intended to be
"somewhat" readable by a human.

A Key:


  • A Key is used when the actual value is important

  • A Key value might be kuali.org.School

  • A Key on occasion may be used or seen by an end
    user.

  • Keys are assumed to have the same values in different KS
    implementations

  • Key values are defined in configuration

  • Key values have significance in that they are referenced
    in Configuration

  • Key values are expected to be occasionally used in
    application code



Once an object is created with the specified key it cannot be
changed. Instead the object must be deleted or in-activated and
a new object created with the right key.		 Required on updates Read only on updates One No  
locale Locale LocaleInfo The Locale. Required   One No  
groupName Group Name String Unique identifier for a message group Required   One No  
value Value String The string representation of the message. Symbols may be included within
the message, but the expectation is that the caller is aware of the
format of these symbols.		 Required   One No