com.remedy.arsys.api
Class Proxy

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

public class Proxy

extends java.lang.Object

The Proxy class contains all the methods for loading the ARServerUser information with the session ID and specific information that pertains to the AR System C API call that gets made with the AR System Java API.

Functionally, the Proxy class is a holding area for AR System objects. It is these AR System objects which get manipulated by the developer or implementer of a Java program that controls or accesses the AR System server, not the Proxy class itself. The Proxy class is considered the worker area that finally sends all the information to the JNI layer where the call to the AR System server finally gets made in C.

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

Constructor Summary

Proxy()
constructor

Method Summary

void	ARBeginBulkEntryTransaction(ARServerUser context) Marks the beginning of a bulk entry transaction.
CharMenuInfo	ARConvertBufferToListMenu(java.lang.String menuBuffer) Converts a string to a CharMenuInfo object
void	ARCreateActiveLink(ARServerUser ctx, ActiveLink activeLink) Creates a new active link with the indicated name on the specified server.
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.
void	ARCreateContainer(ARServerUser context, Container container) Creates a new container with the indicated name on the specified server.
void	ARCreateEntry(ARServerUser context, Entry entry) Creates a new entry in the AR System.
void	ARCreateEscalation(ARServerUser ctx, Escalation escalation) Creates a new escalation with the indicated name on the specified server.
void	ARCreateField(ARServerUser context, Field field) Creates a new form field with the indicated name on the specified server.
void	ARCreateFilter(ARServerUser ctx, Filter filter) Creates a new filter with the indicated name on the specified server.
void	ARCreateMenu(ARServerUser context, Menu menu) Creates a new character menu with the indicated name on the specified server.
void	ARCreateSchema(ARServerUser context, Schema schema) Creates a new form with the indicated name on the specified server.
void	ARCreateSupportFile(ARServerUser ctx, SupportFile supportFile) Creates the indicated support file.
void	ARCreateView(ARServerUser context, View view) Creates a new form view (VUI) with the indicated name on the specified server.
AlertMessageInfo	ARDecodeAlertMessage(ARServerUser context, AlertMessageCriteria criteria, java.lang.Object message, int len) Decode supplied alert message and return component parts.
AssignInfo	ARDecodeARAssignStruct(ARServerUser ctx, java.lang.String assignString) Converts serialized Assign string to ARAssignStruct
QualifierInfo	ARDecodeARQualifierStruct(ARServerUser ctx, java.lang.String queryString) Converts serialized qualification string to ARQualificationStruct.
DiaryInfo[]	ARDecodeDiary(ARServerUser context, java.lang.String diaryString) Takes a diary string as input and decodes it into an ARDiaryList for easier processing.
StatusHistoryInfo[]	ARDecodeStatusHistory(ARServerUser context, java.lang.String historyString) Takes a status history string as input and decodes it into an ARStatusHistoryList for easier processing.
void	ARDeleteActiveLink(ARServerUser ctx, NameID name, int opt) Deletes the active link with the indicated name from the specified server and deletes any container references to the active link.
void	ARDeleteContainer(ARServerUser context, ContainerKey key, int opt) Deletes the container with the indicated name from the specified server and deletes any references to the container from other containers.
void	ARDeleteEntry(ARServerUser context, EntryKey entryKey) Deletes the form entry with the indicated ID from the specified server.
void	ARDeleteEscalation(ARServerUser ctx, NameID name, int opt) Deletes the escalation with the indicated name from the specified server and deletes any container references to the escalation.
void	ARDeleteField(ARServerUser context, NameID schema, long fieldId, int opt) Deletes the form field with the indicated ID from the specified server.
void	ARDeleteFilter(ARServerUser ctx, NameID name, int opt) Deletes the filter with the indicated name from the specified server and deletes any container references to the filter.
void	ARDeleteMenu(ARServerUser context, NameID menu, int opt) Deletes the character menu with the indicated name from the specified server.
void	ARDeleteMultipleFields(ARServerUser context, NameID schema, long[] ids, int deleteOption) Deletes one or more existing field definitions from a specified schema in AR System.
void	ARDeleteSchema(ARServerUser context, NameID name, int opt) Deletes the form with the indicated name from the specified server and deletes any container references to the form.
void	ARDeleteSupportFile(ARServerUser ctx, SupportFileKey key) Deletes a support file in AR System.
void	ARDeleteView(ARServerUser context, NameID schema, long vuiId) Deletes the form view (VUI) with the indicated ID from the specified server.
void	ARDeregisterForAlerts(ARServerUser context, int clientPort) Deregisters a client with the server so they no longer receive alert indicators.
java.lang.String	AREncodeARAssignStruct(ARServerUser ctx, AssignInfo asn) Converts ARAssignStruct to serialized qualification string
java.lang.String	AREncodeARQualifierStruct(ARServerUser ctx, QualifierInfo qual) Converts ARQualificationStruct to serialized qualification string.
java.lang.String	AREncodeDiary(ARServerUser ctx, DiaryInfo[] diary) Takes an ARDiaryList as input and encodes it into a diary string.
java.lang.String	AREncodeStatusHistory(ARServerUser ctx, StatusHistoryInfo[] statHist) Takes an ARStatusHistoryList as input and encodes it into a status history string.
BulkEntryReturn[]	AREndBulkEntryTransaction(ARServerUser context, int actionType) Marks the ending of a bulk entry transaction.
ProcessResult	ARExecuteProcess(ARServerUser context, java.lang.String command, boolean independentProcess) Performs the indicated command on the specified server.
ProcessResult	ARExecuteProcessForActiveLink(ARServerUser context, NameID actlinkName, int actionIndex, int actionType, InternalID fieldId, Timestamp timestamp, EntryItem[] keywordList, EntryItem[] parameterList, boolean independentProcess) Execute a process on the server.
CharMenuInfo	ARExpandMenu(ARServerUser context, CharMenuInfo menuDefn) Expands the query and file references for the specified menu definition and returns a character menu with list-type items only.
java.lang.String	ARExport(ARServerUser context, StructItemInfo[] items, NameID displayTag, int vuiType, WorkflowLockInfo lockInfo) Exports the indicated structure definitions from the specified server.
void	ARFreeEntryBlock(int handle) Frees an entire entryBlock once the user no longer needs it.
void	ARGetActiveLink(ARServerUser ctx, ActiveLinkKey key, ActiveLinkCriteria criteria, ActiveLink activeLink) Retrieves information about the active link with the indicated name on the specified server.
int	ARGetAlertCount(ARServerUser context, QualifierInfo qual) Retrieves the count of alert events that meet the specified criteria.
HostID[]	ARGetAllLocalHostIDs(ARServerUser context) Gets all the local hostIDs
java.lang.String	ARGetApplicationRequestedInfo(ARServerUser context, java.lang.String str) Gets the requested info by the application
java.lang.String	ARGetClientCharSet(ARServerUser context) Retrieves the clients char set.
CompactQueryResult	ARGetCompactEntryList(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCriteria, java.lang.Integer nMatches) Retrieves a list of form entries on the specified server.
void	ARGetContainer(ARServerUser context, ContainerKey key, ContainerCriteria criteria, Container container) Retrieves the contents of the container with the indicated name on the specified server.
void	ARGetEntry(ARServerUser context, EntryKey entryKey, EntryCriteria entryCriteria, Entry entry) Retrieves an entry from the AR System.
void	ARGetEntryBlob(ARServerUser context, NameID schemaID, EntryID entryID, FieldID fldID, AttachmentInfo attach) Retrieves the attachment, or binary large object (blob), stored for the attachment field with the indicated ID on the specified server.
Entry[]	ARGetEntryBlock(int handle, int blockNumber) Retrieves a block of entries from a entryBlock.
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.
void	ARGetEscalation(ARServerUser ctx, EscalationKey key, EscalationCriteria criteria, Escalation escalation) Retrieves information about the escalation with the indicated name on the specified server.
void	ARGetField(ARServerUser context, FieldKey key, FieldCriteria criteria, Field field) Retrieves information about the form field with the indicated ID on the specified server.
void	ARGetFilter(ARServerUser ctx, FilterKey key, FilterCriteria criteria, Filter filter) Retrieves information about the specified filter on the specified server.
FullTextInfo[]	ARGetFullTextInfo(ARServerUser context, int[] requestList) Retrieves the requested Full Text Search (FTS) information for the specified server.
ActiveLinkKey[]	ARGetListActiveLink(ARServerUser ctx, WorkflowObjectListCriteria listCriteria) Retrieves a list of active links on the specified server.
ActiveLink[]	ARGetListActiveLinkObjects(ARServerUser ctx, WorkflowObjectListCriteria listCriteria, ActiveLinkCriteria criteria) Retrieves a list of all accessible active link objects.
AccessNameID[]	ARGetListAlertUser(ARServerUser context) Retrieves a list of users registered to receive alerts.
com.remedy.arsys.api.ContainerListInfo[]	ARGetListContainer(ARServerUser context, ContainerListCriteria listCriteria) Retrieves a list of containers on the specified server.
Container[]	ARGetListContainerObjects(ARServerUser context, ContainerListCriteria listCriteria, ContainerCriteria crit) Retrieves a list of all accessible container objects.
EntryListInfo[]	ARGetListEntry(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCrit, boolean useLocale, java.lang.Integer nMatches) Retrieves a list of form entries on the specified server.
int	ARGetListEntryBlocks(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCriteria, int numEntriesPerBlock, boolean useLocale, java.lang.Integer numReturnedBlocks, java.lang.Integer numReturnedRows, java.lang.Integer numTotalMatches) Retrieves a handle to a list of form entries on the specified server.
Entry[]	ARGetListEntryWithFields(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCriteria, boolean useLocale, java.lang.Integer nMatches) Retrieves a list of form entries on the specified server.
EscalationKey[]	ARGetListEscalation(ARServerUser ctx, WorkflowObjectListCriteria listCriteria) Retrieves a list of escalations on the specified server.
Escalation[]	ARGetListEscalationObjects(ARServerUser ctx, WorkflowObjectListCriteria listCriteria, EscalationCriteria criteria) Retrieves a list of all accessible escalation objects.
CompoundSchemaInfo[]	ARGetListExtSchemaCandidates(ARServerUser context, int schemaType) Gets a list of all the external schemas candidates that are able to be converted into AR System schemas
FieldID[]	ARGetListField(ARServerUser context, FieldListCriteria criteria) Retrieves a list of fields for a particular form on the specified server.
Field[]	ARGetListFieldObjects(ARServerUser context, FieldListCriteria listcriteria, boolean[] flags) Retrieves a list of all accessible field objects.
FilterKey[]	ARGetListFilter(ARServerUser ctx, WorkflowObjectListCriteria listCriteria) Retrieves a list of filters on the specified server.
Filter[]	ARGetListFilterObjects(ARServerUser ctx, WorkflowObjectListCriteria listCriteria, FilterCriteria criteria) Retrieves a list of all accessible filter objects.
GroupInfo[]	ARGetListGroup(ARServerUser context, AccessNameID user, AccessNameID password) Retrieves a list of access control groups on the specified server.
LicenseInfo[]	ARGetListLicense(ARServerUser context, LicenseNameID licenseType) Get license information.
MenuKey[]	ARGetListMenu(ARServerUser context, MenuListCriteria listCriteria) Retrieves a list of character menus on the specified server.
Menu[]	ARGetListMenuObjects(ARServerUser context, MenuListCriteria listCriteria, MenuCriteria criteria) Retrieves a list of all accessible character menu objects.
RoleInfo[]	ARGetListRole(ARServerUser context, NameID application, AccessNameID user, AccessNameID password) Retrieves a list of roles for a deployable application on the specified server.
SchemaKey[]	ARGetListSchema(ARServerUser context, SchemaListCriteria schemaCrit) Retrieves a list of forms on the specified server.
Schema[]	ARGetListSchemaObjects(ARServerUser context, SchemaListCriteria listcriteria, SchemaCriteria criteria) Retrieves a list of all accessible schema objects.
SchemaAliasInfo[]	ARGetListSchemaWithAlias(ARServerUser context, SchemaAliasesCriteria schemaCrit) Retrieves a list of schema definitions from AR System.
ServerNameID[]	ARGetListServer(ARServerUser context) Retrieves the list of available AR System servers defined in the ar directory file.
SQLResult	ARGetListSQL(ARServerUser context, java.lang.String sqlCommand, int maxRetrieve, boolean retrieveTotalMatches) Retrieves a list of rows from the underlying SQL database on the specified server.
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.
InternalID[]	ARGetListSupportFile(ARServerUser ctx, SupportFileListCriteria listCriteria) Retrieves a list of support file IDs for a specified type of object.
SupportFile[]	ARGetListSupportFileObjects(ARServerUser ctx, SupportFileListCriteria listCriteria, SupportFileCriteria criteria) Retrieves a list of all accessible support file objects.
UserInfo[]	ARGetListUser(ARServerUser context, int option, Timestamp changedSince) Retrieves a list of users on the specified AR System server.
FieldID[]	ARGetListView(ARServerUser context, ViewListCriteria criteria) Retrieves a list of form views (VUI) for a particular form on the specified server.
View[]	ARGetListViewObjects(ARServerUser context, ViewListCriteria listcriteria, ViewCriteria criteria) Retrieves a list of all accessible VUI objects.
java.lang.String	ARGetLocalHostID(ARServerUser context) Gets the local hostID
LocalizedValueInfo	ARGetLocalizedValue(ARServerUser context, LocalizedValueCriteria criteria, LocalizedRequestInfo request) Gets a localized text string from the message catalog schema.
void	ARGetMenu(ARServerUser context, MenuKey key, MenuCriteria criteria, Menu menu) Retrieves information about the character menu with the indicated name on the specified server.
Container[]	ARGetMultipleContainerObjects(ARServerUser context, ContainerMultiCriteria listCriteria, ContainerCriteria crit) Retrieves a list of all accessible container objects.
java.lang.String[]	ARGetMultipleCurrencyRatioSets(ARServerUser context, Timestamp[] ratioTimestamps) Gets currency ratios list from server
Entry[]	ARGetMultipleEntries(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCriteria) Retrieves the group of form entries specified by the entryIdList parameter.
ExtFieldCandidatesInfo[]	ARGetMultipleExtFieldCandidates(ARServerUser context, CompoundSchemaInfo schema) Gets information about all the column/field candidates for an external schema
Field[]	ARGetMultipleFields(ARServerUser context, FieldListCriteria listcriteria, boolean[] flags) Retrieves one or more field definitions for a specified form.
LocalizedValueInfo[]	ARGetMultipleLocalizedValues(ARServerUser context, LocalizedValueCriteria criteria, LocalizedRequestInfo[] requests) Gets multiple localized texts from the catalog file.
QualifierInfo	ARGetQualifier(ARServerUser ctx, java.lang.String queryString, Field[] remoteFieldList, Field[] fieldList, int queryContext) De-serialize Qualifer data structure.
java.lang.String	ARGetQualifierString(ARServerUser ctx, QualifierInfo qual, Field[] remoteFieldList, Field[] fieldList, int queryContext, boolean isEscalation) Serialize Qualifer data structure.
void	ARGetSchema(ARServerUser context, SchemaKey objKey, SchemaCriteria schemaCrit, Schema schema) Retrieves information about the form with the indicated name on the specified server.
java.lang.String	ARGetServerCharSet(ARServerUser context) Retrieves the servers char set.
ServerInfo[]	ARGetServerInfo(ARServerUser context, int[] requestlist) Retrieves the requested configuration information for the specified server.
ServerInfo[]	ARGetServerStatistics(ARServerUser context, int[] requestList) Retrieves the requested statistics for the specified server.
Value	ARGetSessionConfiguration(ARServerUser context, int tag) Allows the retrieval of session variables.
void	ARGetSupportFile(ARServerUser ctx, SupportFileKey key, SupportFileCriteria criteria, SupportFile supportFile) Retrieves a file supporting external reports.
java.lang.String	ARGetTextForErrorMessage(ARServerUser context, int msgId) Retrieves the message text for the specified error from the local catalog (in the local language).
void	ARGetView(ARServerUser context, ViewKey key, ViewCriteria criteria, View view) Retrieves information about the form view (VUI) with the indicated ID on the specified server.
void	ARImport(ARServerUser context, StructItemInfo[] items, int option, java.lang.String importBuffer) Imports the indicated structure definitions to the specified server.
void	ARMergeEntry(ARServerUser context, Entry entry, SchemaKey schemaName, int mergeType) Merges an existing entry into the indicated form on the specified server.
EntryPointInfo[]	ARMultipleEntryPoints(ARServerUser context, EntryPointMultiListCriteria listCriteria, EntryPointMultiCriteria criteria) Get the entry points
void	ARRegisterForAlerts(ARServerUser context, int clientPort, int registrationFlags) Registers a client with the server to receive alert indicators.
void	ARSetActiveLink(ARServerUser ctx, ActiveLink activeLink, ActiveLinkCriteria criteria) Updates the active link with the indicated name on the specified server.
void	ARSetContainer(ARServerUser context, Container container) Updates the definition for the container with the indicated name on the specified server.
void	ARSetEntry(ARServerUser context, Entry entry, Timestamp ts, int option) Updates the form entry with the indicated ID on the specified server.
void	ARSetEscalation(ARServerUser ctx, Escalation escalation, EscalationCriteria criteria) Updates the escalation with the indicated name on the specified server.
void	ARSetField(ARServerUser context, Field field, boolean[] changeFlags) Updates the definition for the form field with the indicated ID on the specified server.
void	ARSetFilter(ARServerUser ctx, Filter filter, FilterCriteria criteria) Updates the filter with the indicated name on the specified server.
void	ARSetFullTextInfo(ARServerUser context, FullTextInfo[] infos) Updates the requested Full Text Search (FTS) information for the specified server.
void	ARSetImpersonatedUser(ARServerUser context, java.lang.String impersonatedUser) Sets the user to be impersonated by the admin for this session.
void	ARSetLogging(ARServerUser context, long type, long location, java.lang.String file) Updates the indicated log information for the specified server.
void	ARSetMenu(ARServerUser context, Menu menu, boolean[] changeFlags) Updates the character menu with the indicated name on the specified server.
void	ARSetSchema(ARServerUser context, Schema schema, boolean[] changeFlags) Updates the definition for the form with the indicated name on the specified server.
void	ARSetServerInfo(ARServerUser context, ServerInfo[] infos) Updates the indicated configuration information for the specified server.
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.
void	ARSetSessionConfiguration(ARServerUser context, int tag, Value value) Allows session variables to be set.
void	ARSetSupportFile(ARServerUser ctx, SupportFile supportFile, SupportFileCriteria criteria) Sets a support file in AR System.
void	ARSetView(ARServerUser context, View view, boolean[] changeFlags) Updates the form view (VUI) with the indicated ID on the specified server.
LicenseValidInfo	ARValidateLicense(ARServerUser context, LicenseNameID licenseType) Validate license info.
LicenseValidInfo[]	ARValidateMultipleLicenses(ARServerUser context, LicenseNameID[] licenseTypes) Validate multiple license info.
void	ARVerifyUser(ARServerUser context, boolean[] criteria) Checks the cache on the specified server to determine whether the user you specify for the control parameter is registered in AR System.
java.lang.String	ARXMLCreateEntry(ARServerUser context, java.lang.String inputMapping, java.lang.String inputDoc, java.lang.String outputMapping, java.lang.String optionDoc) Creates entries in AR System with input XML and returns output XML
java.lang.String	ARXMLGetEntry(ARServerUser context, java.lang.String queryMapping, java.lang.String queryDoc, java.lang.String outputMapping, java.lang.String optionDoc) Gets entries from AR System with input XML and returns output XML
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) Sets entries in AR System with input XML and returns output XML
void	FindAndIterate(ARServerUser context, EntryListCriteria entryListCriteria, EntryCriteria entryCriteria, boolean useLocale, java.lang.Integer nMatches, int getMode, IARRowIterator iterator)
protected long	getLastUsedTime()
protected long	getSessionId() Package scoped get/set Methods for m_sessionId:
protected void	setLastUsedTime(long tm)
protected void	setSessionId(long sessionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

Proxy

public Proxy()

constructor

Method Detail

getSessionId

protected long getSessionId()

Package scoped get/set Methods for m_sessionId:

setSessionId

protected void setSessionId(long sessionId)

setLastUsedTime

protected void setLastUsedTime(long tm)

getLastUsedTime

protected long getLastUsedTime()

ARCreateEntry

public void ARCreateEntry(ARServerUser context,
                          Entry entry)
                   throws ARException

Creates a new entry in the AR System.

Throws:

ARException - if entry is not created

ARGetEntry

public void ARGetEntry(ARServerUser context,
                       EntryKey entryKey,
                       EntryCriteria entryCriteria,
                       Entry entry)
                throws ARException

Retrieves an entry from the AR System.

Throws:

ARException - if entry is not retrieved

ARGetListEntry

public EntryListInfo[] ARGetListEntry(ARServerUser context,
                                      EntryListCriteria entryListCriteria,
                                      EntryCriteria entryCrit,
                                      boolean useLocale,
                                      java.lang.Integer nMatches)
                               throws ARException

Retrieves a list of form entries on the specified server.

Throws:

ARException - if list is not returned

ARGetMultipleEntries

public Entry[] ARGetMultipleEntries(ARServerUser context,
                                    EntryListCriteria entryListCriteria,
                                    EntryCriteria entryCriteria)
                             throws ARException

Retrieves the group of form entries specified by the entryIdList parameter.

Throws:

ARException - if entries are not retrieved

ARGetListEntryWithFields

public Entry[] ARGetListEntryWithFields(ARServerUser context,
                                        EntryListCriteria entryListCriteria,
                                        EntryCriteria entryCriteria,
                                        boolean useLocale,
                                        java.lang.Integer nMatches)
                                 throws ARException

Retrieves a list of form entries on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListEntryBlocks

public int ARGetListEntryBlocks(ARServerUser context,
                                EntryListCriteria entryListCriteria,
                                EntryCriteria entryCriteria,
                                int numEntriesPerBlock,
                                boolean useLocale,
                                java.lang.Integer numReturnedBlocks,
                                java.lang.Integer numReturnedRows,
                                java.lang.Integer numTotalMatches)
                         throws ARException

Retrieves a handle to a list of form entries on the specified server. The entries are grouped together in compressed blocks specified by numEntriesInBlock, making for more efficient use of memory. The handle is used by ARGetEntryBlock, which is used to get a group of entries.

Throws:

ARException - if list is not retrieved

ARGetEntryBlock

public Entry[] ARGetEntryBlock(int handle,
                               int blockNumber)
                        throws ARException

Retrieves a block of entries from a entryBlock.

Throws:

ARException - if list is not retrieved

ARFreeEntryBlock

public void ARFreeEntryBlock(int handle)
                      throws ARException

Frees an entire entryBlock once the user no longer needs it.

Throws:

ARException - if list is not retrieved

FindAndIterate

public void FindAndIterate(ARServerUser context,
                           EntryListCriteria entryListCriteria,
                           EntryCriteria entryCriteria,
                           boolean useLocale,
                           java.lang.Integer nMatches,
                           int getMode,
                           IARRowIterator iterator)
                    throws ARException

Throws:

ARException

ARGetCompactEntryList

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

Retrieves a list of form entries on the specified server.

Throws:

ARException - if list is not retrieved

ARDeleteEntry

public void ARDeleteEntry(ARServerUser context,
                          EntryKey entryKey)
                   throws ARException

Deletes the form entry with the indicated ID from the specified server.

Throws:

ARException - if entry is not deleted

ARSetEntry

public void ARSetEntry(ARServerUser context,
                       Entry entry,
                       Timestamp ts,
                       int option)
                throws ARException

Updates the form entry with the indicated ID on the specified server.

Throws:

ARException - if entry is not updated

ARMergeEntry

public void ARMergeEntry(ARServerUser context,
                         Entry entry,
                         SchemaKey schemaName,
                         int mergeType)
                  throws ARException

Merges an existing entry into the indicated form on the specified server.

Throws:

ARException - if entry is not merged

ARCreateSchema

public void ARCreateSchema(ARServerUser context,
                           Schema schema)
                    throws ARException

Creates a new form with the indicated name on the specified server. The nine required core fields are automatically associated with the new form.

Throws:

ARException - if form is not created

ARGetSchema

public void ARGetSchema(ARServerUser context,
                        SchemaKey objKey,
                        SchemaCriteria schemaCrit,
                        Schema schema)
                 throws ARException

Retrieves information about the form with the indicated name on the specified server.

Throws:

ARException - if information is not retrieved

ARSetSchema

public void ARSetSchema(ARServerUser context,
                        Schema schema,
                        boolean[] changeFlags)
                 throws ARException

Updates the definition for the form with the indicated name on the specified server.

Throws:

ARException - if definition is not updated

ARGetListSchemaWithAlias

public SchemaAliasInfo[] ARGetListSchemaWithAlias(ARServerUser context,
                                                  SchemaAliasesCriteria schemaCrit)
                                           throws ARException

Retrieves a list of schema definitions from AR System. Includes a second list with the alias for each of the schemas that is returned. No name in the alias means that there is no alias.

Throws:

ARException - if list is not retrieved

ARGetListSchema

public SchemaKey[] ARGetListSchema(ARServerUser context,
                                   SchemaListCriteria schemaCrit)
                            throws ARException

Retrieves a list of forms on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListSchemaObjects

public Schema[] ARGetListSchemaObjects(ARServerUser context,
                                       SchemaListCriteria listcriteria,
                                       SchemaCriteria criteria)
                                throws ARException

Retrieves a list of all accessible schema objects.

Throws:

ARException - if list is not retrieved

ARDeleteSchema

public void ARDeleteSchema(ARServerUser context,
                           NameID name,
                           int opt)
                    throws ARException

Deletes the form with the indicated name from the specified server and deletes any container references to the form.

Throws:

ARException - if form is not deleted

ARCreateField

public void ARCreateField(ARServerUser context,
                          Field field)
                   throws ARException

Creates a new form field with the indicated name on the specified server.

Throws:

ARException - if field is not created

ARSetField

public void ARSetField(ARServerUser context,
                       Field field,
                       boolean[] changeFlags)
                throws ARException

Updates the definition for the form field with the indicated ID on the specified server.

Throws:

ARException - if definition is not updated

ARGetListField

public FieldID[] ARGetListField(ARServerUser context,
                                FieldListCriteria criteria)
                         throws ARException

Retrieves a list of fields for a particular form on the specified server.

Throws:

ARException - if list is not retrieved

ARGetField

public void ARGetField(ARServerUser context,
                       FieldKey key,
                       FieldCriteria criteria,
                       Field field)
                throws ARException

Retrieves information about the form field with the indicated ID on the specified server.

Throws:

ARException - if information is not retrieved

ARGetListFieldObjects

public Field[] ARGetListFieldObjects(ARServerUser context,
                                     FieldListCriteria listcriteria,
                                     boolean[] flags)
                              throws ARException

Retrieves a list of all accessible field objects.

Throws:

ARException - if list is not retrieved

ARGetMultipleFields

public Field[] ARGetMultipleFields(ARServerUser context,
                                   FieldListCriteria listcriteria,
                                   boolean[] flags)
                            throws ARException

Retrieves one or more field definitions for a specified form.

Throws:

ARException - if definition is not retrieved

ARDeleteField

public void ARDeleteField(ARServerUser context,
                          NameID schema,
                          long fieldId,
                          int opt)
                   throws ARException

Deletes the form field with the indicated ID from the specified server.

Throws:

ARException - if field is not deleted

ARDeleteMultipleFields

public void ARDeleteMultipleFields(ARServerUser context,
                                   NameID schema,
                                   long[] ids,
                                   int deleteOption)
                            throws ARException

Deletes one or more existing field definitions from a specified schema in AR System.

Throws:

ARException - if field is not deleted

ARCreateFilter

public void ARCreateFilter(ARServerUser ctx,
                           Filter filter)
                    throws ARException

Creates a new filter with the indicated name on the specified server.

Throws:

ARException - if filter is not created

ARGetFilter

public void ARGetFilter(ARServerUser ctx,
                        FilterKey key,
                        FilterCriteria criteria,
                        Filter filter)
                 throws ARException

Retrieves information about the specified filter on the specified server.

Throws:

ARException - if information is not retrieved

ARSetFilter

public void ARSetFilter(ARServerUser ctx,
                        Filter filter,
                        FilterCriteria criteria)
                 throws ARException

Updates the filter with the indicated name on the specified server.

Throws:

ARException - if filter is not updated

ARGetListFilter

public FilterKey[] ARGetListFilter(ARServerUser ctx,
                                   WorkflowObjectListCriteria listCriteria)
                            throws ARException

Retrieves a list of filters on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListFilterObjects

public Filter[] ARGetListFilterObjects(ARServerUser ctx,
                                       WorkflowObjectListCriteria listCriteria,
                                       FilterCriteria criteria)
                                throws ARException

Retrieves a list of all accessible filter objects.

Throws:

ARException - if list is not retrieved

ARDeleteFilter

public void ARDeleteFilter(ARServerUser ctx,
                           NameID name,
                           int opt)
                    throws ARException

Deletes the filter with the indicated name from the specified server and deletes any container references to the filter.

Throws:

ARException - if filter is not deleted

ARCreateEscalation

public void ARCreateEscalation(ARServerUser ctx,
                               Escalation escalation)
                        throws ARException

Creates a new escalation with the indicated name on the specified server.

Throws:

ARException - if escalation is not created

ARGetEscalation

public void ARGetEscalation(ARServerUser ctx,
                            EscalationKey key,
                            EscalationCriteria criteria,
                            Escalation escalation)
                     throws ARException

Retrieves information about the escalation with the indicated name on the specified server.

Throws:

ARException - if information is not retrieved

ARSetEscalation

public void ARSetEscalation(ARServerUser ctx,
                            Escalation escalation,
                            EscalationCriteria criteria)
                     throws ARException

Updates the escalation with the indicated name on the specified server.

Throws:

ARException - if escalation is not updated

ARGetListEscalation

public EscalationKey[] ARGetListEscalation(ARServerUser ctx,
                                           WorkflowObjectListCriteria listCriteria)
                                    throws ARException

Retrieves a list of escalations on the specified server.

Throws:

ARException - if information is not retrieved

ARGetListEscalationObjects

public Escalation[] ARGetListEscalationObjects(ARServerUser ctx,
                                               WorkflowObjectListCriteria listCriteria,
                                               EscalationCriteria criteria)
                                        throws ARException

Retrieves a list of all accessible escalation objects.

Throws:

ARException - if information is not retrieved

ARDeleteEscalation

public void ARDeleteEscalation(ARServerUser ctx,
                               NameID name,
                               int opt)
                        throws ARException

Deletes the escalation with the indicated name from the specified server and deletes any container references to the escalation.

Throws:

ARException - if information is not deleted

ARCreateActiveLink

public void ARCreateActiveLink(ARServerUser ctx,
                               ActiveLink activeLink)
                        throws ARException

Creates a new active link with the indicated name on the specified server.

Throws:

ARException - if active link is not created

ARGetActiveLink

public void ARGetActiveLink(ARServerUser ctx,
                            ActiveLinkKey key,
                            ActiveLinkCriteria criteria,
                            ActiveLink activeLink)
                     throws ARException

Retrieves information about the active link with the indicated name on the specified server.

Throws:

ARException - if information is not retrieved

ARSetActiveLink

public void ARSetActiveLink(ARServerUser ctx,
                            ActiveLink activeLink,
                            ActiveLinkCriteria criteria)
                     throws ARException

Updates the active link with the indicated name on the specified server.

Throws:

ARException - if active link is not updated

ARGetListActiveLink

public ActiveLinkKey[] ARGetListActiveLink(ARServerUser ctx,
                                           WorkflowObjectListCriteria listCriteria)
                                    throws ARException

Retrieves a list of active links on the specified server.

Throws:

ARException - if information is not retrieved

ARGetListActiveLinkObjects

public ActiveLink[] ARGetListActiveLinkObjects(ARServerUser ctx,
                                               WorkflowObjectListCriteria listCriteria,
                                               ActiveLinkCriteria criteria)
                                        throws ARException

Retrieves a list of all accessible active link objects.

Throws:

ARException - if information is not retrieved

ARDeleteActiveLink

public void ARDeleteActiveLink(ARServerUser ctx,
                               NameID name,
                               int opt)
                        throws ARException

Deletes the active link with the indicated name from the specified server and deletes any container references to the active link.

Throws:

ARException - if active link is not deleted

ARGetView

public void ARGetView(ARServerUser context,
                      ViewKey key,
                      ViewCriteria criteria,
                      View view)
               throws ARException

Retrieves information about the form view (VUI) with the indicated ID on the specified server.

Throws:

ARException - if information is not retrieved

ARGetListView

public FieldID[] ARGetListView(ARServerUser context,
                               ViewListCriteria criteria)
                        throws ARException

Retrieves a list of form views (VUI) for a particular form on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListViewObjects

public View[] ARGetListViewObjects(ARServerUser context,
                                   ViewListCriteria listcriteria,
                                   ViewCriteria criteria)
                            throws ARException

Retrieves a list of all accessible VUI objects.

Throws:

ARException - if list is not retrieved

ARCreateView

public void ARCreateView(ARServerUser context,
                         View view)
                  throws ARException

Creates a new form view (VUI) with the indicated name on the specified server.

Throws:

ARException - if VUI is not created

ARSetView

public void ARSetView(ARServerUser context,
                      View view,
                      boolean[] changeFlags)
               throws ARException

Updates the form view (VUI) with the indicated ID on the specified server.

Throws:

ARException - if VUI is not updated

ARDeleteView

public void ARDeleteView(ARServerUser context,
                         NameID schema,
                         long vuiId)
                  throws ARException

Deletes the form view (VUI) with the indicated ID from the specified server.

Throws:

ARException - if VUI is not deleted

ARGetListContainer

public com.remedy.arsys.api.ContainerListInfo[] ARGetListContainer(ARServerUser context,
                                                                   ContainerListCriteria listCriteria)
                                                            throws ARException

Retrieves a list of containers on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListContainerObjects

public Container[] ARGetListContainerObjects(ARServerUser context,
                                             ContainerListCriteria listCriteria,
                                             ContainerCriteria crit)
                                      throws ARException

Retrieves a list of all accessible container objects.

Throws:

ARException - if list is not retrieved

ARGetMultipleContainerObjects

public Container[] ARGetMultipleContainerObjects(ARServerUser context,
                                                 ContainerMultiCriteria listCriteria,
                                                 ContainerCriteria crit)
                                          throws ARException

Retrieves a list of all accessible container objects.

Throws:

ARException - if list is not retrieved

ARSetContainer

public void ARSetContainer(ARServerUser context,
                           Container container)
                    throws ARException

Updates the definition for the container with the indicated name on the specified server.

Throws:

ARException - if definition is not updated

ARCreateContainer

public void ARCreateContainer(ARServerUser context,
                              Container container)
                       throws ARException

Creates a new container with the indicated name on the specified server.

Throws:

ARException - if container is not created

ARDeleteContainer

public void ARDeleteContainer(ARServerUser context,
                              ContainerKey key,
                              int opt)
                       throws ARException

Deletes the container with the indicated name from the specified server and deletes any references to the container from other containers.

Throws:

ARException - if container is not deleted

ARGetContainer

public void ARGetContainer(ARServerUser context,
                           ContainerKey key,
                           ContainerCriteria criteria,
                           Container container)
                    throws ARException

Retrieves the contents of the container with the indicated name on the specified server.

Throws:

ARException - if container is not retrieved

ARGetMenu

public void ARGetMenu(ARServerUser context,
                      MenuKey key,
                      MenuCriteria criteria,
                      Menu menu)
               throws ARException

Retrieves information about the character menu with the indicated name on the specified server.

Throws:

ARException - if information is not retrieved

ARGetListMenu

public MenuKey[] ARGetListMenu(ARServerUser context,
                               MenuListCriteria listCriteria)
                        throws ARException

Retrieves a list of character menus on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListMenuObjects

public Menu[] ARGetListMenuObjects(ARServerUser context,
                                   MenuListCriteria listCriteria,
                                   MenuCriteria criteria)
                            throws ARException

Retrieves a list of all accessible character menu objects.

Throws:

ARException - if list is not retrieved

ARCreateMenu

public void ARCreateMenu(ARServerUser context,
                         Menu menu)
                  throws ARException

Creates a new character menu with the indicated name on the specified server.

Throws:

ARException - if menu is not created

ARSetMenu

public void ARSetMenu(ARServerUser context,
                      Menu menu,
                      boolean[] changeFlags)
               throws ARException

Updates the character menu with the indicated name on the specified server.

Throws:

ARException - if menu is not updated

ARDeleteMenu

public void ARDeleteMenu(ARServerUser context,
                         NameID menu,
                         int opt)
                  throws ARException

Deletes the character menu with the indicated name from the specified server.

Throws:

ARException - if menu is not deleted

ARExpandMenu

public CharMenuInfo ARExpandMenu(ARServerUser context,
                                 CharMenuInfo menuDefn)
                          throws ARException

Expands the query and file references for the specified menu definition and returns a character menu with list-type items only.

Throws:

ARException - if references are not expanded

ARCreateSupportFile

public void ARCreateSupportFile(ARServerUser ctx,
                                SupportFile supportFile)
                         throws ARException

Creates the indicated support file. The user specifies information to identify the file and the system sends the file contents of the specified file to the server for storage.

Throws:

ARException - if file is not created

ARGetSupportFile

public void ARGetSupportFile(ARServerUser ctx,
                             SupportFileKey key,
                             SupportFileCriteria criteria,
                             SupportFile supportFile)
                      throws ARException

Retrieves a file supporting external reports.

Throws:

ARException - if file is not retrieved

ARSetSupportFile

public void ARSetSupportFile(ARServerUser ctx,
                             SupportFile supportFile,
                             SupportFileCriteria criteria)
                      throws ARException

Sets a support file in AR System.

Throws:

ARException - if file is not set

ARGetListSupportFile

public InternalID[] ARGetListSupportFile(ARServerUser ctx,
                                         SupportFileListCriteria listCriteria)
                                  throws ARException

Retrieves a list of support file IDs for a specified type of object.

Throws:

ARException - if list is not retrieved

ARGetListSupportFileObjects

public SupportFile[] ARGetListSupportFileObjects(ARServerUser ctx,
                                                 SupportFileListCriteria listCriteria,
                                                 SupportFileCriteria criteria)
                                          throws ARException

Retrieves a list of all accessible support file objects.

Throws:

ARException - if list is not retrieved

ARDeleteSupportFile

public void ARDeleteSupportFile(ARServerUser ctx,
                                SupportFileKey key)
                         throws ARException

Deletes a support file in AR System.

Throws:

ARException - if file is not deleted

ARGetEntryBlob

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

Retrieves the attachment, or binary large object (blob), stored for the attachment field with the indicated ID on the specified server.

Throws:

ARException - if blob is not retrieved

ARGetServerCharSet

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

Retrieves the servers char set.

Throws:

ARException - if information is not retrieved

ARGetClientCharSet

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

Retrieves the clients char set.

Throws:

ARException - if information is not retrieved

ARSetImpersonatedUser

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

Sets the user to be impersonated by the admin for this session.

Throws:

ARException - if information is not retrieved

ARGetServerInfo

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

Retrieves the requested configuration information for the specified server.

Throws:

ARException - if information is not retrieved

ARSetServerInfo

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

Updates the indicated configuration information for the specified server.

Throws:

ARException - if information is not updated

ARGetListServer

public ServerNameID[] ARGetListServer(ARServerUser context)
                               throws ARException

Retrieves the list of available AR System servers defined in the ar directory file. (UNIX only)

Throws:

ARException - if list is not retrieved

ARGetServerStatistics

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

Retrieves the requested statistics for the specified server.

Throws:

ARException - if statistics are not retrieved

ARSetServerPort

public 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.

Throws:

ARException - if port is not specified

ARExport

public 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.

Throws:

ARException - if structure is not exported

ARImport

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

Imports the indicated structure definitions to the specified server.

Throws:

ARException - if structure is not imported

ARGetFullTextInfo

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

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

Throws:

ARException - if information is not retrieved

ARSetFullTextInfo

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

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

Throws:

ARException - if information is not updated

ARGetTextForErrorMessage

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

Retrieves the message text for the specified error from the local catalog (in the local language). The length of the text is limited by Constants.AR_MAX_MESSAGE_SIZE (255 bytes).

Throws:

ARException - if text is not retrieved

ARGetEntryStatistics

public 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.

Throws:

ARException - if statistic is not computed

ARGetListSQL

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

Retrieves a list of rows from the underlying SQL database on the specified server.

Throws:

ARException - if list is not retrieved

ARExecuteProcess

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

Performs the indicated command on the specified server.

Throws:

ARException - if command is not performed

ARVerifyUser

public void ARVerifyUser(ARServerUser context,
                         boolean[] criteria)
                  throws ARException

Checks the cache on the specified server to determine whether the user you specify for the control parameter is registered in AR System.

Throws:

ARException - if cache is not checked

ARGetListGroup

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

Retrieves a list of access control groups on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListRole

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

Retrieves a list of roles for a deployable application on the specified server.

Throws:

ARException - if list is not retrieved

ARGetListUser

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

Retrieves a list of users on the specified AR System server.

Throws:

ARException - if list is not retrieved

ARSetSessionConfiguration

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

Allows session variables to be set.

Throws:

ARException - if variables are not set

ARGetSessionConfiguration

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

Allows the retrieval of session variables.

Throws:

ARException - if variables are not retrieved

ARSetLogging

public void ARSetLogging(ARServerUser context,
                         long type,
                         long location,
                         java.lang.String file)
                  throws ARException

Updates the indicated log information for the specified server.

Throws:

ARException - if information is not updated

ARGetQualifier

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

De-serialize Qualifer data structure.

Throws:

ARException

ARGetQualifierString

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

Serialize Qualifer data structure.

Throws:

ARException

AREncodeARQualifierStruct

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

Converts ARQualificationStruct to serialized qualification string.

Throws:

ARException - if not converted

ARDecodeARQualifierStruct

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

Converts serialized qualification string to ARQualificationStruct.

Throws:

ARException - if not converted

AREncodeARAssignStruct

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

Converts ARAssignStruct to serialized qualification string

Throws:

ARException - if not converted

ARDecodeARAssignStruct

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

Converts serialized Assign string to ARAssignStruct

Throws:

ARException - if not converted

AREncodeStatusHistory

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

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

Throws:

ARException - if not encoded

ARDecodeStatusHistory

public StatusHistoryInfo[] ARDecodeStatusHistory(ARServerUser context,
                                                 java.lang.String historyString)
                                          throws ARException

Takes a status history string as input and decodes it into an ARStatusHistoryList for easier processing. Return an error if the string is not correctly formatted.

Throws:

ARException - if not decoded

AREncodeDiary

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

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

Throws:

ARException - if not encoded

ARDecodeDiary

public DiaryInfo[] ARDecodeDiary(ARServerUser context,
                                 java.lang.String diaryString)
                          throws ARException

Takes a diary string as input and decodes it into an ARDiaryList for easier processing. Returns an error if the string is not correctly formatted.

Throws:

ARException - if not decoded

ARRegisterForAlerts

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

Registers a client with the server to receive alert indicators.

Throws:

ARException - if client not registered

ARDeregisterForAlerts

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

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

Throws:

ARException - if client not deregistered

ARCreateAlertEvent

public 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 indication of that event is sent to the specified user if that user is registered to receive them.

Throws:

ARException - if alert not entered

ARGetListAlertUser

public AccessNameID[] ARGetListAlertUser(ARServerUser context)
                                  throws ARException

Retrieves a list of users registered to receive alerts.

Throws:

ARException - if list not retrieved

ARGetAlertCount

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

Retrieves the count of alert events that meet the specified criteria.

Throws:

ARException - if list not retrieved

ARDecodeAlertMessage

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

Decode supplied alert message and return component parts.

Throws:

ARException - if message not decoded

ARGetLocalizedValue

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

Gets a localized text string from the message catalog schema. Returns 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.

Throws:

ARException - if string not returned

ARGetMultipleLocalizedValues

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

Gets multiple localized texts from the catalog file. It will return a blank return struct if nothing found.

Throws:

ARException - if string not returned

ARGetListSQLForActiveLink

public 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 ProcessResult ARExecuteProcessForActiveLink(ARServerUser context,
                                                   NameID actlinkName,
                                                   int actionIndex,
                                                   int actionType,
                                                   InternalID fieldId,
                                                   Timestamp timestamp,
                                                   EntryItem[] keywordList,
                                                   EntryItem[] parameterList,
                                                   boolean independentProcess)
                                            throws ARException

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

Throws:

ARException - if process not executed

ARGetMultipleExtFieldCandidates

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

Gets information about all the column/field candidates for an external schema

Throws:

ARException - if information not returned

ARGetListExtSchemaCandidates

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

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

Throws:

ARException - if list not returned

ARGetLocalHostID

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

Gets the local hostID

Throws:

ARException - if hostID not returned

ARGetAllLocalHostIDs

public HostID[] ARGetAllLocalHostIDs(ARServerUser context)
                              throws ARException

Gets all the local hostIDs

Throws:

ARException

ARValidateLicense

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

Validate license info. It will return LicenseValidInfo

Throws:

ARException - if information not validated

ARValidateMultipleLicenses

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

Validate multiple license info. It will return list of LicenseValidInfo

Throws:

ARException - if information not validated

ARGetListLicense

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

Get license information. It will return one or more LicenseInfo

Throws:

ARException - if information not returned

ARConvertBufferToListMenu

public CharMenuInfo ARConvertBufferToListMenu(java.lang.String menuBuffer)
                                       throws ARException

Converts a string to a CharMenuInfo object

Throws:

ARException - if string not converted

ARXMLCreateEntry

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

Creates entries in AR System with input XML and returns output XML

Throws:

ARException - if entry not created

ARXMLSetEntry

public 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

Sets entries in AR System with input XML and returns output XML

Throws:

ARException - if entry not set

ARXMLGetEntry

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

Gets entries from AR System with input XML and returns output XML

Throws:

ARException - if entry not returned

ARGetMultipleCurrencyRatioSets

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

Gets currency ratios list from server

Throws:

ARException - if list not returned

ARGetApplicationRequestedInfo

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

Gets the requested info by the application

Throws:

ARException - if cache is not checked

ARMultipleEntryPoints

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

Get the entry points

Throws:

ARException - if list is not retrieved

ARBeginBulkEntryTransaction

public void ARBeginBulkEntryTransaction(ARServerUser context)
                                 throws ARException

Marks the beginning of a bulk entry transaction.

Throws:

ARException - if an error occurs

AREndBulkEntryTransaction

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

Marks the ending of a bulk entry transaction.

Throws:

ARException - (subclass ARBulkException) if an error occurs