com.remedy.arsys.api
Class Util

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

public class Util

extends java.lang.Object

The Util class combines all the functions not related to specific server objects into a "catch-all" class.

For all the methods in the Util class, there is a corresponding C API function. You can read full descriptions of their functionality in the C API Reference Guide.

Constructor Summary

Util()

Method Summary

static void	ARBeginBulkEntryTransaction(ARServerUser context) Marks the beginning of a bulk entry transaction.
static CharMenuInfo	ARConvertStringToListMenu(ARServerUser context, java.lang.String menuString) Converts a string to a CharMenuInfo object
static EntryID	ARCreateAlertEvent(ARServerUser context, AccessNameID user, java.lang.String alertText, int priority, NameID sourceTag, ServerNameID server, NameID formName, java.lang.String objectId) Enters an alert event into the system.
static AlertMessageInfo	ARDecodeAlertMessage(ARServerUser context, AlertMessageCriteria criteria, java.lang.Object message, int length) Decode supplied alert message and return component parts.
static AssignInfo	ARDecodeARAssignStruct(ARServerUser ctx, java.lang.String assignString) Decode of ARAssignStruct.
static QualifierInfo	ARDecodeARQualifierStruct(ARServerUser ctx, java.lang.String queryString) Decode of ARQualificationStruct.
static DiaryInfo[]	ARDecodeDiary(ARServerUser ctx, java.lang.String str) Takes a diary string as input and decodes it into an ARDiaryList for easier processing.
static StatusHistoryInfo[]	ARDecodeStatusHistory(ARServerUser ctx, java.lang.String str) Takes a status history string as input and decodes it into an ARStatusHistoryList.
static void	ARDeregisterForAlerts(ARServerUser context, int clientPort) Deregister a client with the server so they no longer receive alert indicators.
static java.lang.String	AREncodeARAssignStruct(ARServerUser ctx, AssignInfo asn) Encode of ARAssignStruct.
static java.lang.String	AREncodeARQualifierStruct(ARServerUser ctx, QualifierInfo qual) Encode of ARQualificationStruct.
static java.lang.String	AREncodeDiary(ARServerUser ctx, DiaryInfo[] diary) Takes an ARDiaryList as input and encodes it into a diary string.
static java.lang.String	AREncodeStatusHistory(ARServerUser ctx, StatusHistoryInfo[] statHist) Takes an ARStatusHistoryList as input and encodes it into a status history string.
static BulkEntryReturn[]	AREndBulkEntryTransaction(ARServerUser context, int actionType) Marks the ending of a bulk entry transaction.
static ProcessResult	ARExecuteProcess(ARServerUser context, java.lang.String command, boolean waitFlag) Performs the indicated command on the specified server.
static ProcessResult	ARExecuteProcessForActiveLink(ARServerUser context, NameID actlinkName, int actionIndex, int actionType, InternalID fieldId, Timestamp timestamp, EntryItem[] keywordList, EntryItem[] parameterList, boolean waitFlag) Executes a process on the server.
static java.lang.String	ARExport(ARServerUser context, StructItemInfo[] items, NameID displayTag, int vuiType, WorkflowLockInfo lockInfo) Exports the indicated structure definitions from the specified server to a buffer.
static int	ARGetAlertCount(ARServerUser context, QualifierInfo qual) Gets number of alert events that meet the specified criteria.
static HostID[]	ARGetAllLocalHostIDs(ARServerUser context) Get all local HostID's.
static java.lang.String	ARGetApplicationRequestedInfo(ARServerUser context, java.lang.String str) For internal use only.
static java.lang.String	ARGetClientCharSet(ARServerUser context) Returns the clients char set as a string.
static CompactQueryResult	ARGetCompactEntryList(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCriteria, java.lang.Integer nMatches) AR System internal use only.
static java.math.BigDecimal	ARGetCurrencyRatio(java.lang.String currencyRatioSet, java.lang.String fromCurrencyCode, java.lang.String toCurrencyCode) Search through a supplied currency ratios string to find an entry that matches the requested currency codes.
static void	ARGetEntryBlob(ARServerUser context, NameID schemaID, EntryID entryID, FieldID fldID, AttachmentInfo attach) Returns the attachment, or binary large object (blob), stored for the attachment field with the indicated ID on the specified server.
static StatisticsResultInfo[]	ARGetEntryStatistics(ARServerUser context, SchemaKey schemaKey, QualifierInfo qual, ArithmeticOrRelationalOperand target, int statistic, InternalID[] groupByList) Computes the indicated statistic for the form entries that match the conditions specified by the qualifier parameter.
static FullTextInfo[]	ARGetFullTextInfo(ARServerUser context, int[] requestList) Returns the requested Full Text Search (FTS) information for the specified server.
static AccessNameID[]	ARGetListAlertUser(ARServerUser context) Gets list of registered users.
static CompoundSchemaInfo[]	ARGetListExtSchemaCandidates(ARServerUser context, int schemaType) Returns a list of all the external schemas candidates that are able to be converted into AR System schemas.
static GroupInfo[]	ARGetListGroup(ARServerUser context, AccessNameID user, AccessNameID password) Returns a list of access control groups on the specified server.
static LicenseInfo[]	ARGetListLicense(ARServerUser context, LicenseNameID licenseType) Returns list of license info.
static RoleInfo[]	ARGetListRole(ARServerUser context, NameID application, AccessNameID user, AccessNameID password) Returns a list of roles for an application on the specified server.
static ServerNameID[]	ARGetListServer(ARServerUser context) Returns the list of available AR System servers defined in the ar directory file (UNIX only).
static SQLResult	ARGetListSQL(ARServerUser context, java.lang.String sqlCommand, int maxRetrieve, boolean retrieveTotalMatches) Returns a list of rows from the underlying SQL database on the specified server.
static SQLResult	ARGetListSQLForActiveLink(ARServerUser context, NameID actlinkName, int actionIndex, int actionType, Timestamp timestamp, EntryItem[] keywordList, EntryItem[] parameterList, int maxRetrieve, boolean retrieveTotalMatches) Reserved for Remedy internal use only.
static UserInfo[]	ARGetListUser(ARServerUser context, int type, Timestamp changedSince) Returns a list of users on the specified AR System server.
static java.lang.String	ARGetLocalHostID(ARServerUser context) Get License HostID.
static LocalizedValueInfo	ARGetLocalizedValue(ARServerUser ctx, LocalizedValueCriteria criteria, LocalizedRequestInfo request) Gets a localized text string from the message catalog schema.
static java.lang.String[]	ARGetMultipleCurrencyRatioSets(ARServerUser context, Timestamp[] ratioTimestamps) Retrieves multiple sets of currency ratios for specified points in time.
static EntryPointInfo[]	ARGetMultipleEntryPoints(ARServerUser context, EntryPointMultiListCriteria listCriteria, EntryPointMultiCriteria criteria) Retrieves application entry points.
static ExtFieldCandidatesInfo[]	ARGetMultipleExtFieldCandidates(ARServerUser context, CompoundSchemaInfo schema) Returns information about all the columns/fields candidates for an external schema.
static LocalizedValueInfo[]	ARGetMultipleLocalizedValues(ARServerUser ctx, LocalizedValueCriteria criteria, LocalizedRequestInfo[] requests) Gets multiple localized texts from the catalog file.
static QualifierInfo	ARGetQualifier(ARServerUser ctx, java.lang.String queryString, Field[] fieldList1, Field[] fieldList2, int queryContext) Constructs a QualifierInfo object given a string representation.
static java.lang.String	ARGetQualifierString(ARServerUser ctx, QualifierInfo qual, Field[] fieldList1, Field[] fieldList2, int queryContext, boolean isEscalation) Constructs a String object containing the string representation of a given qualifier object.
static java.lang.String	ARGetServerCharSet(ARServerUser context) Returns the servers char set as a string.
static ServerInfo[]	ARGetServerInfo(ARServerUser context, int[] requestList) Returns the requested configuration information for the specified server.
static ServerInfo[]	ARGetServerStatistics(ARServerUser context, int[] requestList) Returns the requested statistics for the specified server.
static Value	ARGetSessionConfiguration(ARServerUser context, int tag) Gets session variable for an API session.
static java.lang.String	ARGetTextForErrorMessage(ARServerUser context, int msgId) Returns the message text for the specified error from the local catalog (in the local language).
static void	ARImport(ARServerUser context, StructItemInfo[] items, int importOption, java.lang.String importBuffer) Imports the indicated structure definitions to the specified server.
static void	ARRegisterForAlerts(ARServerUser context, int clientPort, int registrationFlags) Register a client with the server to receive alert signals.
static void	ARSetFullTextInfo(ARServerUser context, FullTextInfo[] infos) Updates the indicated Full Text Search (FTS) information for the specified server.
static void	ARSetImpersonatedUser(ARServerUser context, java.lang.String impersonatedUser) Sets the user name to impersonate for this session.
static void	ARSetServerInfo(ARServerUser context, ServerInfo[] infos) Updates the indicated configuration information for the specified server.
static void	ARSetServerPort(ARServerUser context, NameID server, int port, int progNum) Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server.
static void	ARSetSessionConfiguration(ARServerUser context, int tag, Value value) Sets session variable for the API session.
static LicenseValidInfo	ARValidateLicense(ARServerUser context, LicenseNameID licenseType) Validates license info.
static LicenseValidInfo[]	ARValidateMultipleLicense(ARServerUser context, LicenseNameID[] licenseTypes) Validates multiple license info.
static java.lang.String	ARXMLCreateEntry(ARServerUser context, java.lang.String inputMapping, java.lang.String inputDoc, java.lang.String outputMapping, java.lang.String optionDoc) AR System internal use only.
static java.lang.String	ARXMLGetEntry(ARServerUser context, java.lang.String queryMapping, java.lang.String queryDoc, java.lang.String outputMapping, java.lang.String optionDoc) AR System internal use only.
static java.lang.String	ARXMLSetEntry(ARServerUser context, java.lang.String queryMapping, java.lang.String queryDoc, java.lang.String inputMapping, java.lang.String inputDoc, java.lang.String outputMapping, java.lang.String optionDoc) AR System internal use only.
static void	clearMap(java.util.Map map) dereference all references for a Map which contains JNI objects we do not use map.clear() since we need to dereference all objects in the map.
static java.lang.String	getConvertedEncoding() AR System internal use only.
static java.lang.String	getConvertedEncodingForDeploy() AR System internal use only.
static java.lang.String	getWebEncodingForDeploy() AR System internal use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

Util

public Util()

Method Detail

ARGetEntryBlob

public static void ARGetEntryBlob(ARServerUser context,
                                  NameID schemaID,
                                  EntryID entryID,
                                  FieldID fldID,
                                  AttachmentInfo attach)
                           throws ARException

Returns the attachment, or binary large object (blob), stored for the attachment field with the indicated ID on the specified server. The blob can be placed in a buffer or a file. The system returns information based on the access privileges of the user you specify for the ARServerUser parameter. User permissions are verified for the specified field. If the user cannot access the field, the system returns an error message.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if blob attachment is not returned

ARGetServerCharSet

public static java.lang.String ARGetServerCharSet(ARServerUser context)
                                           throws ARException

Returns the servers char set as a string.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - for any error in this operation

ARGetClientCharSet

public static java.lang.String ARGetClientCharSet(ARServerUser context)
                                           throws ARException

Returns the clients char set as a string.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - for any error in this operation

ARSetImpersonatedUser

public static void ARSetImpersonatedUser(ARServerUser context,
                                         java.lang.String impersonatedUser)
                                  throws ARException

Sets the user name to impersonate for this session.

Parameters:

context -

impersonatedUser -

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - for any error in this operation

ARSetSessionConfiguration

public static void ARSetSessionConfiguration(ARServerUser context,
                                             int tag,
                                             Value value)
                                      throws ARException

Sets session variable for the API session. Pass in the context and the integer value that represents the session variable value to set. Use any of following session variables:

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if session is not set

ARGetSessionConfiguration

public static Value ARGetSessionConfiguration(ARServerUser context,
                                              int tag)
                                       throws ARException

Gets session variable for an API session. Pass in the context, the integer value that represents the session variable to return (for example, AR_SESS_CHUNK_RESPONSE_SIZE), and return the value of the session variable. Use any of following session variables:

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if session is not returned

ARExport

public static java.lang.String ARExport(ARServerUser context,
                                        StructItemInfo[] items,
                                        NameID displayTag,
                                        int vuiType,
                                        WorkflowLockInfo lockInfo)
                                 throws ARException

Exports the indicated structure definitions from the specified server to a buffer. Copies structure definitions from one AR System server to another. This operation can be performed by users with AR System administrator privileges only.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if structure definition is not exported

ARImport

public static void ARImport(ARServerUser context,
                            StructItemInfo[] items,
                            int importOption,
                            java.lang.String importBuffer)
                     throws ARException

Imports the indicated structure definitions to the specified server. Use this function to copy structure definitions from one AR System server to another. This operation can be performed by users with AR System administrator privileges only.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if structure definition is not imported

ARGetServerInfo

public static ServerInfo[] ARGetServerInfo(ARServerUser context,
                                           int[] requestList)
                                    throws ARException

Returns the requested configuration information for the specified server. This operation can be performed by all users.

Server Options Whose Values Can Be Retrieved

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if configuration information is not returned

ARSetServerInfo

public static void ARSetServerInfo(ARServerUser context,
                                   ServerInfo[] infos)
                            throws ARException

Updates the indicated configuration information for the specified server. This operation can be performed by users with AR System administrator privileges.

Server Options Whose Values Can Be Retrieved

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if configuration information is not updated

ARGetListServer

public static ServerNameID[] ARGetListServer(ARServerUser context)
                                      throws ARException

Returns the list of available AR System servers defined in the ar directory file (UNIX only). Remedy User, Remedy Administrator, Remedy Notifier, and Remedy Import connect to these servers automatically if no servers are specified at startup. If the ar file is under NIS control, the system uses the file specified by the NIS map instead of the local ar file.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARGetServerStatistics

public static ServerInfo[] ARGetServerStatistics(ARServerUser context,
                                                 int[] requestList)
                                          throws ARException

Returns the requested statistics for the specified server. The counts returned generally represent the number of occurrences since starting the server. If a statistic reaches the maximum value for a long integer, the system resets the counter and begins incrementing again.

Can be performed by all users.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if statistics are not returned

ARSetServerPort

public static void ARSetServerPort(ARServerUser context,
                                   NameID server,
                                   int port,
                                   int progNum)
                            throws ARException

Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server. This operation can be performed by all users.

Parameters:

port - Port number that your program will use to communicate with the AR System server. If you do not specify this parameter or provide 0 for the port number, your program will use the port number supplied by the portmapper. This parameter is overridden by the ARTCPPORT environment variable.

progNum - RPC program number of the server. Specify 390600 to use the admin queue, a number from 390621 to 390634 or 390636 to 390669 or 390680-390694 to use a private queue, or 0 (default) to use the fast or list server queue. This parameter is overridden by the ARRPC environment variable.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if port is not specified

ARGetListGroup

public static GroupInfo[] ARGetListGroup(ARServerUser context,
                                         AccessNameID user,
                                         AccessNameID password)
                                  throws ARException

Returns a list of access control groups on the specified server. You can retrieve all groups or limit the list to groups associated with a particular user.

Group information for the current user can be retrieved by all users. Access to group information for other users is limited to users with AR System administrator privileges only.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARGetListRole

public static RoleInfo[] ARGetListRole(ARServerUser context,
                                       NameID application,
                                       AccessNameID user,
                                       AccessNameID password)
                                throws ARException

Returns a list of roles for an application on the specified server. You can retrieve all roles for an application or limit the list to roles associated with a particular user.

Role information for the current user can be retrieved by all users. Access to role information for other users is limited to users with AR System administrator privileges only.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARGetListUser

public static UserInfo[] ARGetListUser(ARServerUser context,
                                       int type,
                                       Timestamp changedSince)
                                throws ARException

Returns a list of users on the specified AR System server. You can retrieve information about the current user, all registered users, or all users currently accessing the server.

Information about the current user can be retrieved by all users. Access to information about other users is limited to users with AR System administrator privileges only.

For type, enter one of the following:

• Enter 0 or AR_USER_LIST_MYSELF to retrieve the current user.
• Enter 1 or AR_USER_LIST_REGISTERED to retrieve all registered users.
• Enter 2 or AR_USER_LIST_CURRENT to retrieve all users currently accessing the server.

changedSince A time stamp that limits the users retrieved to those modified after the specified time. Specify null for this parameter if you do not want to retrieve users with any modification time stamp. This parameter is only used for retrieving registered users.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARGetFullTextInfo

public static FullTextInfo[] ARGetFullTextInfo(ARServerUser context,
                                               int[] requestList)
                                        throws ARException

Returns the requested Full Text Search (FTS) information for the specified server.

Enter a list of one or more FTS options to return:

• AR_FULLTEXTINFO_CASE_SENSITIVE_SRCH indicates whether full text searches are case-sensitive. Valid values for this option are 0 (case-sensitive) and 1 (case-insensitive). The default value is 1 (case-insensitive).
• AR_FULLTEXTINFO_COLLECTION_DIR indicates collection directory for the FTS engine. This directory contains all defined FTS indexes. This directory is not used if no fields are indexed for FTS.
• AR_FULLTEXTINFO_FTS_MATCH_OP indicates type of match operation used.
• AR_FULLTEXT_FTS_MATCH_FORCE_L_T_WILD appends leading and trailing wild cards to every word. Produces highest number of matches but slows performance the most.
• AR_FULLTEXT_FTS_MATCH_FORCE_T_WILD truncates all leading wild cards and append trailing wild cards to every word. Produces a reasonable number of matches while still being efficient.
• AR_FULLTEXT_FTS_MATCH_IGNORE_L_WILD truncates all leading wild cards (do not truncate or append trailing wild cards).
• AR_FULLTEXT_FTS_MATCH_REMOVE_WILD truncates all wild cards. The most efficient match operation type but produces the lowest number of matches.
• AR_FULLTEXT_FTS_MATCH_UNCHANGED leaves all wild cards as specified by the user. Requires that users understand both how to use wild cards and their impact on performance
• AR_FULLTEXTINFO_STATE indicates whether FTS is enabled. Valid values for this option are 0 (off) and 1 (on). The default value is 1 (FTS on).
• AR_FULLTEXTINFO_STOPWORD contains all defined words to ignore for the FTS collection.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

ARSetFullTextInfo

public static void ARSetFullTextInfo(ARServerUser context,
                                     FullTextInfo[] infos)
                              throws ARException

Updates the indicated Full Text Search (FTS) information for the specified server. This operation can be performed by users with AR System administrator privileges only.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not updated

ARGetTextForErrorMessage

public static java.lang.String ARGetTextForErrorMessage(ARServerUser context,
                                                        int msgId)
                                                 throws ARException

Returns the message text for the specified error from the local catalog (in the local language). The length of the text is limited by AR_MAX_MESSAGE_SIZE (255 bytes). This operation can be performed by all users.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if message text is not returned

ARGetEntryStatistics

public static StatisticsResultInfo[] ARGetEntryStatistics(ARServerUser context,
                                                          SchemaKey schemaKey,
                                                          QualifierInfo qual,
                                                          ArithmeticOrRelationalOperand target,
                                                          int statistic,
                                                          InternalID[] groupByList)
                                                   throws ARException

Computes the indicated statistic for the form entries that match the conditions specified by the qualifier parameter. The system returns information based on the access privileges of the user you specify for the ARServerUser. All statistics, therefore, are limited to entries the user can access (users must have permission for the EntryID field to access and retrieve entries).

For statistic type, enter one of the following:

• Enter 1 or AR_STAT_OP_COUNT for total number of matching entries.
• Enter 2 or AR_STAT_OP_SUM for the sum of values for each group.
• Enter 3 or AR_STAT_OP_AVERAGE for the average value for each group.
• Enter 4 or AR_STAT_OP_MINIMUM for the minimum value for each group.
• Enter 5 or AR_STAT_OP_MAXIMUM for the maximum value for each group.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if statistic is not computed

ARGetListSQL

public static SQLResult ARGetListSQL(ARServerUser context,
                                     java.lang.String sqlCommand,
                                     int maxRetrieve,
                                     boolean retrieveTotalMatches)
                              throws ARException

Returns a list of rows from the underlying SQL database on the specified server. The server executes the SQL command you specify and returns the matching rows. A list with zero items and a warning message are returned if no SQL database resides on the server. The system returns information based on the access privileges of the user who launched the AR System server.

Can be performed by users with AR System administrator privileges only.

Parameters:

maxRetrieve - Enter a boolean value of TRUE to retrieve the maximum number of rows.

retrieveTotalMatches - Enter an integer value to limit the number of rows retrieved.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARExecuteProcess

public static ProcessResult ARExecuteProcess(ARServerUser context,
                                             java.lang.String command,
                                             boolean waitFlag)
                                      throws ARException

Performs the indicated command on the specified server.

Parameters:

command - to execute. Must be a valid command on the specified server.

waitFlag - To Execute Process, an independent process is spawned on server. Enter a boolean value of FALSE if you do not wait for the process to complete.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if command is not performed

ARGetQualifier

public static QualifierInfo ARGetQualifier(ARServerUser ctx,
                                           java.lang.String queryString,
                                           Field[] fieldList1,
                                           Field[] fieldList2,
                                           int queryContext)
                                    throws ARException

Constructs a QualifierInfo object given a string representation.

Parameters:

ctx - ARServerUser object

queryString - String object

fieldList1 - An array of Field objects of the form. (fieldList1 parameter is used in two different modes.) First mode - is for parsing the queries similar to the ones created in Remedy User advanced query bar. This type of queries are always defined in terms of a single form. In this case, the Field objects be from the form to which this qualifier is going to be applied. Second mode - is applicable when a qualification deals with two forms. For example, a qualification in SetFields, PushFields etc active link actions, can be defined in terms of two forms - one to which the active link belongs and the other form to/from which the data will be set. The later is termed as remote form. In this case, specify the array of Field objects of the remote form.

fieldList2 - An array of Field objects of a form. First mode - this parameter is not applicable and can be null. Second mode - applicable only in this mode. In this mode, this array of Field objects comes from the local form.

queryContext - Default value is AR_QUALCONTEXT_DEFAULT. Different parsing rules apply when a query line is encountered within an Active Link (in SetFields action, Run If condition etc), Filter, Escalation or in a Menu definition. Indicate appropriate value using AR_QUALCONTEXT_ACTIVE_LINK, AR_QUALCONTEXT_ESCALATION, AR_QUALCONTEXT_FILTER, or AR_QUALCONTEXT_MENU_DEFS.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not constructed

ARGetQualifierString

public static java.lang.String ARGetQualifierString(ARServerUser ctx,
                                                    QualifierInfo qual,
                                                    Field[] fieldList1,
                                                    Field[] fieldList2,
                                                    int queryContext,
                                                    boolean isEscalation)
                                             throws ARException

Constructs a String object containing the string representation of a given qualifier object.

Parameters:

ctx - ARServerUser object

qual - QualifierInfo object

fieldList1 - An array of Field objects of the form. (fieldList1 parameter is used in two different modes.) First mode - is for parsing the queries similar to the ones created in Remedy User advanced query bar. This type of queries are always defined in terms of a single form. In this case, the Field objects be from the form to which this qualifier is going to be applied. Second mode - is applicable when a qualification deals with two forms. For example, a qualification in SetFields, PushFields etc active link actions, can be defined in terms of two forms - one to which the active link belongs and the other form to/from which the data will be set. The later is termed as remote form. In this case, specify the array of Field objects of the remote form.

fieldList2 - An array of Field objects of a form. First mode - this parameter is not applicable and can be null. Second mode - applicable only in this mode. In this mode, this array of Field objects comes from the local form.

queryContext - Default value is AR_QUALCONTEXT_DEFAULT. Different parsing rules apply when a query line is encountered within an Active Link (in SetFields action, Run If condition etc), Filter, Escalation or in a Menu definition. Indicate appropriate value using AR_QUALCONTEXT_ACTIVE_LINK, AR_QUALCONTEXT_ESCALATION, AR_QUALCONTEXT_FILTER, or AR_QUALCONTEXT_MENU_DEFS.

isEscalation - Default is false. Specify true only when in the context of a escalation's query line. When unsure specify 'false'.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object is not constructed

ARRegisterForAlerts

public static void ARRegisterForAlerts(ARServerUser context,
                                       int clientPort,
                                       int registrationFlags)
                                throws ARException

Register a client with the server to receive alert signals. Note that this function performs an intentional disconnect from the server upon completion of the RPC call.

Parameters:

context - ARServerUser object

clientPort - The client port number.

registrationFlags - This value is reserved for future use and should be set to zero.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if client is not registered

ARDeregisterForAlerts

public static void ARDeregisterForAlerts(ARServerUser context,
                                         int clientPort)
                                  throws ARException

Deregister a client with the server so they no longer receive alert indicators.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if client is not deregistered

ARCreateAlertEvent

public static EntryID ARCreateAlertEvent(ARServerUser context,
                                         AccessNameID user,
                                         java.lang.String alertText,
                                         int priority,
                                         NameID sourceTag,
                                         ServerNameID server,
                                         NameID formName,
                                         java.lang.String objectId)
                                  throws ARException

Enters an alert event into the system. When an entry is made into the Alert Events form, an indicator of that alert is sent to the specified user if that user is registered to receive them.

Parameters:

context - ARServerUser object

user - The user who receives the alert. Specify * (AR_REGISTERED_BROADCAST) to create an alert event for all users that are currently registered to receive alerts with the AR System server. You cannot specify a group name for this argument.

alertText - The text that the alert contains.

priority - A relative value that represents the priority for this alert. The range of acceptable values is between 0 and 10.

sourceTag - A string that identifies the source of the alert. The AR System provides two predefined values for this string: AR - alert originated from the AR System FB - alert originated from Flashboards

server - The name of the server that is the source of the alert. Use @ to specify the current server. Specify NULL for this parameter if the parameter is not applicable to the type of alert that this call creates.

formName - The name of the form that is the source of the alert. For Flashboards, this is the name of the Flashboard that generated the alert. Specify NULL for this parameter if the parameter is not applicable to the type of alert that this call creates.

objectId - For AR System, this value is the Entry ID of the originating request. For Flashboards, this value is the name of the Flashboard event that the user provides. Specify NULL for this parameter if the parameter is not applicable to the type of alert that this call creates.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if alert event is not entered

ARGetListAlertUser

public static AccessNameID[] ARGetListAlertUser(ARServerUser context)
                                         throws ARException

Gets list of registered users.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARGetAlertCount

public static int ARGetAlertCount(ARServerUser context,
                                  QualifierInfo qual)
                           throws ARException

Gets number of alert events that meet the specified criteria.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if alert count is not returned

AREncodeARQualifierStruct

public static java.lang.String AREncodeARQualifierStruct(ARServerUser ctx,
                                                         QualifierInfo qual)
                                                  throws ARException

Encode of ARQualificationStruct. Converts ARQualificationStruct to serialized qualification string.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARQualificationStruct is not encoded

ARDecodeARQualifierStruct

public static QualifierInfo ARDecodeARQualifierStruct(ARServerUser ctx,
                                                      java.lang.String queryString)
                                               throws ARException

Decode of ARQualificationStruct. Converts serialized qualifier string to ARQualificationStruct.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARQualificationStruct is not decoded

AREncodeARAssignStruct

public static java.lang.String AREncodeARAssignStruct(ARServerUser ctx,
                                                      AssignInfo asn)
                                               throws ARException

Encode of ARAssignStruct. Converts ARAssignStruct to serialized qualification string.

Throws:

ARException

ARDecodeARAssignStruct

public static AssignInfo ARDecodeARAssignStruct(ARServerUser ctx,
                                                java.lang.String assignString)
                                         throws ARException

Decode of ARAssignStruct. Converts serialized Assign string to ARAssignStruct.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARAssignStruct is not decoded

AREncodeStatusHistory

public static java.lang.String AREncodeStatusHistory(ARServerUser ctx,
                                                     StatusHistoryInfo[] statHist)
                                              throws ARException

Takes an ARStatusHistoryList as input and encodes it into a status history string.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARStatusHistoryList is not encoded

ARDecodeStatusHistory

public static StatusHistoryInfo[] ARDecodeStatusHistory(ARServerUser ctx,
                                                        java.lang.String str)
                                                 throws ARException

Takes a status history string as input and decodes it into an ARStatusHistoryList.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARStatusHistoryList is not decoded

AREncodeDiary

public static java.lang.String AREncodeDiary(ARServerUser ctx,
                                             DiaryInfo[] diary)
                                      throws ARException

Takes an ARDiaryList as input and encodes it into a diary string.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARDiaryList is not encoded

ARDecodeDiary

public static DiaryInfo[] ARDecodeDiary(ARServerUser ctx,
                                        java.lang.String str)
                                 throws ARException

Takes a diary string as input and decodes it into an ARDiaryList for easier processing.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if ARDiaryList is not decoded

ARGetLocalizedValue

public static LocalizedValueInfo ARGetLocalizedValue(ARServerUser ctx,
                                                     LocalizedValueCriteria criteria,
                                                     LocalizedRequestInfo request)
                                              throws ARException

Gets a localized text string from the message catalog schema. Return an appropriate string along with a code for how the string was found or a NULL return if there was nothing found -- not even a default.

Parameters:

ctx - ARServerUser object

criteria - The localized value to be retrieved. The value can be a character value or an attachment. Specify NULL for this argument if you do not want to retrieve this value.

request - Identification for the localized value to be retrieved from the AR System Message Catalog. It contains the type of value, , value name, and, for some types of values, unique identification numbers.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if string is not returned

ARGetMultipleLocalizedValues

public static LocalizedValueInfo[] ARGetMultipleLocalizedValues(ARServerUser ctx,
                                                                LocalizedValueCriteria criteria,
                                                                LocalizedRequestInfo[] requests)
                                                         throws ARException

Gets multiple localized texts from the catalog file. It will return a blank return struct if nothing found. This call retrieves multiple localized text strings from the AR System Message Catalog. The messages that the server retrieves depend on the user locale. This function performs the same action as ARGetLocalizedValue(com.remedy.arsys.api.ARServerUser, com.remedy.arsys.api.LocalizedValueCriteria, com.remedy.arsys.api.LocalizedRequestInfo) but is easier to use and more efficient than retrieving multiple values one by one.

Parameters:

ctx - ARServerUser object

criteria - A list of the localized values to be retrieved. The values can be a character value or an attachment. Specify NULL for this argument if you do not want to retrieve a value.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if localized texts are are not returned

ARGetListSQLForActiveLink

public static SQLResult ARGetListSQLForActiveLink(ARServerUser context,
                                                  NameID actlinkName,
                                                  int actionIndex,
                                                  int actionType,
                                                  Timestamp timestamp,
                                                  EntryItem[] keywordList,
                                                  EntryItem[] parameterList,
                                                  int maxRetrieve,
                                                  boolean retrieveTotalMatches)
                                           throws ARException

Reserved for Remedy internal use only.

Throws:

ARException

ARExecuteProcessForActiveLink

public static ProcessResult ARExecuteProcessForActiveLink(ARServerUser context,
                                                          NameID actlinkName,
                                                          int actionIndex,
                                                          int actionType,
                                                          InternalID fieldId,
                                                          Timestamp timestamp,
                                                          EntryItem[] keywordList,
                                                          EntryItem[] parameterList,
                                                          boolean waitFlag)
                                                   throws ARException

Executes a process on the server. May or may not request return information.

Parameters:

context - ARServerUser object

actlinkName - Name of the active link.

actionIndex - Action number of the active link in the database.

keywordList - List of keywords requested by the server.

parameterList - A list of zero or more (accessible) rows that match the criteria defined by the sqlCommand parameter. Each item in the list represents one matching row, each of which contains a list of the selected column values. The system returns a list with zero items if no rows match the specified criteria.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if process is not executed

ARGetMultipleExtFieldCandidates

public static ExtFieldCandidatesInfo[] ARGetMultipleExtFieldCandidates(ARServerUser context,
                                                                       CompoundSchemaInfo schema)
                                                                throws ARException

Returns information about all the columns/fields candidates for an external schema.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

ARGetListExtSchemaCandidates

public static CompoundSchemaInfo[] ARGetListExtSchemaCandidates(ARServerUser context,
                                                                int schemaType)
                                                         throws ARException

Returns a list of all the external schemas candidates that are able to be converted into AR System schemas.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARDecodeAlertMessage

public static AlertMessageInfo ARDecodeAlertMessage(ARServerUser context,
                                                    AlertMessageCriteria criteria,
                                                    java.lang.Object message,
                                                    int length)
                                             throws ARException

Decode supplied alert message and return component parts.

Interface Change: The data supplied for the message parameter should be a byte array containing binary data received from the server. In previous versions the message parameter was a String. It was changed to an Object to facilitate the transition from String to byte array.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if message is not decoded

ARGetLocalHostID

public static java.lang.String ARGetLocalHostID(ARServerUser context)
                                         throws ARException

Get License HostID. It will return a String that holds host ID.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if HostID is not returned

ARGetAllLocalHostIDs

public static HostID[] ARGetAllLocalHostIDs(ARServerUser context)
                                     throws ARException

Get all local HostID's. It will return a list of all hostId's.

Throws:

ARException

ARValidateLicense

public static LicenseValidInfo ARValidateLicense(ARServerUser context,
                                                 LicenseNameID licenseType)
                                          throws ARException

Validates license info. Returns LicenseValidInfo.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not validated

ARValidateMultipleLicense

public static LicenseValidInfo[] ARValidateMultipleLicense(ARServerUser context,
                                                           LicenseNameID[] licenseTypes)
                                                    throws ARException

Validates multiple license info. Returns list of LicenseValidInfo.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not validated

ARGetListLicense

public static LicenseInfo[] ARGetListLicense(ARServerUser context,
                                             LicenseNameID licenseType)
                                      throws ARException

Returns list of license info. Returns list of LicenseInfo.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

ARConvertStringToListMenu

public static CharMenuInfo ARConvertStringToListMenu(ARServerUser context,
                                                     java.lang.String menuString)
                                              throws ARException

Converts a string to a CharMenuInfo object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if string is not converted

ARGetCompactEntryList

public static CompactQueryResult ARGetCompactEntryList(ARServerUser context,
                                                       EntryListCriteria entryListCriteria,
                                                       EntryCriteria entryCriteria,
                                                       java.lang.Integer nMatches)
                                                throws ARException

AR System internal use only.

Throws:

ARException

ARXMLCreateEntry

public static java.lang.String ARXMLCreateEntry(ARServerUser context,
                                                java.lang.String inputMapping,
                                                java.lang.String inputDoc,
                                                java.lang.String outputMapping,
                                                java.lang.String optionDoc)
                                         throws ARException

AR System internal use only.

Throws:

ARException

ARXMLSetEntry

public static java.lang.String ARXMLSetEntry(ARServerUser context,
                                             java.lang.String queryMapping,
                                             java.lang.String queryDoc,
                                             java.lang.String inputMapping,
                                             java.lang.String inputDoc,
                                             java.lang.String outputMapping,
                                             java.lang.String optionDoc)
                                      throws ARException

AR System internal use only.

Throws:

ARException

ARXMLGetEntry

public static java.lang.String ARXMLGetEntry(ARServerUser context,
                                             java.lang.String queryMapping,
                                             java.lang.String queryDoc,
                                             java.lang.String outputMapping,
                                             java.lang.String optionDoc)
                                      throws ARException

AR System internal use only.

Throws:

ARException

getConvertedEncoding

public static java.lang.String getConvertedEncoding()

AR System internal use only.

getConvertedEncodingForDeploy

public static java.lang.String getConvertedEncodingForDeploy()

AR System internal use only.

getWebEncodingForDeploy

public static java.lang.String getWebEncodingForDeploy()

AR System internal use only.

ARGetMultipleCurrencyRatioSets

public static java.lang.String[] ARGetMultipleCurrencyRatioSets(ARServerUser context,
                                                                Timestamp[] ratioTimestamps)
                                                         throws ARException

Retrieves multiple sets of currency ratios for specified points in time.

Throws:

ARException

ARGetCurrencyRatio

public static java.math.BigDecimal ARGetCurrencyRatio(java.lang.String currencyRatioSet,
                                                      java.lang.String fromCurrencyCode,
                                                      java.lang.String toCurrencyCode)
                                               throws ARException

Search through a supplied currency ratios string to find an entry that matches the requested currency codes. The ratios string is in a format like USDCAD.987/USDEUR1.09/ and the currency code portion is in sorted order. If the requested currency code combination cannot be found, the return value is null.

Throws:

ARException

ARGetApplicationRequestedInfo

public static java.lang.String ARGetApplicationRequestedInfo(ARServerUser context,
                                                             java.lang.String str)
                                                      throws ARException

For internal use only.

Throws:

ARException

ARGetMultipleEntryPoints

public static EntryPointInfo[] ARGetMultipleEntryPoints(ARServerUser context,
                                                        EntryPointMultiListCriteria listCriteria,
                                                        EntryPointMultiCriteria criteria)
                                                 throws ARException

Retrieves application entry points. These entry points include active link guide entry points and default entry points of a form.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException

ARBeginBulkEntryTransaction

public static void ARBeginBulkEntryTransaction(ARServerUser context)
                                        throws ARException

Marks the beginning of a bulk entry transaction.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException

AREndBulkEntryTransaction

public static BulkEntryReturn[] AREndBulkEntryTransaction(ARServerUser context,
                                                          int actionType)
                                                   throws ARException

Marks the ending of a bulk entry transaction.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException

clearMap

public static void clearMap(java.util.Map map)

dereference all references for a Map which contains JNI objects we do not use map.clear() since we need to dereference all objects in the map.