Package com.remedy.arsys.api

Interface Summary

ARErrors	The ARErrors class defines all the integer values used by the Java API as errors and warnings as constants.
Constants	The Constants interface defines all the integer values used by the Java API as Java constants.
IARIdentifier	The IARIdentifier class is the superclass of the different ID classes.
IARObjectFactory	The IARObjectFactory class is the superclass of the different <Object>Factory classes.
IARPersistentObject	The IARPersistentObject interface defines methods for all AR System server objects.
IARQualifierOperand	The IARQualifierOperand class is the superclass of the qualifier and relational operation classes.
IARRowIterator	The IARRowIterator class is the superclass that iterates through rows that are returned.
IARServerLogInterface	The IARLogInterface class is the superclass that iterates through rows that are returned.

Class Summary

AccessNameID	The AccessNameID class is used to represent the user name, password, and group name of an AR System user.
ActiveLink	The ActiveLink class and methods are used to represent the properties of active link objects.
ActiveLinkActionInfo	The ActiveLinkActionInfo class and methods are used for implementing active link actions.
ActiveLinkCriteria	The ActiveLinkCriteria class is used to specify the list of ActiveLink information to retrieve on a findByKey or findObjects call from the AR System server.
ActiveLinkFactory	The methods in the ActiveLinkFactory class are used to instantiate a new active link object or to get an existing active link from the server.
ActiveLinkKey	The ActiveLinkKey class provides a unique identifier for active link objects.
ActiveLinkMacroInfo	The ActiveLinkMacroInfo class lets you specify a macro to run whenever the active link is executed.
AlertMessageCriteria	The AlertMessageCriteria class defines what values you want returned for a particular message.
AlertMessageInfo	The AlertMessageInfo class is used to decode a formatted alert message and return its component parts, for example, timestamp, source type, and so on.
ArchiveInfo	The ArchiveInfo class and methods are used to represent the properties of ArchiveInfo objects.
ArithmeticOperationInfo	The ArithmeticOperationInfo class represents the result value from an arithmetic operation between ArithmeticOrRelationalOperand objects.
ArithmeticOrRelationalOperand	The ArithmeticOrRelationalOperand class represents the operand values of a arithmetic or relational operation.
ArithOpAssignInfo	The ArithOpAssignInfo class defines an arithmetic result value to assign in a Set Fields action.
ARQualifierHelper	The ARQualifierHelper class is the optimized way to get QualifierInfo.
ARServerUser	The ARServerUser class contains login information for accessing the AR System, including user name, password, and server.
AssignFieldInfo	The AssignFieldInfo class identifies a schema field value to assign in a Set Fields or Push Fields action.
AssignFilterApiInfo	The AssignFilterApiInfo class specifies a filter API result value to assign in a Set Fields action.
AssignInfo	The AssignInfo class lets you define Set Fields action in filters, escalations, or active links.
AssignSQLInfo	The AssignSQLInfo class specifies the SQL command and how the result is assigned to the field in a Set Fields action.
Attachment	The Attachment class is used to get/set the information about attachment fields.
AttachmentInfo	The AttachmentInfo class is used to get/set the information about attachment fields.
AttachmentLimitInfo	The AttachmentLimitInfo class defines the value limits for an attachment field (DataType.ATTACHMENT).
AuditInfo	The AuditInfo class and methods are used to represent the properties of AuditInfo objects.
AutomationInfo	The AutomationInfo class is used to define the information of an OLE Automation active link action.
BulkEntryReturn	The BulkEntryReturn class defines the return values for bulk entry calls.
ByteListInfo	The ByteListInfo class is used to represent image information.
CallGuideInfo	The CallGuideInfo class is used to represent information about the Call Guide active link action.
CharLimitInfo	The CharLimitInfo class defines the value limits for a character field (DataType.CHAR).
CharMenuDDFieldInfo	The CharMenuDDFieldInfo class returns the Data-Dictionary menu field object type.
CharMenuDDFormInfo	The CharMenuDDFormInfo class returns the Data-Dictionary menu form object type.
CharMenuDDInfo	The CharMenuDDInfo class returns information for a Data-Dictionary menu.
CharMenuFileInfo	The CharMenuFileInfo class returns information for file menu based on formatted flat file.
CharMenuInfo	The CharMenuInfo class returns the type of character menu.
CharMenuItemInfo	Each CharMenuItemInfo represents an individual menu item of a list menu.
CharMenuListInfo	The CharMenuListInfo class returns a list of items used in list menus.
CharMenuQueryInfo	The CharMenuQueryInfo class returns information for query menus.
CharMenuSQLInfo	The CharMenuSQLInfo class returns information for SQL menu.
CharMenuSSInfo	The CharMenuSSInfo class returns information for SS menu.
CloseWindowInfo	The CloseWindowInfo class is used to create and retrieve information about the Close Window active link action.
ColumnLimitInfo	The ColumnLimitInfo class represents the value limits for a column(DataType.COLUMN) field.
COMMethodInfo	The COMMethodInfo class defines an OLE Automation method.
COMMethodParmInfo	The COMMethodParmInfo class specifies the parameters used in COMValueInfo.
CommitChangesInfo	The CommitChangesInfo class is used to create and retrieve information about the Commit Changes active link action.
CompactQueryResult	This class is reserved for internal use only.
CompoundSchemaInfo	The CompoundSchemaInfo class is the superclass that represents the information for all composite schemas.
COMValueInfo	The COMValueInfo class is used to define the method and parameter values in the OLE Automation active link action.
Container	Class and methods for container object.
ContainerCriteria	The ContainerCriteria class is used to specify the list of Container information to retrieve on a findByKey or findObjects call.
ContainerFactory	The methods in the ContainerFactory class are used to instantiate a new container object or to get an existing container from the server.
ContainerKey	The ContainerKey class provides a unique identifier for container objects.
ContainerListCriteria	The ContainerListCriteria class lets you get or set a list of containers that match specified criteria.
ContainerMultiCriteria	The ContainerMultiCriteria class lets you get or set a list of containers that match specified criteria.
ContainerOwner	The ContainerOwner class lets you set or get the schema that owns the container, as well as the type of container being used (for example, a guide or an application).
ContainerType	The ContainerType class represents the different types of containers you can specify, for example, guides or applications or packing lists.
CoordinateInfo	The CoordinateInfo class returns the location of a field, that is, the field's X and Y coordinates.
CriteriaFlags	The CriteriaFlags class is used to describe the properties needed to be retrieved for many of the server objects.
CurrencyDetail	The CurrencyDetail class represents Currency Code information, that is, codes of different country's currencies.
CurrencyInfo	The CurrencyInfo class is used to define the Currency structure.
CurrencyLimitInfo	The CurrencyLimitInfo class defines the value limits for a Currency (DataType.CURRENCY) field
CurrencyPartInfo	The CurrencyPartInfo class represents the result value from an arithmetic operation between ArithmeticOrRelationalOperand objects.
DataType	The DataType class represents the data types of fields that are supported by the AR System.
DateInfo	The DateInfo class represents the days elapsed since January 1, 4713 B.C.
DayInfo	The DayInfo class is used to specify date and time information in defining escalation firing time.
DDEInfo	The DDEInfo class specifies a DDE result value to assign in a Set Fields action.
DecimalLimitInfo	The DecimalLimitInfo class defines the value limits for a decimal(DataType.DECIMAL) field
DefaultProxyManager	DefaultProxyManager is a singleton factory class that provides clients with Proxy instances.
Diary	The Diary class is used to set or retrieve the values of diary fields.
DiaryInfo	The DiaryInfo class is used to retrieve information about change diary fields.
DiaryLimitInfo	The DiaryLimitInfo class defines the value limits for a Diary(DataType.DIARY) field
DisplayInstanceInfo	The DisplayInstanceInfo class defines the display instance of a field for a particular schema view.
DisplayInstanceList	The DisplayInstanceList class defines the display properties of a field for all associated schema views.
DisplayLimits	The DisplayLimits class defines the value limits for a character(DataType.CHAR) field.
Entry	The Entry class is used to set and retrieve information about entries in a schema.
EntryCriteria	The EntryCriteria class is used to specify the list of Entry information to retrieve on a findByKey or findObjects call from the AR System server.
EntryFactory	The methods in the EntryFactory class are used to instantiate a new entry object or to get the existing entry of a form.
EntryID	The EntryID class is used to uniquely identify an entry for a particular schema from the AR System server.
EntryItem	The EntryItem class represents the collection of entry items that comprise an entry.
EntryKey	The EntryKey class uniquely identifies a field entry ID.
EntryListCriteria	The EntryListCriteria class is used to define the criteria for selecting a list of entries from AR System.
EntryListFieldInfo	Defines the fields (zero or more) to return with each entry, while retrieving entries from the server.
EntryListInfo	The EntryListInfo class represents an entry consisting of individual field values represented as a string.
EntryPointInfo	The EntryPointInfo class and methods are used to represent the properties of entry point objects.
EntryPointMultiCriteria	The EntryPointMultiCriteria class specifies the entry point properties to retrieve.
EntryPointMultiListCriteria	The EntryPointMultiListCriteria class retrieves the entry points that match the specified criteria.
EntryReturn	The EntryReturn class defines the return values for entry related bulk calls that return an entry Id.
EnumItem	The EnumItem class provides a definition for Custom Enumerated fields.
EnumLimitInfo	The EnumLimitInfo class defines the value limits for a selection(DataType.ENUM) field.
Escalation	The Escalation class and methods are used to represent the properties of escalation objects.
EscalationCriteria	The EscalationCriteria class is used to specify the list of Escalation information to retrieve on a findByKey or findObjects call from the AR System server.
EscalationFactory	The methods in the EscalationFactory class are used to instantiate a new escalation object or to get an existing escalation from the server.
EscalationKey	The EscalationKey class provides a unique identifier for escalation objects.
EscalationTmInfo	The EscalationTmInfo class represents the time specification for evaluating the escalation condition.
ExitGuideInfo	The ExitGuideInfo class is used to create and retrieve information about the Exit Guide active link action.
ExternalReferenceInfo	The ExternalReferenceInfo class represents non-AR System server objects.
ExtFieldCandidatesInfo	The ExtFieldCandidatesInfo class returns information about all the columns/fields candidates for an external compound schema.
Field	The Field class and methods are used to represent the properties of field objects.
FieldAssignInfo	The FieldAssignInfo class represents the field/value pair used in the field list in the workflow Set Fields action (AssignInfo).
FieldCharacteristicsInfo	The FieldCharacteristicsInfo class is used to change display characteristics of fields.
FieldCriteria	The FieldCriteria class is used to specify the list of Field information to retrieve on a findByKey or findObjects call.
FieldFactory	The methods in the FieldFactory class are used to instantiate a new field object or to get an existing field from the server.
FieldID	The FieldID class and methods contains static members of type FieldID for each field ID of the AR System core fields.
FieldKey	The FieldKey class provides a unique identifier for field objects.
FieldLimitInfo	The FieldLimitInfo class is used to define value limits for data fields of any type.
FieldListCriteria	The FieldListCriteria class is used to get or set a list of fields that match specified criteria.
FieldMappingInfo	The FieldMappingInfo class is used to map join fields to compound schemas (CompoundSchemaInfo).
FieldType	The FieldType class returns a list of fields for a particular form on the specified server.
Filter	The Filter class and methods are used to represent the properties of filter objects.
FilterActionInfo	The FilterActionInfo class and methods are used for implementing filter actions.
FilterCriteria	The FilterCriteria class is used to specify the list of Filter information to retrieve on a findByKey or findObjects call from the AR System server.
FilterFactory	The methods in the FilterFactory class are used to instantiate a new filter object or to get an existing filter from the server.
FilterKey	The FilterKey class provides a unique identifier for filter objects.
FilterStatusInfo	The FilterStatusInfo class returns the type of filter message error generated by a function call.
FullTextInfo	The FullTextInfo class is used to set or retrieve the requested Full Text Search (FTS) information for the specified server.
FuncCurrencyInfo	The FuncCurrencyInfo class is used to represent information about the functional currency.
FunctionAssignInfo	The FunctionAssignInfo class specifies a function return value to assign in a Set Fields action.
GotoActionInfo	The GotoActionInfo class is used to create and retrieve information about the Goto workflow action.
GotoGuideLabelInfo	The GotoGuideLabelInfo class is used to create and retrieve information about the Go To Guide Label workflow action.
GroupInfo	This GroupInfoclass defines the properties of a group on the AR System server.
HostID	The HostID class represents information about host IDs.
IndexInfo	The IndexInfo class defines which fields are indexed on the schema.
IntegerLimitInfo	The IntegerLimitInfo class defines the value limits for an integer(DataType.INTEGER) field.
InternalID	The InternalID class represents an internal ID of an AR System object.
JoinEntryID	The JoinEntryID class represents the composite Entry ID created when two or more schemas are joined together.
JoinMappingInfo	The JoinMappingInfo class contains the index of the base schema and the ID of the field to map to this field.
JoinSchemaInfo	The JoinSchema class represents a type of "compound schema" consisting of a join between two or more AR System schemas.
Keyword	The Keyword class represents keywords you can use in qualification criteria.
LicenseDateInfo	The LicenseDateInfo class represents information used for license dates.
LicenseInfo	The LicenseInfo class represents detailed information about licenses.
LicenseKeyID	The LicenseKeyID class represents information about license keys.
LicenseNameID	The LicenseNameID class represents information about license names.
LicenseValidInfo	The LicenseValidInfo class represents validation information for a license.
LocaleID	The LocaleID class represents locale information, which includes information about language and country.
LocalizedRequestInfo	The LocalizedRequestInfo class is used to describe the properties of a message.
LocalizedValueCriteria	The LocalizedValueCriteria class defines what values you want returned for a particular message, that is, whether you want to return the message text value, the time stamp, or both.
LocalizedValueInfo	The Util.ARGetLocalizedValue utility returns the LocalizedValueInfo object.
LoggingInfo	The LoggingInfo class updates the indicated logging information for the specified server.
MacroParmInfo	The MacroParmInfo class lets you enter a name/value pair of the parameters used in the Run Macro active link action (ActiveLinkMacroInfo).
Menu	The Menu class and methods are used to represent the properties of menu objects.
MenuCriteria	The MenuCriteria class is used to specify the list of Menu information to retrieve on a findByKey or findObjects call from the AR System server.
MenuFactory	The methods in the MenuFactory class are used to instantiate a new menu object or to get an existing menu from the server.
MenuKey	The MenuKey class provides a unique identifier for menu objects.
MenuListCriteria	The MenuListCriteria class lets you specify parameter values used to retrieve menu object from AR System server.
MessageInfo	The MessageInfo class is used to define the message information that is generally used to display an interactive error, warning, or note.
NameID	The NameID class represents the names of objects.
NotifyActionInfo	The NotifyActionInfo class is used to to send a message to specified users or groups by email, Remedy Alert, or other mechanism for any transaction that meets the filter or escalation conditions.
NotifyActionInfoAdvanced	The NotifyActionInfoAdvanced class is used to to send a message to specified users or groups by email, Remedy Alert, or other mechanism for any transaction that meets the filter or escalation conditions.
ObjectBase	The ObjectBase class is used to store the information common to most AR System objects, for example, their help text, change diaries, permissions, and so on.
OpenDialogInfo	The OpenDialogInfo class is used to open all 10 types of AR System windows, including: Constants.AR_ACTIVE_LINK_ACTION_OPEN_DLG Constants.AR_ACTIVE_LINK_ACTION_OPEN_SEARCH Constants.AR_ACTIVE_LINK_ACTION_OPEN_SUBMIT Constants.AR_ACTIVE_LINK_ACTION_OPEN_MODIFY_LST Constants.AR_ACTIVE_LINK_ACTION_OPEN_MODIFY_DETAIL Constants.AR_ACTIVE_LINK_ACTION_OPEN_MODIFY_SPLIT Constants.AR_ACTIVE_LINK_ACTION_OPEN_DSPLY_LST Constants.AR_ACTIVE_LINK_ACTION_OPEN_DSPLY_DETAIL Constants.AR_ACTIVE_LINK_ACTION_OPEN_DSPLY_SPLIT Constants.AR_ACTIVE_LINK_ACTION_OPEN_REPORT
OperandType	The OperandType class defines the operands that can be used in any relational operation that compares values, for example, in qualifications.
PermissionInfo	The PermissionInfo class specifies the permissions for an AR System object.
PoolingProxyManager	ProxyManager is a singleton factory class that provides clients with Proxy instances.
ProcessResult	The ProcessResult performs the indicated command on the specified server.
PropInfo	The PropInfo class uses a tag-value pair (AR_DROP_/AR_DVAL_) to describe the properties of server objects in the AR System.
Proxy	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.
ProxyManager	ProxyManager is a factory class that provides clients with Proxy instances.
ProxyManager.PoolInfo
PushFieldsActionInfo	The SetFieldsActionInfo class is used to change the values of fields in existing entries or create a new entry during a transaction.
PushFieldsInfo	The PushFieldsInfo class is used to transfer values from selected fields in the current request to the same or another request each time an operation is successful and conditions are met.
QualifierFromFieldInfo	The QualifierFromFieldInfo class is used for dynamic qualification, which means the qualifier string can be obtained from a field.
QualifierInfo	The QualifierInfo class is composed of a set of zero or more conditions that limit the set of entries retrieved.
QueryInfo	The QueryInfo class represents how a query should be processed.
RealLimitInfo	The RealLimitInfo class defines the value limits for a real number(DataType.REAL) field.
ReferenceBase	The ReferenceBase class is the base class for ReferenceBase.SYSTEM_REFERENCE and ReferenceBase.EXTERNAL_REFERENCE.
ReferenceInfo	The ReferenceInfo class represents the names of internal AR System objects, for example, filters, active links, and so on.
ReferenceType	The ReferenceType class specifies the type of internal and external references that can be used by the ReferenceBase.getReferenceType() method.
RelationalOperationInfo	The RelationalOperationInfo class represents any relational operation between any ArithmeticOrRelationalOperand objects.
RoleInfo	This RoleInfoclass defines the properties of a role on the AR System server.
Schema	The Schema class and methods are used to represent the properties of schema objects.
SchemaAliasesCriteria	The SchemaAliasesCriteria class is used to specify the type of schema aliases to retrieve.
SchemaAliasInfo	The SchemaAliasInfo class represents information about schema aliases.
SchemaCriteria	The SchemaCriteria class is used to specify the list of Schema information to retrieve on a findByKey or findObjects call.
SchemaFactory	The methods in the SchemaFactory class are used to instantiate a new schema object or to get an existing schema from the server.
SchemaKey	The SchemaKey class provides a unique identifier for schema objects.
SchemaListCriteria	The SchemaListCriteria class is used to specify the type of schemas to retrieve on a find call.
SchemaType	The SchemaType class retrieves a list of schemas on the specified server.
ServerInfo	The ServerInfo class represents the server information operations and their values returned from a server.
ServerNameID	The ServerNameID class is used to represent the ID of the AR System server name.
SetFieldsActionInfo	The SetFieldsActionInfo class is used to change the values of fields during a transaction.
SortInfo	The SortInfo class specifies the sort order of fields from an entry list.
SQLInfo	The SQLInfo class represents the filter/active link action used to submit any legal SQL command to the database.
SQLResult	The SQLResult class returns a list of result values returned from an SQL query.
StatisticsResultInfo	The StatisticsResultInfo class returns statistics (aggregates) for the form entries, and identifies which group-by values were used to compile the statistics.
Status	The Status class represents a message generated by a function call and consists of four elements: Status.m_messageType -- Integer value indicating the type of message being returned.
StatusHistory	The StatusHistory class is used to represent the values of status history fields.
StatusHistoryInfo	The StatusHistoryInfo class retrieves the the user and time stamp components of the Status History core field.
StatusHistoryValue	The StatusHistoryValue class allows user to refer to the status history associated with changes.
StatusInfo	The StatusInfo class represents a message generated by a function call.
StructItemInfo	The StructItemInfo class represents a particular object to export or import.
SupportFile	The SupportFile class and methods is used to represent the properties of a support file.
SupportFileCriteria	The SupportFileCriteria class is used to specify the list of SupportFile information to retrieve on a findByKey or findObjects call.
SupportFileFactory	The methods in the SupportFileFactory class are used to instantiate a new support file object or to get an existing support file from the server.
SupportFileKey	The SupportFileKey class provides a unique identifier for support file objects.
SupportFileListCriteria	The SupportFileListCriteria class is used to define the search criteria for retrieving the support files from the server.
TableLimitInfo	The TableLimitInfo class defines the value limits for a table(DataType.TABLE) field.
Time	The Time class represents the time elapsed since midnight.
Timestamp	The Timestamp class represents the time at which an operation was performed.
UserInfo	The UserInfo class contains information about users in AR System.
UserLicenseInfo	The UserLicenseInfo class contains information about user's licenses in AR System.
Util	The Util class combines all the functions not related to specific server objects into a "catch-all" class.
Value	The Value class represents the value information associated to a field.
VendorMappingInfo	The VendorMappingInfo class contains the field name in a vendor schema derived from an external data source.
VendorSchemaInfo	The VendorSchemaInfo class represents a type of "external" schema that is created from a non-database source (for example, an XML file).
VerifyUserCriteria	The VerifyUserCriteria class is used in verifying user privileges.
View	The View class represents the form view (VUI) with the indicated name on the specified server.
ViewCriteria	The ViewCriteria class is used to specify the list of View information for any view object on the AR System server.
ViewFactory	The methods in the ViewFactory class are used to instantiate a new view object or to get an existing view from the server.
ViewKey	The ViewKey class provides a unique identifier for VUI objects.
ViewLimits	The ViewLimits class defines the value limits for a character(DataType.CHAR) field
ViewListCriteria	The ViewListCriteria class is used to define the criteria for selecting the list of views (VUIs) of a particular form on the specified server.
ViewMappingInfo	The ViewMappingInfo class contains the field name of the external table.
ViewSchemaInfo	The ViewSchemaInfo class represents a type of "external" schema that is created from a non-AR System database source, for example, an MS Access database.
WaitInfo	The WaitInfo class represents the Wait active link action that causes the current guide to wait for user input.
WorkflowConnectInfo	The WorkflowConnectInfo class represents the list of schemas the workflow object (for example, an active link) is connected to.
WorkflowLockInfo	The WorkflowLockInfo class represents detailed information about workflow lock.
WorkflowObjectListCriteria	The WorkflowObjectListCriteria class returns a list of workflow objects connected with a specific schema.
XMLEntryReturn	The XMLEntryReturn class defines the return values for XML entry related bulk calls that return an output document.

Exception Summary

ARBulkException	The ARBulkException class defines the exceptions generated by the bulk entry transaction API.
ARException	The ARException class represents the exceptions generated by API.