|
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.ARServerUser.
CharMenuDDInfo
DDEInfo class specifies a DDE result value to assign in a Set Fields
action.name parameter depends on
AR_SERVER_INFO_DEBUG_MODE).
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.DayInfo class is used to specify
date and time information in defining escalation firing time.DecimalLimitInfo class
defines the value limits for a decimal(DataType.DECIMAL) fieldDecimalLimitInfo object.
DefaultProxyManager is a singleton factory class that provides clients with
Proxy instances.Diary class is used to set or retrieve the values of
diary fields.DiaryInfo class is used to retrieve
information about change diary fields.DiaryLimitInfo class
defines the value limits for a Diary(DataType.DIARY) fieldDiaryLimitInfo object.
DisplayInstanceInfo class
defines the display instance of a field for a particular schema view.DisplayInstanceInfo object
DisplayInstanceList class
defines the display properties of a field for all associated schema views.DisplayInstanceList object.
DisplayLimits class
defines the value limits for a character(DataType.CHAR) field.DisplayLimits object
StatusHistoryInfo objects.
Schema object
EntryID
AR_SERVER_INFO_DEBUG_MODE).
ExternalReferenceInfo)
Entry class is used to set and retrieve information
about entries in a schema.EntryCriteria class is used to specify
the list of Entry information to retrieve on a
findByKey
or findObjects call
from the AR System server.EntryListFieldInfo parameter
used to retrieve Entry information.
EntryFactory class are used to
instantiate a new entry object or to get the existing entry of a form.EntryID class is used to
uniquely identify an entry for a particular schema
from the AR System server.EntryItem class
represents the collection of entry items that comprise an entry.EntryKey class
uniquely identifies a field entry ID.NameID
and entryID EntryID object of class
NameID
and joinentryID JoinEntryID object of class
EntryListCriteria class is used to define the criteria
for selecting a list of entries from AR System.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.EntryPointMultiCriteria class specifies the entry point
properties to retrieve.EntryPointMultiListCriteria class retrieves the
entry points that match the specified criteria.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.EnumLimitInfo class
defines the value limits for a selection(DataType.ENUM) field.EnumLimitInfo object.
EnumLimitInfo object.
Escalation class
and methods are used to represent the properties of escalation objects.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 class are used to
instantiate a new escalation object or to get an existing escalation from the server.EscalationKey class
provides a unique identifier for escalation objects.EscalationTmInfo class
represents the time specification for evaluating the escalation condition.EscalationTmInfo object
using Constants.AR_ESCALATION_TYPE_INTERVAL to
define a time interval
EscalationTmInfo object
using Constants.AR_ESCALATION_TYPE_TIMEMARK to
define a particular day
ExitGuideInfo class
is used to create and retrieve information about the Exit Guide active link action.ExitGuideInfo object using the closeAll parameter.
ExtFieldCandidatesInfo class returns
information about all the columns/fields candidates
for an external compound schema.ExternalReferenceInfo class
represents non-AR System server objects.CurrencyInfo.
CharMenuFileInfo
AR_SERVER_INFO_DEBUG_MODE).
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).FieldCharacteristicsInfo class
is used to change display characteristics of fields.FieldCriteria class is used to specify the list of Field information to retrieve on a
findByKey or findObjects call.FieldCriteria object.
FieldFactory class
are used to instantiate a new field object
or to get an existing field from the server.FieldID class and methods contains static members of type FieldID
for each field ID of the AR System core fields.FieldKey class
provides a unique identifier for field objects.FieldLimitInfo class is used to
define value limits for data fields of any type.FieldListCriteria class is used to
get or set a list of fields that match specified criteria.FieldListCriteria object to be passed as parameter to find
or findObjects call on a FieldFactory object.
FieldListCriteria object to be passed as parameter to find
or findObjects call on a FieldFactory object.
FieldMappingInfo class is used to map
join fields to compound schemas (CompoundSchemaInfo).FieldType class
returns a list of fields for a particular form on the specified
server.Filter class
and methods are used to represent the properties of filter objects.FilterActionInfo class
and methods are used for implementing filter actions.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 class are used to
instantiate a new filter object or to get an existing filter from the server.FilterKey class
provides a unique identifier for filter objects.FilterStatusInfo class returns the type of filter message error
generated by a function call.FilterStatusInfo object
with the following parameters:
FullTextInfo class is used to set or retrieve
the requested Full Text Search (FTS) information
for 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.WorkflowObjectListCriteria.
ContainerListCriteria.
EntryKey objects that uniquely
identify the result entry objects
by executing the query as specified by EntryListCriteria.
WorkflowObjectListCriteria.
FieldListCriteria.
WorkflowObjectListCriteria.
MenuListCriteria.
SchemaListCriteria.
SupportFileKey objects that contain the details
of the support files specified by SupportFileListCriteria.
SchemaListCriteria.
ActiveLink object
specified by ActiveLinkCriteria and ActiveLinkKey.
Container object specified by
ContainerKey and ContainerCriteria.
EntryKey, ARServerUser,
and EntryCriteria.
Escalation object
specified by EscalationCriteria and EscalationKey.
Field object specified by
FieldKey.
Filter object
specified by FilterCriteria and FilterKey.
MenuCriteria and MenuKey.
Schema object
specified by SchemaCriteria and SchemaKey.
SupportFile object
specified by SupportFileCriteria and SupportFileKey.
View object specified
by ViewCriteria and ViewKey.
ActiveLink objects
specified by WorkflowObjectListCriteria and ActiveLinkCriteria.
Container objects specified by
ContainerListCriteria and ContainerCriteria.
Container objects specified by
ContainerListCriteria and ContainerCriteria.
Entry objects according to the criteria specified using
EntryListCriteria and EntryCriteria.
Escalation objects
specified by WorkflowObjectListCriteria and EscalationCriteria.
FieldCriteria with a list of Field objects specified by
FieldListCriteria.
Filter objects
specified by WorkflowObjectListCriteria and FilterCriteria.
MenuListCriteria and MenuCriteria.
Schema objects
specified by SchemaListCriteria and SchemaCriteria.
SupportFile objects
that matches the search criteria given in the SupportFileListCriteria.
View objects specified
by ViewListCriteria and ViewCriteria.
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.ArithOpAssignInfo object.
AR_MAX_COM_NAME (64 bytes).
BulkEntryReturn items,
AR_MAX_COM_ID_SIZE (128 bytes).
sqlCommand value
(in the Util.ARGetListSQL class.
FieldID of the data field.
DataType.
DDEInfo object.
Value of a data field.
EntryCriteria
EntryID
EntryItem collection
EntryListFieldInfo that should be
returned by the query
FieldFactory factory.
AssignFieldInfo object.
FieldID.
InternalID of the field to sort on.
fieldIdListType that indicates whether to include all, none, selected,
or changed field whose values are included in the message.
AssignFilterApiInfo object.
FunctionAssignInfo object.
Constants.AR_GROUP_CATEGORY_REGULAR)
1: Dynamic (Constants.AR_GROUP_CATEGORY_DYNAMIC)
2: Computed (Constants.AR_GROUP_CATEGORY_COMPUTED)
InternalID of the group.
Constants.AR_GROUP_TYPE_VIEW)
2: Change (Constants.AR_GROUP_TYPE_CHANGE)
TRUE if the license is a Demo license.
EntryKey which identifies the schema, entry, and entry ID.
AR_LOC_FILENAME)
or as a buffer (AR_LOC_BUFFER).
AR_LOC_FILENAME)
or as a buffer (AR_LOC_BUFFER).
MacroParmInfo objects.
CharMenuInfo.LIST
CharMenuInfo.FILE
CharMenuInfo.QUERY
CharMenuInfo.SQL
CharMenuInfo.SS
CharMenuInfo.DD
CharMenuInfo.NONE
ARServerUser.
AR_MAX_COM_ID_SIZE (128 bytes)
AR_MAX_COM_METHOD_NAME (128 bytes).
NOT operation
NotifyActionInfo.getFieldIdListType() values.
FieldID of the parent field the column belongs to.
COMValueInfo class.
partTag.
PropInfo object
PropInfo object
QualifierInfo information
Qualifier in query.
Constants.ARREF_DATA_ARSREF) or
1 (Constants.ARREF_DATA_EXTREF).
RelationalOperationInfo object
NameID
SchemaKey.
SortInfo) that identifies the entry sort order.
AssignSQLInfo object.
ARCON_GUIDE),
application (ARCON_APP), or a custom type you have defined.
usePromptingPane flag.
AccessNameID object.
AccessNameID of user.
InternalID of the associated view.
Value object.
HostID class
represents information about host IDs.HostID object
with the following parameters:
HostID object
with the following parameters:
HostID object
with the following parameters:
IARIdentifier class
is the superclass of the different ID classes.IARObjectFactory class is the superclass of the different
<Object>Factory classes.IARPersistentObject interface defines methods
for all AR System server objects.IARQualifierOperand class
is the superclass of the qualifier and relational operation classes.IARRowIterator class
is the superclass that iterates through rows that are returned.IARLogInterface class
is the superclass that iterates through rows that are returned.IndexInfo class defines which fields are indexed on the schema.IndexInfo object.
IntegerLimitInfo class
defines the value limits for an integer(DataType.INTEGER) field.IntegerLimitInfo object
InternalID class
represents an internal ID of an AR System object.TRUE if logging is enabled.
true if the nType is the keyword TIME
true if the nType is the keyword USER
JoinEntryID class represents the composite Entry ID created
when two or more schemas are joined together.JoinMappingInfo class contains the index of the base
schema and the ID of the field to map to this field.JoinSchema class represents a type of "compound schema"
consisting of a join between two or more AR System schemas.JoinSchema object.
Keyword class
represents keywords you can use in qualification criteria.CharMenuListInfo.
LicenseDateInfo class
represents information used for license dates.LicenseInfo class
represents detailed information about licenses.LicenseKeyID class
represents information about license keys.LicenseKeyID object
with the following parameters:
LicenseKeyID object
with the following parameters:
LicenseKeyID object
with the following parameters:
LicenseNameID class
represents information about license names.LicenseNameID object
with the following parameters:
LicenseNameID object
with the following parameters:
LicenseNameID object
with the following parameters:
LicenseValidInfo class
represents validation information for a license.LicenseValidInfo object that accepts string.
LocaleID class
represents locale information,
which includes information about language and country.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.Util.ARGetLocalizedValue utility
returns the
LocalizedValueInfo object.LoggingInfo class
updates the indicated logging information for the
specified server.ActiveLinkCriteria
from the AR System server.
ContainerCriteria on the specified server.
EscalationCriteria
from the AR System server.
FieldCriteria from the AR System server.
FilterCriteria
from the AR System server.
MenuCriteria from the AR System server.
SchemaCriteria
from the AR System server.
SupportFileCriteria from the AR System server.
ViewCriteria from the AR System server.
ARServerUser.
MacroParmInfo class lets you enter a name/value pair
of the parameters used in the Run Macro active link action
(ActiveLinkMacroInfo).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 on a
findByKey or
findObjects call
from the AR System server.MenuFactory class are used to
instantiate a new menu object or to get an existing menu from the server.MenuKey class
provides a unique identifier for menu objects.MenuListCriteria class lets you specify parameter values used
to retrieve menu object from AR System server.MenuListCriteria object to be passed as parameter to find
or findObjects call on a MenuFactory object.
MenuListCriteria object to be passed as parameter to find
or findObjects call on a MenuFactory object.
MessageInfo class is used to
define the message information that is generally used to
display an interactive error, warning, or note.InternalID associated with the field to sort on.
ARServerUser.
NULL value.
NULL string.
NameID class represents the names of objects.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 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.Field object
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 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.arplugin.
PermissionInfo class specifies the permissions
for an AR System object.ProxyManager is a singleton factory class that provides clients with
Proxy instances.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.
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 is a factory class that provides clients with Proxy
instances.SetFieldsActionInfo 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.CharMenuQueryInfo
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
QueryInfo class represents how a query should be processed.RealLimitInfo class
defines the value limits for a real number(DataType.REAL) field.RealLimitInfo object
ReferenceBase class is the base class for
ReferenceBase.SYSTEM_REFERENCE and ReferenceBase.EXTERNAL_REFERENCE.ReferenceInfo class represents the names of
internal AR System objects, for example, filters, active links,
and so on.ReferenceType class specifies the type of
internal and external references that can be
used by the ReferenceBase.getReferenceType() method.RelationalOperationInfo class represents any relational operation
between any ArithmeticOrRelationalOperand objects.RoleInfoclass
defines the properties of a role on the AR System server.ARServerUser
and deletes any container references to this schema.
CharMenuSQLInfo
SQLInfo class represents the filter/active link
action used to submit any legal SQL command to the database.SQLResult class returns a list of
result values returned from an SQL query.AR_SERVER_INFO_DEBUG_MODE).
CharMenuSSInfo
InternalID)
Schema class
and methods are used to represent the properties of schema objects.SchemaAliasInfo class
represents information about schema aliases.SchemaAliasesCriteria class
is used to specify the type of schema aliases to retrieve.SchemaAliasesCriteria object
with the following parameters:
SchemaCriteria class is used to specify the list of Schema information to retrieve on a
findByKey or findObjects call.SchemaCriteria object.
SchemaFactory class are used to
instantiate a new schema object or to get an existing schema from the server.SchemaKey class
provides a unique identifier for schema objects.SchemaListCriteria class is used to specify the type of schemas to retrieve on a
find call.SchemaListCriteria object.
SchemaType class
retrieves a list of schemas on the specified server.ServerInfo class
represents the server information operations and their values returned from a server.ServerNameID class is used to represent the ID of the
AR System server name.SetFieldsActionInfo class is used to
change the values of fields during a transaction.SortInfo class specifies the sort order of fields
from an entry list.SortInfo object.
StatisticsResultInfo class returns statistics (aggregates)
for the form entries,
and identifies which group-by values were used to compile the statistics.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 class is used to represent the values of
status history fields.StatusHistoryInfo class retrieves the
the user and time stamp components of the Status History core field.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 information
to retrieve on a findByKey
or findObjects call.SupportFileFactory class are used to
instantiate a new support file object
or to get an existing support file from the server.SupportFileKey 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.ArithOpAssignInfo object.
AR_MAX_COM_NAME (64 bytes).
AR_MAX_COM_ID_SIZE (128 bytes).
ARServerUser information with this AR System server object.
ARServerUser information with this
AR System server object.
ARServerUser information with this AR System server object.
ARServerUser information with this view object.
FieldID of the data field.
DDEInfo object.
remove() on the field object to indicate the action to take if the
specified field contains data (applicable for base schemas only) or is associated with a join schema.
EntryID part of EntryKey data member
EntryItem collection
EntryListFieldInfo that should be
returned by the query
AssignFieldInfo object.
FieldID.
fieldIdListType that indicates whether to include all, none, selected,
or changed field whose values are included in the message.
FieldFactory.find or
FieldFactory.findObjects.
AssignFilterApiInfo object.
FunctionAssignInfo object.
EntryKey.
AR_LOC_FILENAME)
or as a buffer (AR_LOC_BUFFER).
ARServerUser.
AR_MAX_COM_ID_SIZE (128 bytes)
COMMethodInfo object.
AR_MAX_COM_METHOD_NAME (128 bytes).
NotifyActionInfo.setFieldIdListType(long) values.
COMMethodParmInfo class.
FieldID of the parent field the column belongs to.
COMValueInfo class.
QualifierInfo information
EntryKey data member
SortInfo) that identifies the entry sort order.
AssignSQLInfo object.
ARCON_GUIDE),
application (ARCON_APP), or a custom type you have defined.
Constants.AR_MAX_ACCESS_NAME_SIZE.
Value object.
byte[]) in which the content is returned.
byte[]) in which the content is returned.
Constants.AR_MAX_ENTRYID_SIZE.
Constants.AR_MAX_SERVER_SIZE.
long integer format).
long integer format).
arservtcd thread.
AR_SERVER_INFO_DEBUG_MODE) (Windows NT only).
TableLimitInfo class
defines the value limits for a table(DataType.TABLE) field.TableLimitInfo object.
Time class represents the time elapsed since midnight.Timestamp class represents the time
at which an operation was performed.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.IN operator
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_ENUM value
or AR_DATA_TYPE_BITMASK
or AR_DATA_TYPE_ULONG.
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
AR_DPROP_DISPLAY_PARENT as tag.
VendorMappingInfo class
contains the field name in a vendor schema derived from an external data source.VendorSchemaInfo class represents a type of "external" schema
that is
created from a non-database source (for example, an XML file).VerifyUserCriteria class
is used in verifying user privileges.View class 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.ViewFactory class are used to
instantiate a new view object or to get an existing view from the server.ViewKey class provides
a unique identifier for VUI objects.ViewLimits class
defines the value limits for a character(DataType.CHAR) fieldViewLimits object
ViewListCriteria class
is used to define the criteria for selecting the list of views (VUIs) of a particular form
on the specified server.ViewMappingInfo class
contains the field name of the external table.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 class represents the Wait active link action
that causes the current guide to wait for user input.WorkflowConnectInfo class
represents the list of schemas the workflow object (for example, an active link)
is connected to.WorkflowLockInfo class
represents detailed information about workflow lock.WorkflowObjectListCriteria class
returns a list of workflow objects connected with a specific schema.XMLEntryReturn class
defines the return values for XML entry related bulk calls that return an output document.XMLEntryReturn object
|
7.0 Action Request System Java API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||