|
7.0 Action Request System Java API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_DEBUG_MODE).
ARBulkException class defines the exceptions generated
by the bulk entry transaction API.CharMenuInfo object
CharMenuInfo object
ARAssignStruct
ARAssignStruct.
ARQualificationStruct.
ARQualificationStruct.
ARDiaryList for easier processing.
ARDiaryList for easier processing.
ARStatusHistoryList for easier processing.
ARStatusHistoryList.
ARAssignStruct to serialized qualification string
ARAssignStruct.
ARQualificationStruct to serialized qualification
string.
ARQualificationStruct.
ARDiaryList as input and encodes it into a diary string.
ARDiaryList as input and encodes it into a
diary string.
ARStatusHistoryList as input and encodes it into a
status history string.
ARStatusHistoryList as input and encodes it
into a status history string.
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.blob), stored
for the attachment field with the indicated ID on the specified server.
qualifier parameter.
ar directory file.
entryIdList parameter.
QualifierInfo object given a string representation.
String object containing the string representation of a
given qualifier object.
ARMAX_CON_DESCRIPTION_LEN (2000 bytes).
ARQualifierHelper class is the optimized way to get QualifierInfo.ARServerUser class
contains login information for accessing the AR System,
including user name, password, and server.control
parameter is registered in AR System.
ActiveLinkActionInfo class.
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 Schema 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.
AND operator.
NOT operator.
OR operator.
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_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
schema 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_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_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_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_TIMESTAMP is the current date/time.
Constants.AR_KEYWORD_TIME_ONLY is the current time (date defaults to today).
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_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_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
$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.
ARGetQualifierString
and ARGetQualifier
in Util class used to parse a qualification from an active link.
ARGetQualifierString
and ARGetQualifier
in Util class used to parse a qualification.
ARGetQualifierString
and ARGetQualifier
in Util class used to parse a qualification from an escalation.
ARGetQualifierString
and ARGetQualifier
in Util class used to parse a qualification from a filter.
ARGetQualifierString
and ARGetQualifier
in 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 equal to 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.
CompoundSchemaInfo.
CompoundSchemaInfo.
NULL schema.
CompoundSchemaInfo.
CompoundSchemaInfo.
CompoundSchemaInfo.
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
AccessNameID class is used to represent the
user name, password, and group name of an AR System user.ActiveLink class and methods are used to represent the properties of
active link objects.ActiveLinkActionInfo class and methods are used for
implementing active link actions.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 class are used to
instantiate a new active link object or to get an existing active link from the server.ActiveLinkKey class provides
a unique identifier for active link objects.ActiveLinkMacroInfo class lets you
specify a macro to run whenever the active link is
executed.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.ArchiveInfo class
and methods are used to represent the properties of ArchiveInfo objects.ArithOpAssignInfo class defines an arithmetic result
value to assign in a Set Fields action.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
Value object
StatusHistoryValue
QueryInfo object
AssignFieldInfo class identifies a schema 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.Attachment class is used to get/set the information
about attachment fields.AttachmentInfo class is used to get/set the information
about attachment fields.AttachmentLimitInfo 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.
AuditInfo class
and methods are used to represent the properties of AuditInfo objects.AutomationInfo class is used to define the information of an OLE Automation active link action.BulkEntryReturn class
defines the return values for bulk entry calls.BulkEntryReturn object
ByteListInfo class is used to represent image information.getDataField
or setDataField methods
of ColumnLimitInfo.
getDataField
or setDataField methods
of ColumnLimitInfo.
COMMethodInfo class defines an OLE Automation method.COMMethodParmInfo class specifies the parameters
used in COMValueInfo.COMValueInfo class is used to
define the method and parameter values in the
OLE Automation active link action.CallGuideInfo class is used to represent information
about the Call Guide active link action.CharLimitInfo class
defines the value limits for a character field (DataType.CHAR).CharLimitInfo object
CharMenuDDFieldInfo class
returns the Data-Dictionary menu field object type.CharMenuDDFormInfo class
returns the Data-Dictionary menu form object type.CharMenuDDInfo class
returns information for a Data-Dictionary menu.CharMenuFileInfo class
returns information for file menu based on formatted flat file.CharMenuInfo class returns the type of character menu.CharMenuItemInfo represents an
individual menu item of a list menu.CharMenuListInfo class returns a list of items used
in list menus.CharMenuQueryInfo class
returns information for query menus.CharMenuSQLInfo class
returns information for SQL menu.CharMenuSSInfo class
returns information for SS menu.CloseWindowInfo 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.
ColumnLimitInfo class
represents the value limits for a column(DataType.COLUMN) field.ColumnLimitInfo object.
CommitChangesInfo class is used to create and retrieve
information about the Commit Changes active link action.CompoundSchemaInfo class
is the superclass that represents the information for all composite schemas.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 to retrieve on a
findByKey or
findObjects call.ContainerCriteria object.
ContainerFactory class are used to
instantiate a new container object or to get an existing container from the server.ContainerKey class provides a unique
identifier for container objects.ContainerListCriteria class lets you get or set
a list of containers that match specified criteria.ContainerMultiCriteria class lets you get or set
a list of containers that match specified criteria.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).NONE and ALL.
SCHEMA.
ContainerType class represents the different types of containers
you can specify, for example, guides or applications or packing lists.CoordinateInfo class returns the location of a field,
that is, the field's X and Y coordinates.CriteriaFlags class is used to describe the properties needed
to be retrieved for many of the server objects.Criteria object.
Criteria object with the given properties.
CurrencyDetail class
represents Currency Code information,
that is, codes of different country's
currencies.CurrencyInfo class is used to define the Currency structure.CurrencyLimitInfo class
defines the value limits for a Currency (DataType.CURRENCY) fieldCurrencyLimitInfo object.
CurrencyPartInfo class represents the
result value from an arithmetic operation
between ArithmeticOrRelationalOperand objects.