com.sap.it.commons.logging.Message Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odata-core Show documentation

SAP Cloud Platform SDK for service development

The newest version!

package com.sap.it.commons.logging;

import com.sap.it.commons.layering.SubsystemPart;

/**
 * Instances of this type represent a log message. A log message carries an id
 * and belongs to a log message category (within a log message group). Log
 * Message instances must be implemented in an enumeration implementing this
 * interface. The text of the log message must be contained in a property file
 * which resides in the same package as the log message enumeration.
 * 
 * 
 * @author d025635
 * 
 */
public interface Message {
    /**
     * returns the log message identifier. It is the key of the corresponding
     * message entry in the resource bundle {@link #getResourceBundleName()}
     * 
     * @return log message id
     */
    public String getMessageId();

    /**
     * returns the log message subsystem part this log message belongs to
     * {@link SubsystemPart}
     * 
     * @return SubsystemPart
     */
    public SubsystemPart getSubsystemPart();

    /**
     * Returns the developer text for this message. (In SAP terms the
     * 0th-translation).
     * 
     * @return messageText
     */
    public String getMessageText();

}