com.remedy.arsys.api
Class LocalizedRequestInfo

java.lang.Object
  com.remedy.arsys.api.LocalizedRequestInfo

All Implemented Interfaces:

java.lang.Cloneable

public class LocalizedRequestInfo

extends java.lang.Object

implements java.lang.Cloneable

The LocalizedRequestInfo class is used to describe the properties of a message. This class is used in retrieving the message text of a message object.

The following table lists the specific parameters you need to set with each message type, while retrieving the message text corresponding to the locale given in the content information.

Message Type setMessageType(int)	Accompanying Items You Need To Include To Be Localized
System Message AR_LOCAL_TEXT_SYSTEM_MESSAGE	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_SYSTEM_MESSAGE. Set the name of the system message (setName(NameID)).
Active Link Message AR_LOCAL_TEXT_ACT_LINK_MESSAGE	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_ACT_LINK_MESSAGE. Set the name of the system message (setName(NameID)). Set whether the action belongs to If actions list or Else actions list (setIfElse(int)). Set the number of the action in its list (setAction(int)).
Filter Message AR_LOCAL_TEXT_FILTER_MESSAGE	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_FILTER_MESSAGE. Set the name of the system message (setName(NameID)). Set whether the action belongs to If actions list or Else actions list (setIfElse(int)). Set the number of the action in its list (setAction(int)).
Active Link Help Text AR_LOCAL_TEXT_ACT_LINK_HELP	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_ACT_LINK_HELP. Set the name of the active link (setName(NameID)) that you want the help for.
Form Help Text AR_LOCAL_TEXT_FORM_HELP	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_FORM_HELP. Set the name of the form (setName(NameID)) that you want the help for.
Field Help Text AR_LOCAL_TEXT_FIELD_HELP	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_FIELD_HELP. Set the name of the form (setName(NameID)) that the field exists on. Set the field ID (setInternalID(InternalID internalID)) you want the help for.
Container Description AR_LOCAL_TEXT_CONTAIN_DESC	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_CONTAIN_DESC. Set the name of the container (setName(NameID)) that you want the description for.
List Menu Definition AR_LOCAL_TEXT_SYSTEM_MESSAGE	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_SYSTEM_MESSAGE. Set the name of the menu (setName(NameID)). You will be returned a block of text that is the format for the file-style menu.
External Report AR_LOCAL_TEXT_EXTERN_REPORT	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_EXTERN_REPORT. Set the name of the active link (setName(NameID)) associated with the external report. Set the field ID (setInternalID(InternalID internalID)) as the file ID of the external report. You will be returned a bytelist that consists of the report definition.
Container Label AR_LOCAL_TEXT_CONTAINER_LABEL	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_CONTAINER_LABEL. Set the name of the container (setName(NameID)) that you want the label for.
Container Help Text AR_LOCAL_TEXT_CONTAINER_HELP	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_CONTAINER_HELP. Set the name of the container (setName(NameID)) that you want the help for.
Application Help Text AR_LOCAL_TEXT_APPLICATION_HELP	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_APPLICATION_HELP. Set the name of the application (setName(NameID)).
Application About AR_LOCAL_TEXT_APPLICATION_ABOUT	Set the message type (setMessageType(int)) to AR_LOCAL_TEXT_APPLICATION_ABOUT. Set the name of the application (setName(NameID)). You will be returned a bytelist that consists of the About Box bitmap.

Constructor Summary

LocalizedRequestInfo()

LocalizedRequestInfo(NameID name, int messageType)

LocalizedRequestInfo(NameID name, int messageType, InternalID internalID)

LocalizedRequestInfo(NameID name, int messageType, int ifelse, int action)

LocalizedRequestInfo(NameID name, int messageType, int ifelse, int action, InternalID internalID)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
int	getAction() Returns the order of the actions in the If/Else list.
int	getIfElse() Returns whether the action is the If list or the Else list.
InternalID	getInternalID() Returns internal IDs for field IDs.
int	getMessageType() Returns the message type.
NameID	getName() Returns name of message.
void	setAction(int action) Sets the order of the actions in the If/Else list.
void	setIfElse(int ifelse) Sets whether the action is the If list or the Else list.
void	setInternalID(InternalID internalID) Sets internal IDs for field IDs.
void	setMessageType(int messageType) Sets the message type.
void	setName(NameID name) Sets name of message.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizedRequestInfo

public LocalizedRequestInfo()

LocalizedRequestInfo

public LocalizedRequestInfo(NameID name,
                            int messageType)

LocalizedRequestInfo

public LocalizedRequestInfo(NameID name,
                            int messageType,
                            int ifelse,
                            int action)

LocalizedRequestInfo

public LocalizedRequestInfo(NameID name,
                            int messageType,
                            InternalID internalID)

LocalizedRequestInfo

public LocalizedRequestInfo(NameID name,
                            int messageType,
                            int ifelse,
                            int action,
                            InternalID internalID)

Method Detail

getName

public NameID getName()

Returns name of message.

setName

public void setName(NameID name)

Sets name of message.

getMessageType

public int getMessageType()

Returns the message type. (This is the Message Type field in AR System Message Catalog schema.) You can use the following constants:

• Constants.AR_LOCAL_TEXT_SYSTEM_MESSAGE 0
• Constants.AR_LOCAL_TEXT_ACT_LINK_MESSAGE 1
• Constants.AR_LOCAL_TEXT_FILTER_MESSAGE 2
• Constants.AR_LOCAL_TEXT_ACT_LINK_HELP 3
• Constants.AR_LOCAL_TEXT_FORM_HELP 4
• Constants.AR_LOCAL_TEXT_FIELD_HELP 5
• Constants.AR_LOCAL_TEXT_CONTAIN_DESC 6
• Constants.AR_LOCAL_TEXT_LIST_MENU_DEFN 7
• Constants.AR_LOCAL_TEXT_EXTERN_REPORT 8
• Constants.AR_LOCAL_TEXT_CONTAINER_LABEL 9
• Constants.AR_LOCAL_TEXT_CONTAINER_HELP 10
• Constants.AR_LOCAL_TEXT_APPLICATION_HELP 11
• Constants.AR_LOCAL_TEXT_APPLICATION_ABOUT 12
• Constants.AR_LOCAL_TEXT_APPLICATION_HELP_INDEX 13
• Constants.AR_LOCAL_TEXT_FLASHBRD_MESSAGE 14
• Constants.AR_LOCAL_TEXT_FLASHBRD_LABEL 15

setMessageType

public void setMessageType(int messageType)

Sets the message type. (This is the Message Type field in AR System Message Catalog schema.) You can use the following constants:

• Constants.AR_LOCAL_TEXT_SYSTEM_MESSAGE 0
• Constants.AR_LOCAL_TEXT_ACT_LINK_MESSAGE 1
• Constants.AR_LOCAL_TEXT_FILTER_MESSAGE 2
• Constants.AR_LOCAL_TEXT_ACT_LINK_HELP 3
• Constants.AR_LOCAL_TEXT_FORM_HELP 4
• Constants.AR_LOCAL_TEXT_FIELD_HELP 5
• Constants.AR_LOCAL_TEXT_CONTAIN_DESC 6
• Constants.AR_LOCAL_TEXT_LIST_MENU_DEFN 7
• Constants.AR_LOCAL_TEXT_EXTERN_REPORT 8
• Constants.AR_LOCAL_TEXT_CONTAINER_LABEL 9
• Constants.AR_LOCAL_TEXT_CONTAINER_HELP 10
• Constants.AR_LOCAL_TEXT_APPLICATION_HELP 11
• Constants.AR_LOCAL_TEXT_APPLICATION_ABOUT 12
• Constants.AR_LOCAL_TEXT_APPLICATION_HELP_INDEX 13
• Constants.AR_LOCAL_TEXT_FLASHBRD_MESSAGE 14
• Constants.AR_LOCAL_TEXT_FLASHBRD_LABEL 15

getIfElse

public int getIfElse()

Returns whether the action is the If list or the Else list.

• For If messages, returns a 0 (zero).
• For Else messages, returns a 1.

setIfElse

public void setIfElse(int ifelse)

Sets whether the action is the If list or the Else list.

• For If messages, enter a 0 (zero).
• For Else messages, enter a 1.

getAction

public int getAction()

Returns the order of the actions in the If/Else list. 0 = first action, 1 = 2nd action, and so on.

setAction

public void setAction(int action)

Sets the order of the actions in the If/Else list. 0 = first action, 1 = 2nd action, and so on.

getInternalID

public InternalID getInternalID()

Returns internal IDs for field IDs. Also used for file IDs of external reports.

setInternalID

public void setInternalID(InternalID internalID)

Sets internal IDs for field IDs. Also used for file IDs of external reports.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Throws:

java.lang.CloneNotSupportedException