|
AR System Java API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
ActiveLink class and methods are used to represent the properties of active link objects.ActiveLinkAction class and methods are used for implementing active link actions.ActiveLinkCriteria class is used to specify the list of ActiveLink information to retrieve
call from the AR System server.QueryFormField fields that the dynamic query selects.
QueryFormField fields that the dynamic query selects.
IQuerySource sources that the dynamic query selects from.
IQuerySource sources that the recursive query selects from.
SortInfo object to the list
AlertCallbackHandler interface and supplies
an instance of it to AlertMessageCriteria class defines what values you want returned for a particular message.AlertMessageInfo class is used to decode a formatted alert message and return its component parts,
for example, timestamp, source type, and so on.AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_DEBUG_MODE).
appl.aud)
appl.vio)
AR_ARITH_OP_ADD adds the left and right operands.
AR_ARITH_OP_DIVIDE divides the left operand by the right operand.
AR_ARITH_OP_MODULO finds the remainder after dividing the left operand by
the right operand.
AR_ARITH_OP_MULTIPLY multiplies the left and right operands.
AR_ARITH_OP_NEGATE changes the sign of the right operand (left operand is
ignored).
AR_ARITH_OP_SUBTRACT subtracts the right operand from the left operand.
AR_ASSIGN_TYPE_ARITH is the result value from an arithmetic operation.
AR_ASSIGN_TYPE_DDE is the result value from a DDE request to another
application.
AR_ASSIGN_TYPE_FIELD is a Form field value.
AR_ASSIGN_TYPE_FILTER_API is the result value from a filter API
command.
AR_ASSIGN_TYPE_FUNCTION is the return value from a function.
AR_ASSIGN_TYPE_NONE No value is assigned.
AR_ASSIGN_TYPE_PROCESS is the output value from successful execution of
an operating system process or command.
AR_ASSIGN_TYPE_SQL is the result value from a SQL command.
AR_ASSIGN_TYPE_VALUE is a Constant or keyword value.
getDataField or
setDataField methods of ColumnFieldLimit.
getDataField or
setDataField methods of ColumnFieldLimit.
getDataField or
setDataField methods of ColumnFieldLimit.
getDataField or
setDataField methods of ColumnFieldLimit.
getDataField or
setDataField methods of ColumnFieldLimit.
AND operator.
NOT operator.
OR operator.
Util class used to parse a qualification from an active link.
parseAssignment and formatAssignment in ARServerUser class used to parse a Assignment from an active link.
parseAssignment and formatAssignment in ARServerUser class used to parse a Assignment from an escalation.
parseAssignment and formatAssignment in ARServerUser class used to parse a Assignment from an escalation.
parseAssignment and formatAssignment in ARServerUser class used to parse an Assignment from an escalation.
parseAssignment and formatAssignment in ARServerUser class used to parse a Assignment from a filter.
parseAssignment and formatAssignment in ARServerUser class used to parse a Assignment from a filter.
parseAssignment and formatAssignment in ARServerUser class used to parse a Assignment from a search menu.
AR_CURRENCY_FLD is a value from the CurrencyPart field to compare in a
relational operation.
UTF-8)
AR)
ar)
AR_DPROP_ALIAS_SINGULAR)
AR_DPROP_ALIAS_SINGULAR)
AR_DPROP_ALIAS_SINGULAR).
AR_DPROP_ALIAS_SINGULAR).
AR_DPROP_ALIAS_SINGULAR).
AR_DPROP_HTML_TEXT.
AR_DVAL_COLOR_*, for example, Constants.AR_DVAL_COLOR_BG.
AR_DVAL_COLOR_*, for example, Constants.AR_DVAL_COLOR_BG.
Constants.AR_DVAL_JUSTIFY_DEFAULT:
Bit 0: Sets horizontal alignment of the label to default location (left-justified).
AR_DPROP_LABEL_POS_ALIGN).
Constants.AR_DVAL_PAGE_FIELD_NONEDITABLE)
1: Editable ( Constants.AR_DVAL_PAGE_FIELD_EDITABLE)
Constants.AR_DPROP_LABEL_ALIGN) is bottom-aligned.
Constants.AR_DPROP_LABEL_ALIGN field label.
Constants.AR_DPROP_LABEL_ALIGN) is
expand-to-fill.
Constants.AR_DPROP_LABEL_ALIGN) is middle-aligned.
Constants.AR_DPROP_LABEL_ALIGN) is tile-to-fill.
Constants.AR_DPROP_LABEL_ALIGN) is top-aligned.
AR_DPROP_MENU_MODE).
AR_DPROP_MENU_MODE).
AR_DPROP_MENU_MODE).
AR_DPROP_MENU_MODE).
AR_DPROP_MENU_MODE) is activated (yes/no).
AR_DPROP_MENU_MODE).
Constants.AR_DPROP_JOINT_STYLE).
Constants.AR_DPROP_JOINT_STYLE).
Constants.AR_DPROP_JOINT_STYLE).
Constants.AR_DPROP_JOINT_STYLE).
Constants.AR_DVAL_JOINT_ROUNDED and Constants.AR_DVAL_JOINT_MAX_SMOOTH when
lines are joined (Constants.AR_DPROP_JOINT_STYLE).
ARCONFIGDIR)
AR_FIELD is a form field value to compare in a relational operation.
AR_HIDDEN_INCREMENT as attribute parameter to retrieve both visible
and hidden containers.
araudit.conf)
araudit.conf)
/etc) containing config files.
conf)
ar.conf)
ar.cfg)
ardb.conf)
ardb.cfg)
/usr/ar)
c:\\arservdbcode)
Constants.AR_KEYWORD_BROWSER is the browser type (client only).
Constants.AR_KEYWORD_CLIENT_TYPE is the client type of the api program.
Constants.AR_KEYWORD_CURRENTWINID returns the window id of the current window
(client only)
Constants.AR_KEYWORD_DATABASE is the name of the database used on the current server.
Constants.AR_KEYWORD_DATE_ONLY is the current date (time defaults to midnight).
Constants.AR_KEYWORD_DEFAULT is the the
administrator-defined default for the field
Constants.AR_KEYWORD_ERRAPPENDMSG is additional appended message(if any) of the error above.
Constants.AR_KEYWORD_ERRMSG is error message of the current action.
Constants.AR_KEYWORD_ERRNO is errorcode of the current action.
Constants.AR_KEYWORD_EVENTDATA is The data for the event sent to
window (client only).
Constants.AR_KEYWORD_EVENTSRCWINID is the window ID from which the event was
sent (client only).
Constants.AR_KEYWORD_EVENTTYPE is the type or name of event received by the
window (client only).
Constants.AR_KEYWORD_FIELDID returns the field ID for the currently
selected field (client only).
Constants.AR_KEYWORD_FIELDLABEL returns the field label for the currently
selected field (client only).
Constants.AR_KEYWORD_FIELDNAME returns the field name for the currently
selected field (client only).
Constants.AR_KEYWORD_GROUPIDS are the ids for groups which the current user is a member (returns an
empty string for escalations).
Constants.AR_KEYWORD_GROUPS are the groups of which the current user is a member (returns an
empty string for escalations).
Constants.AR_KEYWORD_HARDWARE is the hardware on which the process is running.
Constants.AR_KEYWORD_HOMEURL is the base location of the mid tier install.
Constants.AR_KEYWORD_INBULKTRANS indicates if currently in a bulk
entry transaction.
Constants.AR_KEYWORD_INCLNTMANAGEDTRANS is additional appended message(if any) of the error above.
Constants.AR_KEYWORD_LASTCOUNT is the number of requests returned from the most recent search.
Constants.AR_KEYWORD_LASTID is the keyword contains the Request ID
of the most recently created request during the user's login
environment.
Constants.AR_KEYWORD_LASTOPENEDWINID returns the window ID from the last open
window action (client only).
Constants.AR_KEYWORD_LOCALE is the user locale.
Constants.AR_KEYWORD_NO is No more keywords.
Constants.AR_KEYWORD_OPERATION is the current operation (for example, CREATE).
Constants.AR_KEYWORD_OS is the operating system of the machine on which a process is
running.
Constants.AR_KEYWORD_ROLES is the set of roles the current user is a member of.
Constants.AR_KEYWORD_ROWCHANGED
indicates if a row in table field was changed (client only).
Constants.AR_KEYWORD_ROWSELECTED
indicates if a row in table field was selected (client only).
Constants.AR_KEYWORD_SCHEMA is the name of the current form.
Constants.AR_KEYWORD_SCHEMA_ALIAS is the alias name for the current form.
Constants.AR_KEYWORD_SERVER is the name of the current AR System server.
Constants.AR_KEYWORD_SERVERTIMESTAMP is the current date/time on
the server (same as AR_KEYWORD_TIMESTAMP on server).
Constants.AR_KEYWORD_TCPPORT is the TCP/IP Port of the local AR System server.
Constants.AR_KEYWORD_TIME_ONLY is the current time (date defaults to today).
Constants.AR_KEYWORD_TIMESTAMP is the current date/time.
Constants.AR_KEYWORD_USER is the current user login.
Constants.AR_KEYWORD_VERSION is the software version running on the client (active links) or server
(filters and escalations).
Constants.AR_KEYWORD_VUI_TYPE is the VUI type.
Constants.AR_KEYWORD_WEEKDAY is the current day of the week as a character string.
AR_LOC_BUFFER specifies that the contents of the blob should be returned/set in a
data buffer.
AR_LOC_FILENAME specifies that the contents of the blob should be returned/set
in a file.
ar.log)
AR_MAX_COM_ID_SIZE (128 bytes).
AR_MAX_COM_METHOD_NAME (128 bytes)
AR_MAX_COM_NAME (64 bytes).
AR_MAX_ENTRYID_SIZE).
AR_MAX_SDESC_SIZE.
$MENU$) in the merge
must enter a keyword value pattern of alphabetic characters and digits (and blank space) (
$ALNUM$) into the character field.
must enter a keyword value pattern of alphabetic characters (and blank space) (
$ALPHA$) into the character field.
must enter a keyword value pattern of digits ($DIGIT$) into the character field.
must enter a keyword value pattern of any character ($LOWER$) except uppercase
letters into the character field.
must enter a keyword value pattern that matches an item defined in the menu attached to the
field ($MENU$) into the character field.
must enter a keyword value pattern of printable characters ($PRINT$) into the
character field.
must enter a keyword value pattern of any character ($UPPER$) except lowercase
letters into the character field.
LIKE %value% operation to perform on QBE screen.
= operation to perform on QBE screen.
LIKE value% operation to perform on QBE screen.
Util class used to parse a qualification from an active link.
Util class used to parse a qualification from an escalation.
Util class used to parse a qualification from a filter.
Util class used to parse a qualification from a search menu.
NULL value to all of the fields that you are setting if multiple matches are found in
selected form.
Constants.AR_REL_OP_EQUAL
tests whether the left operand is equal to the right operand.
Constants.AR_REL_OP_GREATER
tests whether the left operand is greater than the right operand.
Constants.AR_REL_OP_GREATER_EQUAL
tests whether the left operand is greater than or is equal to the right operand.
Constants.AR_REL_OP_IN
tests whether the left operand is in a subset of data returned by the right operand.
Constants.AR_REL_OP_LESS
tests whether the left operand is less than the right operand.
Constants.AR_REL_OP_LESS_EQUAL
tests whether the left operand is less than or is equal to the right operand.
Constants.AR_REL_OP_LIKE
tests whether the left operand is LIKE the pattern defined by the right operand.
Constants.AR_REL_OP_NOT_EQUAL
tests whether the left operand is not equal to the right operand.
Constants.AR_REL_OP_NOT_IN
tests whether the left operand is not in a subset of data returned by the right operand.
NULL schema.
AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_DEBUG_MODE).
arplugin.
AR_SERVER_INFO_DEBUG_MODE).
arservtcd thread.
AR_SERVER_INFO_DEBUG_MODE) (Windows only).
AR_SERVER_INFO_DEBUG_MODE).
AR_STAT_HISTORY is a value from the Status-History core field to compare in a
relational operation.
IN operator
ARBulkException class defines the exceptions generated by the bulk entry transaction API.ArchiveInfo class and methods are used to represent the properties of ArchiveInfo objects.ARErrors class defines all the integer values used by the Java API as errors and warnings as
constants.ARException class represents the exceptions generated by API.ArithmeticOperationInfo class represents the result value from an arithmetic operation between
ArithmeticOrRelationalOperand objects.ArithmeticOrRelationalOperand class represents the operand values of a arithmetic or relational
operation.OperandType and FieldID TO BE DEPRECATED
IQuerySource interface
Value object
StatusHistoryValueIndicator
QueryInfo object
ValueSetQuery object
ArithOpAssignInfo class defines an arithmetic result value to assign in a Set Fields action.ARMAX_CON_DESCRIPTION_LEN (2000 bytes).
ARNativeAuthenticationInfo interface is implemented by peripheral components
of the AR Server to be able to return the user credentials for the user who triggered the api
call that led to a call to the component.ARQualifierHelper class is the optimized way to get QualifierInfo.arsys_base.xml)
AssignFieldInfo class identifies a form field value to assign in a Set Fields or Push Fields
action.AssignFilterApiInfo class specifies a filter API result value to assign in a Set Fields action.AssignFilterApiInfo object.
AssignInfo class lets you define Set Fields action in filters, escalations, or active links.AssignSQLInfo class specifies the SQL command and how the result is assigned to the field in a Set
Fields action.AttachmentFieldLimit class defines the value limits for an attachment field (DataType.ATTACHMENT).AttachmentLimitInfo object, defaulting the full text option to none (Constants.AR_FULLTEXT_OPTIONS_NONE).
AttachmentLimitInfo object, allowing the specification of a full text option.
AttachmentValue class is used to get/set the information about attachment fields.AuditInfo class and methods are used to represent the properties of AuditInfo objects.BulkEntryReturn class defines the return values for bulk entry calls.BulkEntryReturn object
ByteListValue class is used to represent image information.CallGuideAction class is used to represent information about the Call Guide active link action.ChangeFieldAction class is used to change display characteristics of fields.CharacterFieldLimit class defines the value limits for a character field (DataType.CHAR).CharLimitInfo object
CharLimitInfo object
CharLimitInfo object
ARServerUser.logout()
CloseWindowAction class is used to create and retrieve information about the Close Window active
link action.closeAll parameter sets the flag that indicates whether all the windows should be closed or not.
Constants.AR_COLUMN_LIMIT_DATASOURCE_DATA_FIELD.
Constants.AR_COLUMN_LIMIT_DATASOURCE_DISPLAY_FIELD.
ColumnFieldLimit class represents the value limits for a column(DataType.COLUMN)
field.ColumnLimitInfo object.
ColumnLimitInfo object.
COMMethodInfo class defines an OLE Automation method.COMMethodParmInfo class specifies the parameters used in COMValueInfo.CommitChangesAction class is used to create and retrieve information about the Commit Changes active
link action.COMValueInfo class is used to define the method and parameter values in the OLE Automation active
link action.Constants interface defines all the integer values used by the Java API as Java
constants.ContainerCriteria class is used to specify the list of Container information.ContainerCriteria object.
ContainerOwner class lets you set or get the container owner type, as
well as the name of the form, if the owner type is a form.ContainerType class represents the different types of containers you can specify, for example,
guides or applications or packing lists.ControlField is a type of field that controls workflow, but
do not have data behind it.MenuItem objects
CoordinateInfo class returns the location of a field, that is, the field's X and Y coordinates.CoreFieldId is an enum class that lists all the AR System core fields with their field IDs.ActiveLink object on AR System server.
Escalation object into AR System server.
Filter object on AR System server.
CriteriaFlags class is used to describe the properties needed to be retrieved for many of the
server objects.Criteria object with the given properties.
CurrencyDetail class represents Currency Code information, that is, codes of different country's
currencies.CurrencyFieldLimit class defines the value limits for a
Currency (DataType.CURRENCY) fieldCurrencyLimitInfo object.
CurrencyLimitInfo object using the limit and precision info
CurrencyLimitInfo object using the limit and precision info
CurrencyPartInfo class represents the result value from an arithmetic operation between
ArithmeticOrRelationalOperand objects.CurrencyValue class stores the value, code and date when currecy
was entered.DataDictionaryMenu class returns information for a Data-Dictionary menu.DataType class represents the data types of fields that are supported by the AR System.DateInfo class represents the days elapsed since January 1, 4713 B.C.DateOnlyFieldLimit class defines the value limits for an integer(DataType.INTEGER)
field.DateTimeFieldLimit class defines the value limits for an integer(DataType.INTEGER)
field.DayInfo class is used to specify date and time information in defining escalation firing time.DDEAction class specifies a DDE result value to assign in a Set Fields
action.DecimalFieldLimit class defines the value limits for a decimal(DataType.DECIMAL)
fieldDecimalLimitInfo object.
ARServerUser.decodeAssignment(java.lang.String)
ARServerUser.decodeQualification(java.lang.String)
DiaryListValue for easier processing.
DefaultProxyManager is a singleton factory class that provides clients with Proxy instances.DiaryFieldLimit class defines the value limits for a DiaryList(DataType.DIARY)
fieldDiaryLimitInfo object.
DiaryItem class is used to retrieve information about change diary fields.DiaryListValue class is used to set or retrieve the values of diary fields.DirectSqlAction class represents the filter/active link action used to issue any legal
SQL command to the database.DisplayFieldLimit class defines the value limits for a display(DataType.DISPLAY)
field.DisplayFieldLimit object using the given maximum length.
DisplayFieldLimit object using the given maximum length and length unit.
DisplayInstanceMap class defines the display properties of a field for all associated form
views.DisplayPropertyMap class defines the display properties of ARSystem fields and views.name parameter depends on
AR_SERVER_INFO_DEBUG_MODE).
ARDiaryList into an encoded diary string.
StatusHistory into an encoded diary string.
ARServerUser.encodeAssignment(com.bmc.arsys.api.AssignInfo)
ARServerUser.encodeQualification(com.bmc.arsys.api.QualifierInfo)
DiaryListValue as input and encodes it into a diary string.
Entry class defines the entry of ARSystem forms.EntryKey class uniquely identifies a field entry ID.String and entryID String object of class
EntryListFieldInfo object.
EntryListInfo class represents an entry consisting of individual field values represented as a
string.EntryPointInfo class and methods are used to represent the properties of entry point objects.EntryReturn class defines the return values for entry related bulk calls that return an entry Id.EntryReturn object
EnumItem class provides a definition for Custom Enumerated fields.Escalation class and methods are used to represent the properties of escalation objects.AR_SERVER_INFO_DEBUG_MODE).
EscalationCriteria class is used to specify the list of Escalation information to retrieve
from the AR System server.EscalationInterval is an escalation time criteria which defines the criteria as
a time interval (number of seconds)EscalationTmInfo class represents the time specification for evaluating the escalation condition.ExitGuideInfo class is used to create and retrieve information about the Exit Guide active link
action.ExitGuideInfo object using the closeAll parameter.
ARServerUser.exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
ARServerUser.exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
ARServerUser.exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
ARServerUser.exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
ARServerUser.exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
ARServerUser.exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
ExtendedClassCallbackHandler interface described the callback methods that an implementing class can
receive, if the class were to be registered as an extending class for an AR System Java API class.ExtendedClassRegistry acts as a registration mechanism for client programs to designate their own
implementation classesthat extend AR System Java API classes (i.e.ExternalReference class represents non-AR System server objects.ExtFieldCandidatesInfo class returns information about all the columns/fields candidates for an
external compound form.ExtFieldCandidatesInfo class returns information about all the columns/fields candidates for an
external compound form.Field class and methods are used to represent the properties of field objects.FieldAssignInfo class represents the field/value pair used in the field list in the workflow Set
Fields action (AssignInfo).FieldCriteria class is used to specify the list of Field informationFieldCriteria object.
CharMenuDDFieldInfo class returns the Data-Dictionary menu field object type.FieldKey class provides a unique identifier for field objects.FieldLimit class is used to define value limits for data fields of any type.FieldMapping class is the superclass that represents the information for all field mappings.FieldType class returns a list of fields for a particular form on the specified server.FileMenu class returns information for file menu based on formatted flat file.Filter class and methods are used to represent the properties of filter objects.AR_SERVER_INFO_DEBUG_MODE).
FilterAction class and methods are used for implementing filter actions.FilterCriteria class is used to specify the list of Filter information to retrieve
from the AR System server.FilterStatusInfo class returns the type of filter message error
generated by a function call.FilterStatusInfo object
with the following parameters:
Form class and methods are used to represent the properties of form objects.FormAliasInfo class
represents information about form aliases.String object containing the string representation of a given assignment AssignInfo
object.
String object containing the string representation of a given qualifier object.
FormCriteria object.
FormDataDictionaryMenu class
returns the Data-Dictionary menu form object type.FormType class
retrieves a list of forms on the specified server.FuncCurrencyInfo class is used to represent information
about the functional currency.FunctionAssignInfo class specifies a function return value to
assign in a Set Fields action.ActiveLink from the server
ActiveLink object
ArithOpAssignInfo object.
PushFieldsInfo.getAssignment()
AR_MAX_COM_NAME (64 bytes).
BulkEntryReturn items,
Constants.AR_GROUP_CATEGORY_REGULAR) 1: Dynamic (Constants.AR_GROUP_CATEGORY_DYNAMIC)
2: Computed (Constants.AR_GROUP_CATEGORY_COMPUTED)
AR_MAX_COM_ID_SIZE (128 bytes).
ContainerCriteria on the specified server.
sqlCommand value
Each item in the list represents one matching row, each
of which contains a list of the selected column values.
DataType.
DDEAction object.
Value of a data field.
Escalation object specified by the given name.
Escalation object.
AssignFieldInfo object.
FieldId.
fieldIdListType that indicates whether to include all, none, selected,
or changed field whose values are included in the message.
Filter object specified by the given name.
Filter object specified by FilterCriteria and
String.
AssignFilterApiInfo object.
String.
QueryFormField fields that the dynamic query selects.
IQuerySource sources that the dynamic query selects from.
FunctionAssignInfo object.
Constants.AR_GROUP_TYPE_VIEW) 2: Change (Constants.AR_GROUP_TYPE_CHANGE)
IQuerySource source this source is joined with.
IQuerySource source this source is joined with.
Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
Constants.AR_LENGTH_UNIT_CHAR -- count in server characters
Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
Constants.AR_LENGTH_UNIT_CHAR -- count in server characters
ActiveLink objects that are associated with the
specified form
ActiveLink objects that are associated with the
specified form and modified after the given time.
ActiveLink objects specified by the criteria and
ActiveLinkCriteria.
ActiveLink objects
ActiveLink objects that the user has permission to access
ActiveLink objects that the user has permission to access
ActiveLink objects that the user has permission to access
and is modified after the give time
Container object that meet the given criteria.
Container objects that match with the given criteria
Container objects
Constants.AR_LIST_SCHEMA_DIALOG that are modified
after the specified time.
EntryListInfo objects that uniquely identify the entry objects that match the provided
criteria.
Entry objects that match the provided criteria.
Entry objects that match the provided criteria.
Entry object that matches the
provided criteria.
QuerySourceValues objects that match the provided criteria.
Escalation objects
Escalation objects that is associated with the given form
Escalation objects that is modified after the specified timestamp
Escalation objects that is associated with the given form and
modified after the specified timestamp.
Escalation objects that match the given criteria
Escalation objects that match the given criteria.
Field objects that match with the given criteria.
Filter objects that are associated with the given form
Filter objects that are associated with the given form and modified
after the provided timestamp
Filter objects that are associated with the given form
and modified after the provided timestamp
Filter objects
Filter objects
Filter objects
Filter objects that are modified after the given
timestamp
Form objects that match the specified criteria.
Image objects
Image objects that are associated with the given list of forms
Image objects that have been modified after the specified timestamp
Image objects of a specified type (ie, "jpg")
Image objects that match the given criteria
Image objects that are associated with the specified
form
Image objects that are associated with the specified form and
modified after the given time.
Image objects specified by the criteria and ImageCriteria.
Image objects
Image objects
Image objects
Image objects and is modified after the give time
Constants.AR_LIST_SCHEMA_JOIN that are modified after the
specified time.
LicenseInfo for the specified type.
Constants.AR_LIST_SCHEMA_REGULAR that are modified
after the specified time.
SupportFile objects that match the given criteria, and the current user has privilege to the
specified objects
Constants.AR_LIST_SCHEMA_VENDOR that are modified after
the specified time.
View objects that match with the given crteria.
MacroParmInfo objects.
MenuCriteria from AR System server.
ARServerUser.
AR_MAX_COM_ID_SIZE (128 bytes)
AR_MAX_COM_METHOD_NAME
(128 bytes).
NotifyAction.getFieldIdListType() values.
NOT operation
Entry objects that match the provided criteria.
COMValueInfo class.
partTag.
PropInfo object
PropInfo object
Qualifier in query.
Constants.ARREF_DATA_ARSREF) or
1 (Constants.ARREF_DATA_EXTREF).
RelationalOperationInfo object
SortInfo objects
IQuerySource source of the field Id.
IQuerySource field's source.
IQuerySource form or query containing the field to sort on
IQuerySource field's source.
AssignSQLInfo object.
Constants.AR_STORE_OPT_DEF -- Default - Use the Server's Default Behavior
Constants.AR_STORE_OPT_INROW -- In-Row
Constants.AR_STORE_OPT_OUTROW -- Out-of-Row
ARCON_GUIDE), application (ARCON_APP),
or a custom type you have defined.
String the user name of the diary item.
Value object.
ARServerUser.getServerVersion()
ViewCriteria from the AR System server.
GotoActionInfo class
is used to create and retrieve information
about the Goto workflow action.GotoActionInfoobject with the following parameters:
GotoGuideLabelInfo class
is used to create and retrieve information about
the Go To Guide Label workflow action.label parameter retrieves the label string.
GroupInfoclass defines the properties of a group on the AR System server.IARPersistentObject interface defines methods
for all AR System server objects.IARQualifierOperand class
is the superclass of the qualifier and relational operation classes.getListEntryObjects.IARLogInterface class
is the superclass that iterates through rows that are returned.Image class and methods are used to represent the properties of AR image objects.ImageCriteria class is used to specify the list of Image information to retrieve
from the AR System server.ImageData class is used to contain image object data.ARServerUser.importDefFromFile(java.lang.String) that takes care of file encoding.
ARServerUser.importDefFromFile(java.lang.String) that takes care of file encoding.
ARServerUser.importDefFromFile(java.lang.String) that takes care of file encoding.
ARServerUser.importDefFromFile(java.lang.String) that takes care of file encoding.
IndexInfo class defines which fields are indexed on the form.IndexInfo object.
IntegerFieldLimit class
defines the value limits for an integer(DataType.INTEGER) field.IntegerLimitInfo object
IQuerySource interface defines methods common to
objects that can be used as sources in the multi schema queries.TRUE if the license is a Demo license.
TRUE if logging is enabled.
true if the nType is the keyword TIME
usePromptingPane flag.
true if the nType is the keyword USER
getListEntryObjects
on each each Entry object that it retrieves.
JoinFieldMapping class contains the index of the base
form and the ID of the field to map to this field.JoinForm class represents a type of "compound form"
consisting of a join between two or more AR System forms.JoinForm object.
Keyword class
represents keywords you can use in qualification criteria.LicenseInfo class
represents detailed information about licenses.LicenseValidInfo class
represents validation information for a license.LicenseValidInfo object that accepts string.
ListMenu class returns a list of items used in list menus.LocalizedRequestInfo class
is used to describe the properties of a message.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 object contains the message text
corresponding to the Message Type and Name in the AR System Message Catalog form.LogAction class is used to
define the log to file workflow action within filters or escalations.LoggingInfo class
updates the indicated logging information for the
specified server.InternalID associated with the field to sort on.
MacroParmInfo class lets you enter a name/value pair
of the parameters used in the Run Macro active link action
(RunMacroAction).Menu class and methods are used to represent the properties of menu objects.MenuCriteria class is used to specify
the list of Menu information to retrieve
from the AR System server.MenuItem represents an
individual menu item of a list menu.MessageAction class is used to
define the message information that is generally used to
display an interactive error, warning, or note.MessageAction object
with the following parameters:
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.NULL value.
NULL string.
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.ObjectPrinter class contains the utility methods to print
out all possible AR objects and strings.ObjectPropertyMap class defines the object properties of ARSystem objectAutomationInfo class is used to define the information of an OLE Automation active link action.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 class defines the operands that can be used
in any relational operation that compares values, for example, in qualifications.OutputInteger class provides a class to represent an Integer object
whose value can be changed by the callee.AssignInfo object given a string representation.
QualifierInfo object given a string representation.
PermissionInfo class specifies the permissions
for an AR System object.arplugin.
ProcessResult performs the indicated command
on the specified server.PropInfo class uses a tag-value pair (AR_DROP_/AR_DVAL_)
to describe the properties of server objects in the AR System.PropInfo object which consists of a tag-value pair and is used to describe the
properties of server objects in the AR System.
ProxyManager is a factory class that provides clients with Proxy
instances.PushFieldsAction class is used to
change the values of fields in existing entries or
create a new entry during a transaction.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 class is used for dynamic qualification, which means the qualifier
string can be obtained from a field.QualifierInfo class is composed of a set of zero or more conditions
that limit
the set of entries retrieved.QualifierInfo objects
QueryBase class is used to
define the properties of a dynamic query.QueryFormField class contains the field information consumed by dynamic queries.IQuerySource field's source.
QueryInfo class represents how a query should be processed.QueryMenu class
returns information for query menus.QuerySourceForm class represents the form containing the entries to be retrieved
through a dynamic query.QuerySourceValues represents query source-related data in the form of field/value pairs.RealFieldLimit class
defines the value limits for a real number(DataType.REAL) field.RealLimitInfo object
RecursiveQuery class is used to
define the properties of a sub- or hierarchical query.Reference is used to set and return the objects referenced by a container.ReferenceType class specifies the type of
internal and external referencesRegularFieldMapping class
contains the field name in a vendor form derived from an external data source.RegularQuery class is used to
define the properties of a dynamic query.RelationalOperationInfo class represents any relational operation
between any ArithmeticOrRelationalOperand objects.RoleInfoclass
defines the properties of a role on the AR System server.ActiveLinkMacroInfo class lets you
specify a macro to run whenever the active link is
executed.RunProcessAction class is used to
define the run process workflow action within active links, filters or escalations.SelectionFieldLimit class
defines the value limits for a selection(DataType.ENUM) field.EnumLimitInfo object.
EnumLimitInfo object.
ServerInfo class
represents the server information operations and their values returned from a server.ServerInfoMap class defines the configuration information for the server.ServerInfoMenu class contains server information for the Menu.ServiceAction descriptionDiaryItem late on when this diaryListValue object is saved into
the server
ArithOpAssignInfo object.
PushFieldsInfo.setAssignment(com.bmc.arsys.api.AssignInfo)
AR_MAX_COM_NAME (64 bytes).
AR_MAX_COM_ID_SIZE (128 bytes).
DDEAction object.
Escalation object on ARSystem server
AssignFieldInfo object.
FieldId.
fieldIdListType that indicates whether to include all, none, selected,
or changed field whose values are included in the message.
SetFieldsAction class is used to
change the values of fields during a transaction.Filter object onto ARSystem server.
AssignFilterApiInfo object.
QueryFormField fields that the dynamic query selects.
IQuerySource sources that the dynamic query selects from.
FunctionAssignInfo object.
IQuerySource source to be joined with.
IQuerySource source to be joined with.
Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
Constants.AR_LENGTH_UNIT_CHAR -- count in server characters
ARServerUser.
AR_MAX_COM_ID_SIZE (128 bytes)
COMMethodInfo object.
AR_MAX_COM_METHOD_NAME (128
bytes).
ARNativeAuthenticationInfo.
NotifyAction.setFieldIdListType(int) values.
COMMethodParmInfo class.
COMValueInfo class.
SortInfo objects
IQuerySource field's source.
AssignSQLInfo object.
Value object.
long integer format).
long integer format).
SortInfo class specifies the sort order of fields
from an entry list.SortInfo object.
SortInfo object used by dynamic queries.
AR_SERVER_INFO_DEBUG_MODE).
SqlMenu class returns information for SQL menu.SQLResult class returns a list of
result values returned from an SQL query.StatisticsResultInfo class returns statistics (aggregates)
for the form entries,
and identifies which group-by values were used to compile the statistics.StatusHistoryItem class retrieves the
the user and time stamp components of the Status History core field.StatusHistoryValue class is used to represent the values of
status history fields.StatusHistoryValue class allows user to refer to
the status history associated with changes.StatusInfo class represents a message generated by
a function call.StructItemInfo class represents a particular object to export or import.SupportFile class and methods is used to represent the
properties of a support file.SupportFileCriteria class is used to specify
the list of SupportFile informationSupportFileKey class
provides a unique identifier for support file objects.SupportFileListCriteria class is used to define the search criteria for retrieving
the support files from the server.TableFieldLimit class
defines the value limits for a table(DataType.TABLE) field.TableLimitInfo object.
arservtcd thread.
AR_SERVER_INFO_DEBUG_MODE) (Windows NT only).
Time class represents the time elapsed since midnight.TimeOnlyFieldLimit class
defines the value limits for an integer(DataType.INTEGER) field.Timestamp class represents the time
at which an operation was performed.Timestamp with the specified number of seconds (not milli-seconds)
elapsed since standard base time("epoch time").
java.util.Date format.
name
parameter.
AR_SERVER_INFO_DEBUG_MODE).
UserInfo class contains information about users in AR System.UserLicenseInfo class
contains information about user's licenses in AR System.Util class combines all the functions not related
to specific server objects into a "catch-all" class.Value class represents the value information associated to a field.AR_DATA_TYPE_NULL value.
DataType.
AR_DATA_TYPE_KEYWORD value.
AR_DATA_TYPE_INTEGER value.
AR_DATA_TYPE_REAL value.
AR_DATA_TYPE_CHAR value.
AR_DATA_TYPE_DIARY value
AR_DATA_TYPE_ULONG value.
AR_DATA_TYPE_BYTES value.
AR_DATA_TYPE_TIME value.
AR_DATA_TYPE_TIME_OF_DAY value.
AR_DATA_TYPE_DECIMAL value.
AR_DATA_TYPE_CURRENCY value.
AR_DATA_TYPE_DATE value.
AR_DATA_TYPE_ATTACH value.
AR_DATA_TYPE_COORDS value
IN operator
ValueSetQuery class is used to
define the properties of a IN/NOT IN query used in qualifier.VendorFieldMapping class
contains the field name in a vendor form derived from an external data source.VendorForm class represents a type of "external" form
that is
created from a non-database source (for example, an XML file).Version interface contains the AR Java API version string.View represents the form view (VUI) with the indicated name on the specified server.ViewCriteria class is used to specify
the list of View information for any view object on
the AR System server.ViewDisplayPropertyMap class defines the display properties of ARSystem views.ViewFieldLimit class
defines the value limits for a character(DataType.CHAR) fieldViewLimits object
ViewFieldMapping class
contains the field name of the external table.ViewForm class represents a type of "external" form
that is
created from a non-AR System database source, for example, an MS Access database.ViewKey class provides
a unique identifier for VUI objects.WaitInfo class represents the Wait active link action
that causes the current guide to wait for user input.WfdBreakpoint class contains information about a workflow location
where the worker thread should stop.WfdDebugLocation class represents the current location of
a worker thread while it is executing workflow.WfdUserContext class contains information about the user associated
with the thread being debugged.WorkflowLockInfo class
represents detailed information about workflow lock.XMLEntryReturn class
defines the return values for XML entry related bulk calls that return an output document.XMLEntryReturn object
|
AR System Java API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||