Package org.kuali.rice.krad.messages

Class Message

java.lang.Object
org.kuali.rice.krad.bo.DataObjectBase
org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter
org.kuali.rice.krad.messages.Message
All Implemented Interfaces:
Serializable, Cloneable, org.eclipse.persistence.descriptors.changetracking.ChangeTracker, org.eclipse.persistence.internal.descriptors.PersistenceEntity, org.eclipse.persistence.internal.descriptors.PersistenceObject, org.eclipse.persistence.internal.weaving.PersistenceWeaved, org.eclipse.persistence.internal.weaving.PersistenceWeavedChangeTracking, org.eclipse.persistence.internal.weaving.PersistenceWeavedFetchGroups, org.eclipse.persistence.internal.weaving.PersistenceWeavedRest, org.eclipse.persistence.queries.FetchGroupTracker, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned
@Entity public class Message extends org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter
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
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Summary

    Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

    extension, newCollectionRecord

    Fields inherited from class org.kuali.rice.krad.bo.DataObjectBase

    _persistence_cacheKey, _persistence_fetchGroup, _persistence_href, _persistence_links, _persistence_listener, _persistence_primaryKey, _persistence_relationshipInfo, _persistence_session, _persistence_shouldRefreshFetchGroup, objectId, versionNumber

  • Constructor Summary

    Constructors
    Constructor
    Description
    Message()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComponentCode()
    A code within the namespace that identifies a component or group, used for further grouping of messages within the namespace
    String
    getDescription()
    A description for the message
    String
    getKey()
    A key that uniquely identifies the message within the namespace and component
    String
    getLocale()
    Locale code the message is represented for, used for supporting messages in different languages
    String
    getNamespaceCode()
    Namespace code (often an application or module code) that message is associated with, used for grouping messages
    String
    getText()
    Text value for the message
    void
    setComponentCode(String componentCode)
    Setter for the component code the message should be associated with
    void
    setDescription(String description)
    Setter for the message description
    void
    setKey(String key)
    Setter for the message key
    void
    setLocale(String locale)
    Setter for the message locale code
    void
    setNamespaceCode(String namespaceCode)
    Setter for the namespace code the message should be associated with
    void
    setText(String text)
    Setter for the message text
    final String
    toString()
    Generate toString using message key fields

    Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBaseAdapter

    _persistence_get, _persistence_new, _persistence_post_clone, _persistence_set, buildListOfDeletionAwareLists, getExtension, getLegacyDataAdapter, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord

    Methods inherited from class org.kuali.rice.krad.bo.DataObjectBase

    _persistence_checkFetched, _persistence_checkFetchedForSet, _persistence_get_objectId, _persistence_get_versionNumber, _persistence_getCacheKey, _persistence_getFetchGroup, _persistence_getHref, _persistence_getId, _persistence_getLinks, _persistence_getPropertyChangeListener, _persistence_getRelationships, _persistence_getSession, _persistence_isAttributeFetched, _persistence_propertyChange, _persistence_resetFetchGroup, _persistence_set_objectId, _persistence_set_versionNumber, _persistence_setCacheKey, _persistence_setFetchGroup, _persistence_setHref, _persistence_setId, _persistence_setLinks, _persistence_setPropertyChangeListener, _persistence_setRelationships, _persistence_setSession, _persistence_setShouldRefreshFetchGroup, _persistence_shallow_clone, _persistence_shouldRefreshFetchGroup, generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, prePersist, preUpdate, setExtensionObject, setObjectId, setVersionNumber

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.eclipse.persistence.internal.descriptors.PersistenceObject

    _persistence_shallow_clone

  • Constructor Details

    • Message

      public Message()

  • Method Details

    • getNamespaceCode

      public String getNamespaceCode()
      Namespace code (often an application or module code) that message is associated with, used for grouping messages
      Returns:
      String namespace code

    • setNamespaceCode

      public void setNamespaceCode(String namespaceCode)
      Setter for the namespace code the message should be associated with
      Parameters:
      namespaceCode -

    • getComponentCode

      public String getComponentCode()
      A code within the namespace that identifies a component or group, used for further grouping of messages within the namespace

      Examples here could be a bean id, the class name of an object, or any application/module defined code

      Returns:
      String representing a component code

    • setComponentCode

      public void setComponentCode(String componentCode)
      Setter for the component code the message should be associated with
      Parameters:
      componentCode -

    • getKey

      public String getKey()
      A key that uniquely identifies the message within the namespace and component

      Within the UIF, this is generally used to indicate the property path the message is associated with (for example: "control.label"). For validation messages this is generally a combination that identifies the type of validation message and the validation performed (for example: "error.account.missing")

      Returns:
      String message key

    • setKey

      public void setKey(String key)
      Setter for the message key
      Parameters:
      key -

    • getLocale

      public String getLocale()
      Locale code the message is represented for, used for supporting messages in different languages
      Returns:
      message locale code

    • setLocale

      public void setLocale(String locale)
      Setter for the message locale code
      Parameters:
      locale -

    • getDescription

      public String getDescription()
      A description for the message

      Not used by the framework, here for purposes of editing of messages and providing a description of the message to users

      Returns:
      String message description

    • setDescription

      public void setDescription(String description)
      Setter for the message description
      Parameters:
      description -

    • getText

      public String getText()
      Text value for the message

      This holds the actual text for the message which is what will be displayed. Depending on how the message is being used it might contain parameters or other special syntax

      Returns:
      String text for the message

    • setText

      public void setText(String text)
      Setter for the message text
      Parameters:
      text -

    • toString

      public final String toString()
      Generate toString using message key fields
      Overrides:
      toString in class org.kuali.rice.krad.bo.DataObjectBase
      Returns:
      String representing the message object