com.bmc.arsys.api.ARServerUser
|
AR System Java API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class ARServerUser
Interface to a particular AR System server for all API calls. Contains login (authentication) information including server information, user name, and password required to establish a session with the server plus user session information that controls the behavior of the API session.
| Nested Class Summary | |
|---|---|
static class |
ARServerUser.ExecuteProcessActionType
Valid values for the action type to execute in ExecuteProcessForActiveLink |
| Field Summary | |
|---|---|
static int |
AR_RPC_ADMIN_QUEUE
The admin queue RPC program number |
static int |
AR_RPC_DEFAULT_QUEUE
The default queue RPC program number |
static int |
AR_RPC_PRIVATE_QUEUE_MAX
|
static int |
AR_RPC_PRIVATE_QUEUE_MIN
the range for the private queue |
static int |
AR_RPC_SPEC_QUEUE_MAX
|
static int |
AR_RPC_SPEC_QUEUE_MIN
the range for the special queue. |
| Constructor Summary | |
|---|---|
ARServerUser()
Constructs an ARServerUser with no members initialized. |
|
ARServerUser(ARNativeAuthenticationInfo userInfo,
String locale,
String server)
Constructs an ARServerUser with user name, authentication string, locale, and server initialized. |
|
ARServerUser(String user,
String password,
String locale,
String server)
Constructs an ARServerUser with user name, password, locale, and server initialized. |
|
ARServerUser(String user,
String password,
String locale,
String server,
int serverPort)
Constructs an ARServerUser with user name, password, locale, server, and server port initialized. |
|
ARServerUser(String user,
String password,
String authentication,
String locale,
String server)
Constructs an ARServerUser with user name, password, locale, and server initialized. |
|
ARServerUser(String user,
String password,
String authentication,
String locale,
String server,
int serverPort)
Constructs an ARServerUser with user name, password, authentication string, locale, server, and server port initialized. |
|
ARServerUser(String user,
String password,
String authentication,
String locale,
String timeZone,
String customDateFormat,
String customTimeFormat,
String server)
Constructs an ARServerUser with user name, password, authentication string, locale, time zone, date and time formats, and server initialized. |
|
| Method Summary | |
|---|---|
void |
beginBulkEntryTransaction()
Marks the beginning of a bulk entry transaction. |
String |
beginClientManagedTransaction()
Begin a client managed transaction. |
void |
clear()
Deprecated. as of AR System 7.1, replaced by logout() |
List<MenuItem> |
convertStringToListMenu(String menuString)
Converts a string to a list of MenuItem objects |
void |
createActiveLink(ActiveLink object)
Creates this ActiveLink object on AR System server. |
String |
createAlertEvent(String user,
String alertText,
int priority,
String sourceTag,
String server,
String formName,
String objectId)
Enters an alert event into the system. |
void |
createContainer(Container object)
Creates a new container with the given container instance on the specified server. |
void |
createContainer(Container object,
boolean removeInvalidReference)
Creates a new container with the given container instance on the specified server. |
String |
createEntry(String formName,
Entry entry)
Creates a new entry in the indicated form on the specified server. |
void |
createEscalation(Escalation object)
Creates this Escalation object into AR System server. |
void |
createField(Field object,
boolean isReservedRangeIdOK)
Creates a new form field with the indicated name on the specified server. |
void |
createFilter(Filter object)
Creates this Filter object on AR System server. |
void |
createForm(Form obj)
Creates this form on the server specified in the ARServerUser. |
void |
createImage(Image obj)
Creates this image on the server specified in the ARServerUser. |
void |
createMenu(Menu object)
Creates this Menu object on AR System server. |
void |
createMultipleFields(List<Field> fields)
Create new fields for a specified form in the ARSystem. |
int |
createSupportFile(SupportFile supportFile)
Creates a new support file with the indicated information on the specified server. |
void |
createView(View object)
Creates the given View object in AR System server. |
AlertMessageInfo |
decodeAlertMessage(AlertMessageCriteria criteria,
Object message,
int length)
Decode supplied alert message and return component parts. |
AssignInfo |
decodeARAssignStruct(String assignString)
Deprecated. as of AR System 7.1, replaced by decodeAssignment(java.lang.String) |
QualifierInfo |
decodeARQualifierStruct(String queryString)
Deprecated. as of AR System 7.1, replaced by decodeQualification(java.lang.String) |
AssignInfo |
decodeAssignment(String assignString)
Decodes an encoded assignment String into internal data structure representation used by Java API |
DiaryListValue |
decodeDiary(String encoded)
Takes an encoded diary string as input and decodes it into an DiaryListValue for easier processing. |
AssignInfo |
decodeDSOPoolAssignment(String encodedStr)
Decodes an encoded DSO Pool Mapping Assignment into internal structure representation used by AR Java API |
QualifierInfo |
decodeQualification(String encodedQualText)
Decodes an encoded qualification String into internal data strucuture representation used by Java API. |
void |
deleteActiveLink(String name,
int deleteOption)
Deletes the specified activelink from AR System server. |
void |
deleteAlert(String entryId)
Deletes an alert event from the system. |
void |
deleteContainer(String name,
int deleteOption)
Deletes the container with the indicated name from the specified server and deletes any references to the container from other containers. |
void |
deleteEntry(String formName,
String entryId,
int deleteOption)
Removes the form entry with the indicated ID from the specified server. |
void |
deleteEscalation(String name,
int deleteOption)
Deletes this escalation from AR System server. |
void |
deleteField(String form,
int fieldId,
int deleteOption)
Deletes the form field with the indicated ID from the specified server. |
void |
deleteFields(String form,
int[] fieldIds,
int deleteOption)
Deletes the fields with the specified IDs from the given form |
void |
deleteFilter(String name,
int deleteOption)
Deletes this filter from AR System server. |
void |
deleteForm(String formName,
int deleteOption)
Deletes obj form from the server specified in the ARServerUser and deletes any container references to obj form. |
void |
deleteImage(String imageName,
boolean updateRef)
Deletes obj image from the server specified in the ARServerUser and optionally deletes any references to the image obj form, depending on the value of updateRef. |
void |
deleteMenu(String name,
int deleteOption)
Removes this specified Memu object from AR System server. |
void |
deleteSupportFile(SupportFileKey supportFileKey)
Deletes the given support file from the server. |
void |
deleteView(String formName,
int viewId)
Removes this object on the AR System server. |
void |
deregisterForAlerts(int clientPort)
Deregister a client with the server so they no longer receive alert indicators. |
String |
encodeARAssignStruct(AssignInfo assign)
Deprecated. as of AR System 7.1, replaced by encodeAssignment(com.bmc.arsys.api.AssignInfo) |
String |
encodeARQualifierStruct(QualifierInfo qual)
Deprecated. as of AR System 7.1, replaced by encodeQualification(com.bmc.arsys.api.QualifierInfo) |
String |
encodeAssignment(AssignInfo assignment)
Encodes an internal data structure representation of qualification into String format |
static String |
encodeDiary(DiaryListValue diaryList)
Takes an DiaryListValue as input and encodes it into a diary string. |
String |
encodeDSOPoolAssignment(AssignInfo asgnInfo)
Encodes an internal data structure representation of Assignments into String format |
String |
encodeQualification(QualifierInfo qualifier)
Encodes an internal data structure representation of qualification into String format |
List<BulkEntryReturn> |
endBulkEntryTransaction(int actionType)
Marks the ending of a bulk entry transaction. |
void |
endClientManagedTransaction(int transactionOption)
End a client managed transaction. |
boolean |
equals(Object obj)
Use this method for checking equality between the current object and the provided one. |
ProcessResult |
executeProcess(String command)
Execute the indicated command on the server, wait it to finish, and bring back the result |
ProcessResult |
executeProcess(String command,
boolean waitFlag)
Execute the indicated command on the server, and bring back the result if the waitFlgs instructs the method to wait for the process to finish. |
ProcessResult |
executeProcessForActiveLink(String actlinkName,
int actionIndex,
int actionType,
int fieldId,
Timestamp timestamp,
List<Value> keywordList,
List<Value> parameterList)
Reserved for AR System internal only. |
ProcessResult |
executeProcessForActiveLink(String actlinkName,
int actionIndex,
int actionType,
int fieldId,
Timestamp timestamp,
List<Value> keywordList,
List<Value> parameterList,
boolean waitFlag)
Reserved for AR System internal only. |
Entry |
executeService(String formName,
String entryId,
Entry entry,
int[] entryListFields)
Sends an entry to the server, executes filter workflow on the server using that input entry and then returns the output entry as the outcome of the workflow processing. |
ProcessResult |
executeSpecialCommand(String cmd,
Object... parameters)
Executes one of the special AR System run process commands |
List<MenuItem> |
expandMenu(Menu menu)
Expands the query and file references for the specified menu definition and returns a character menu with list-type items only. |
List<MenuItem> |
expandMenu(Menu menu,
Entry keywordList,
Entry parameterList)
|
List<MenuItem> |
expandMenu(String menuName)
Expands the query and file references for the specified menu definition and returns a character menu with list-type items only. |
List<MenuItem> |
expandMenu(String menuName,
Entry keywordList,
Entry parameterList)
|
String |
exportDef(List<StructItemInfo> items)
Deprecated. as of AR System 7.5, replaced by exportDefToFile(java.util.List that takes care of file encoding. |
String |
exportDef(List<StructItemInfo> items,
boolean asXml)
Deprecated. as of AR System 7.5, replaced by exportDefToFile(java.util.List that takes care of file encoding. |
String |
exportDef(List<StructItemInfo> items,
boolean asXml,
String displayTag,
int vuiType,
WorkflowLockInfo lockInfo)
Deprecated. as of AR System 7.5, replaced by exportDefToFile(java.util.List that takes care of file encoding. |
String |
exportDef(List<StructItemInfo> items,
String displayTag,
int vuiType,
WorkflowLockInfo lockInfo)
Deprecated. as of AR System 7.5, replaced by exportDefToFile(java.util.List that takes care of file encoding. |
String |
exportDef(List<StructItemInfo> items,
WorkflowLockInfo lockInfo)
Deprecated. as of AR System 7.5, replaced by exportDefToFile(java.util.List that takes care of file encoding. |
String |
exportDef(List items,
boolean asXml,
WorkflowLockInfo lockInfo)
Deprecated. as of AR System 7.5, replaced by exportDefToFile(java.util.List that takes care of file encoding. |
void |
exportDefToFile(List<StructItemInfo> items,
boolean asXml,
String filePath,
boolean overwrite)
Exports the specified structure from the server to a file in ARSystem def or xml format. |
void |
exportDefToFile(List<StructItemInfo> items,
boolean asXml,
WorkflowLockInfo lockInfo,
String filePath,
boolean overwrite)
Exports the specified structure from the server to a file in ARSystem def or xml format. |
void |
exportDefToFile(List items,
boolean asXml,
String displayTag,
int vuiType,
WorkflowLockInfo lockInfo,
String filePath,
boolean overwrite)
Exports the specified structure from the server to a file in ARSystem def or xml format. |
String |
formatAssignment(AssignInfo assign,
List<Field> fieldList,
Field assignField,
boolean topLevel)
Constructs a String object containing the string representation of a given assignment AssignInfo
object. |
String |
formatAssignment(String form,
int fieldId,
String form2,
Object assignment)
Formats an internal representation of a assignment expression to a readable String |
String |
formatQualification(QualifierInfo qual,
List<Field> fieldList1,
List<Field> fieldList2,
int queryContext,
boolean isEscalation)
Constructs a String object containing the string representation of a given qualifier object. |
String |
formatQualification(String form,
Object qualification)
Formats an internal representation of a qualifier to a readable String |
String |
formatSetIfQualification(String form1,
String form2,
Object qualification)
Formats internal structure of given qualification (used as Set-If condition of a SetFields workflow action)into a String representation |
String |
generateGUID()
Generates a GUID by runninng a special AR System run process commands |
String |
generateGUID(String prefix)
Generates a GUID by runninng a special AR System run process commands |
ActiveLink |
getActiveLink(String name)
return detailed information about the activelink ActiveLink from the server |
ActiveLink |
getActiveLink(String name,
ActiveLinkCriteria criteria)
Returns detailed information about the ActiveLink object |
int |
getAlertCount(QualifierInfo qual)
Gets number of alert events that meet the specified qualification. |
List<String> |
getAllLocalHostIDs()
Get all local host ID's. |
String |
getApplicationState(String applicationName)
Retrieves the current state of a given application. |
String |
getAuthentication()
Returns the authentication string. |
List<Integer> |
getCacheEvent(int[] eventIdList,
int returnOption,
OutputInteger cacheCount)
Returns cache event IDs that have occurred. |
long |
getCacheId()
Returns the cache ID. |
int |
getChunkResponseSize()
Get the chunk response size |
int |
getClientType()
Get the client type |
Container |
getContainer(String name)
retrieve the requested container object from AR System server. |
Container |
getContainer(String name,
ContainerCriteria criteria)
Returns the contents of the container with the indicated name with information specified by ContainerCriteria on the specified server. |
BigDecimal |
getCurrencyRatio(String currencyRatioSet,
String fromCurrencyCode,
String toCurrencyCode)
Search through a supplied currency ratios string to find an entry that matches the requested currency codes. |
String |
getCustomDateFormat()
Returns the custom date format. |
String |
getCustomTimeFormat()
Returns the custom time format. |
String |
getDefaultOutputDirectory()
|
Entry |
getEntry(String formName,
String entryId,
int[] entryListFields)
Loads the entry object from AR System as specified by the entryentryListFields data member. |
byte[] |
getEntryBlob(String formName,
String entryID,
int fieldID)
Returns the attachment that is stored in the indicated IDs on the specified server. |
void |
getEntryBlob(String formName,
String entryID,
int fieldID,
String filePath)
Returns the attachment that is stored in the indicated IDs on the specified server. |
List<StatisticsResultInfo> |
getEntryStatistics(String formKey,
QualifierInfo qual,
ArithmeticOrRelationalOperand target,
int statistic,
int[] groupByList)
Computes the indicated statistic for the form entries that match the conditions specified by the qualifier parameter. |
Escalation |
getEscalation(String key)
Returns detailed information about the Escalation object specified by the given name. |
Escalation |
getEscalation(String key,
EscalationCriteria criteria)
Returns detailed information about the Escalation object. |
ExtendedClassRegistry |
getExtendedClassRegistry()
|
Field |
getField(String form,
int fieldId)
Retrieve the requested form field object from the server. |
Field |
getField(String form,
int fieldId,
FieldCriteria criteria)
Retrieve and populate the form field object with the requested information from AR System server. |
Filter |
getFilter(String key)
Returns detailed information about the Filter object specified by the given name. |
Filter |
getFilter(String key,
FilterCriteria criteria)
Returns detailed information about the Filter object specified by FilterCriteria and
String. |
Form |
getForm(String formName)
return the requested Form object from AR System server. |
Form |
getForm(String formName,
FormCriteria criteria)
return the requested Form object from AR System server. |
Image |
getImage(String imageName)
return the requested Image object from AR System server. |
Image |
getImage(String imageName,
ImageCriteria criteria)
return the requested Image object from AR System server. |
long |
getImpersonatedCacheId()
get the cache id of the impersonated user. |
String |
getImpersonatedUser()
get the name of the impersonated user |
int |
getLastCount()
|
String |
getLastID()
|
List<StatusInfo> |
getLastStatus()
Returns the last operation status list. |
List<String> |
getListActiveLink()
Returns a list of all (accessible) active link names in the server |
List<String> |
getListActiveLink(long changedSince)
Returns names of all (accessible) active links that are modified after the given change time |
List<String> |
getListActiveLink(String formName)
Returns names of all (accessible) active links that are associated with the given form |
List<String> |
getListActiveLink(String formName,
long changedSince)
Returns names of all (accessible) active links that are associated with the given form and amodified after the provided time |
List<String> |
getListActiveLink(String formName,
long changedSince,
ObjectPropertyMap propsToSearch)
Returns the name of all (accessible) active links that match with the given criteria. |
List<ActiveLink> |
getListActiveLinkObjects()
Returns detailed information for all (accessible) ActiveLink objects |
List<ActiveLink> |
getListActiveLinkObjects(List<String> names)
Returns detailed information for the requested ActiveLink objects that the user has permission to access |
List<ActiveLink> |
getListActiveLinkObjects(List<String> names,
ActiveLinkCriteria criteria)
Returns detailed information for the requested ActiveLink objects that the user has permission to access |
List<ActiveLink> |
getListActiveLinkObjects(List<String> names,
long changedSince,
ActiveLinkCriteria criteria)
Returns detailed information for the requested ActiveLink objects that the user has permission to access
and is modified after the give time |
List<ActiveLink> |
getListActiveLinkObjects(String formName)
Returns detailed information for all (accessible) ActiveLink objects that are associated with the
specified form |
List<ActiveLink> |
getListActiveLinkObjects(String formName,
long changedSince)
Returns detailed information for all (accessible) ActiveLink objects that are associated with the
specified form and modified after the given time. |
List<ActiveLink> |
getListActiveLinkObjects(String formName,
long changedSince,
ActiveLinkCriteria criteria)
Returns detailed information for all (accessible) ActiveLink objects specified by the criteria and
ActiveLinkCriteria. |
List<String> |
getListAlertUser()
Gets list of registered Alert users. |
List<String> |
getListApplicationState()
Retrieves the list of possible application state (maintenance, test or production) that an application on this AR System server. |
List<String> |
getListContainer(long changedSince,
int[] containerTypes,
boolean hiddenFlag,
List<ContainerOwner> ownerList,
ObjectPropertyMap propsToSearch)
Returns the names of all (accessible) Container object that meet the given criteria. |
List<Container> |
getListContainerObjects(List<String> containers)
Returns detailed information for the requested Container objects |
List<Container> |
getListContainerObjects(long changedSince,
int[] containerTypes,
boolean hiddenFlag,
List<ContainerOwner> ownerList,
ObjectPropertyMap propsToSearch,
ContainerCriteria criteria)
Returns detailed information of all (accessible) Container objects that match with the given criteria |
List<String> |
getListDisplayOnlyForm(long changedSince)
return the name of all (accessible) Display-Only forms Constants.AR_LIST_SCHEMA_DIALOG that are modified
after the specified time. |
List<EntryListInfo> |
getListEntry(String formName,
QualifierInfo qualification,
int firstRetrieve,
int maxRetrieve,
List<SortInfo> sortList,
List<EntryListFieldInfo> entryListFields,
boolean useLocale,
OutputInteger nMatches)
Returns list of EntryListInfo objects that uniquely identify the entry objects that match the provided
criteria. |
List<QuerySourceValues> |
getListEntryObjects(RegularQuery query,
int firstRetrieve,
int maxRetrieve,
boolean useLocale,
OutputInteger nMatches)
Returns a list of QuerySourceValues objects that match the provided criteria. |
List<Entry> |
getListEntryObjects(String formName,
List<String> entryIds,
int[] fieldIds)
Returns a list of Entry objects that match the provided criteria. |
List<Entry> |
getListEntryObjects(String formName,
QualifierInfo qualification,
int firstRetrieve,
int maxRetrieve,
List<SortInfo> sortList,
int[] fieldIds,
boolean useLocale,
OutputInteger nMatches)
Returns a list of Entry objects that match the provided criteria. |
void |
getListEntryObjects(String formName,
QualifierInfo qualification,
int firstRetrieve,
int maxRetrieve,
List<SortInfo> sortList,
int[] fieldIds,
boolean useLocale,
OutputInteger nMatches,
IARRowIterator iterator)
Applies the iteratorCallback method of the iterator parameter to each Entry object that matches the
provided criteria. |
List<EntryPointInfo> |
getListEntryPoint(long changedSince,
List<String> applicationKeys,
int[] refTypes,
int viewType,
String displayTag,
boolean hiddenFlag)
Retrieves all application entry points that match with the given criteria. |
List<String> |
getListEscalation()
return the names of all (accessible) Escalation objects |
List<String> |
getListEscalation(long changedSince)
return the names of all (accessible) Escalation objects that is modified after the specified timestamp |
List<String> |
getListEscalation(String formName)
return the names of all (accessible) Escalation objects that is associated with the given form |
List<String> |
getListEscalation(String formName,
long changedSince)
return the names of all (accessible) Escalation objects that is associated with the given form and
modified after the specified timestamp. |
List<String> |
getListEscalation(String formName,
long changedSince,
ObjectPropertyMap propsToSearch)
return the names of all (accessible) Escalation objects that match the given criteria |
List<Escalation> |
getListEscalationObjects(String formName,
long changedSince,
EscalationCriteria criteria)
Returns detailed information for all (accessible) Escalation objects that match the given criteria. |
List<ExtFormCandidatesInfo> |
getListExtFormCandidates(int formType)
Returns a list of all external data source table (forms candidates). |
List<Integer> |
getListField(String formName,
int fieldTypeMask,
long changedSince)
Returns the ids of all (accessible) fields that matches with the given criteria. |
List<Field> |
getListFieldObjects(String formName)
Returns detailed information for all (accessible) fields on the given form. |
List<Field> |
getListFieldObjects(String formName,
int fieldTypeMask)
Returns detailed information of all (accessible) fields that match with the given criteria. |
List<Field> |
getListFieldObjects(String formName,
int[] fieldIds)
Returns detailed information of all attributes for a list of Field objects specified by the field ids |
List<Field> |
getListFieldObjects(String formName,
int[] fieldIds,
FieldCriteria criteria)
Returns detailed information of the given attributes for a list of Field objects specified by the field ids. |
List<Field> |
getListFieldObjects(String formName,
int fieldTypeMask,
long changedSince)
Returns detailed information of all (accessible) fields that match with the given criteria. |
List<Field> |
getListFieldObjects(String formName,
int fieldTypeMask,
long changedSince,
FieldCriteria criteria)
Returns detailed information for all (accessible) Field objects that match with the given criteria. |
List<String> |
getListFilter()
Returns names of all (accessible) filters in ARSystem server. |
List<String> |
getListFilter(long changedSince)
Returns names of all (accessible) filters that is modified after the provided time . |
List<String> |
getListFilter(String formName)
Returns names of all (accessible) filters that is associated with the given form. |
List<String> |
getListFilter(String formName,
long changedSince)
Returns names of all (accessible) filters that is modified after the provided time, and associated with the given form. |
List<String> |
getListFilter(String formName,
long changedSince,
ObjectPropertyMap propsToSearch)
Returns all the name of all (accessible) filters that match with the given criteria. |
List<Filter> |
getListFilterObjects()
return the detail of all (accessible) Filter objects |
List<Filter> |
getListFilterObjects(List<String> names)
return the detail of all (accessible) requested Filter objects |
List<Filter> |
getListFilterObjects(List<String> names,
FilterCriteria criteria)
return the detail of all (accessible) requested Filter objects |
List<Filter> |
getListFilterObjects(List<String> names,
long changedSince,
FilterCriteria criteria)
return the detail of all (accessible) requested Filter objects that are modified after the given
timestamp |
List<Filter> |
getListFilterObjects(String formName)
return the detail of all (accessible) Filter objects that are associated with the given form |
List<Filter> |
getListFilterObjects(String formName,
long changedSince)
return the detail of all (accessible) Filter objects that are associated with the given form and modified
after the provided timestamp |
List<Filter> |
getListFilterObjects(String formName,
long changedSince,
FilterCriteria criteria)
return the detail information of all (accessible) Filter objects that are associated with the given form
and modified after the provided timestamp |
List<String> |
getListForm()
return the name of all (accessible) forms on the server. |
List<String> |
getListForm(long changedSince)
return the name of all (accessible)forms that are modified after the specified time. |
List<String> |
getListForm(long changedSince,
int formType)
return the name of all (accessible) forms that match the sepcified criteria |
List<String> |
getListForm(long changedSince,
int formType,
String formName)
return the name of all (accessible) forms that match the sepcified criteria |
List<String> |
getListForm(long changedSince,
int formType,
String formName,
int[] fieldIds)
return the name of all (accessible) forms that match the sepcified criteria |
List<String> |
getListForm(long changedSince,
int formType,
String formName,
int[] fieldIds,
ObjectPropertyMap propsToSearch)
return the name of all (accessible) forms that match the specified criteria |
List<FormAliasInfo> |
getListFormAliases(long changedSince,
int formType,
String formName,
int[] fieldIds,
String vuiLabel)
Returns a list of form names and corresponding aliases that match the given criteria. |
List<Form> |
getListFormObjects(long changedSince,
int formType,
String formName,
int[] fieldIds,
FormCriteria criteria)
Returns detailed information of all (accessible) Form objects that match the specified criteria. |
List<GroupInfo> |
getListGroup(String user,
String password)
Returns a list of access control groups on the specified server. |
List<String> |
getListImage()
return the names of all Image objects |
List<String> |
getListImage(List<String> formList)
return the names of all Image objects that are associated with the given list of forms |
List<String> |
getListImage(List<String> formList,
long changedSince,
String imageType)
return the names of all Image objects that match the given criteria |
List<String> |
getListImage(long changedSince)
return the names of all Image objects that have been modified after the specified timestamp |
List<String> |
getListImage(String imageType)
return the names of all Image objects of a specified type (ie, "jpg") |
List<Image> |
getListImageObjects()
Returns detailed information for all Image objects |
List<Image> |
getListImageObjects(List<String> names)
Returns detailed information for the requested Image objects |
List<Image> |
getListImageObjects(List<String> names,
ImageCriteria criteria)
Returns detailed information for the requested Image objects |
List<Image> |
getListImageObjects(List<String> names,
long changedSince,
ImageCriteria criteria)
Returns detailed information for the requested Image objects and is modified after the give time |
List<Image> |
getListImageObjects(String formName)
Returns detailed information for all (accessible) Image objects that are associated with the specified
form |
List<Image> |
getListImageObjects(String formName,
long changedSince)
Returns detailed information for all Image objects that are associated with the specified form and
modified after the given time. |
List<Image> |
getListImageObjects(String formName,
long changedSince,
ImageCriteria criteria)
Returns detailed information for all Image objects specified by the criteria and ImageCriteria. |
List<String> |
getListJoinForm(long changedSince)
return the name of all (accessible) Join forms Constants.AR_LIST_SCHEMA_JOIN that are modified after the
specified time. |
List<LicenseInfo> |
getListLicense(String licenseType)
Returns list of license info LicenseInfo for the specified type. |
List<String> |
getListMenu(long changedSince,
List<String> forms,
List<String> activeLinks)
Returns names of all (accessible) menu that match with the given criteria. |
List<String> |
getListMenu(long changedSince,
List<String> forms,
List<String> activeLinks,
ObjectPropertyMap propsToSearch)
Returns names of all (accessible) menu that match with the given criteria |
List<Menu> |
getListMenuObjects(long changedSince,
List<String> forms,
List<String> activeLinks,
MenuCriteria criteria)
Returns detailed information of all (accessible) Menu objects that match with the given criteria. |
List<String> |
getListRegularForm(long changedSince)
return the name of all (accessible) Regular forms Constants.AR_LIST_SCHEMA_REGULAR that are modified
after the specified time. |
List<RoleInfo> |
getListRole(String application,
String user,
String password)
Returns a list of roles for a user for a deployable application on the specified server. |
SQLResult |
getListSQL(String sqlCommand,
int maxRetrieve,
boolean retrieveTotalMatches)
Returns a list of rows from the underlying SQL database on the specified server. |
SQLResult |
getListSQLForActiveLink(String actlinkName,
int actionIndex,
int actionType,
Timestamp timestamp,
List<Value> keywordList,
List<Value> parameterList,
int maxRetrieve,
boolean retrieveTotalMatches)
Reserved for AR System internal only. |
List<Integer> |
getListSupportFile(int fileType,
String associatedObjName,
int supportingId,
long changedSince)
Returns the ids of all support files that match the given criteria, and the current user has privilege to the specified objects |
List<SupportFile> |
getListSupportFileObjects(int fileType,
String associatedObjName,
int supportingId,
long changedSince)
Returns all SupportFile objects that match the given criteria, and the current user has privilege to the
specified objects |
List<UserInfo> |
getListUser()
Returns a list of users currently accessing the specified AR System server. |
List<UserInfo> |
getListUser(int type)
Returns a list of users on the specified AR System server. |
List<UserInfo> |
getListUser(int type,
long changedSince)
Returns a list of users on the specified AR System server. |
List<String> |
getListVendorForm(long changedSince)
return the name of all (accessible) Vendor forms Constants.AR_LIST_SCHEMA_VENDOR that are modified after
the specified time. |
List<ExtFieldCandidatesInfo> |
getListVendorFormFieldCandidates(String vendorName,
String tableName)
Returns information about all the columns/fields candidates for Vendor form. |
List<Integer> |
getListView(String formName,
long changedSince)
Returns the names of all views that reside on the provided form, and modified after the given timestamp. |
List<String> |
getListViewForm(long changedSince)
return the name of all (accessible) View forms (@link Constants#AR_LIST_SCHEMA_VIEW} that are modified after the specified time. |
List<ExtFieldCandidatesInfo> |
getListViewFormFieldCandidates(String tableName)
Returns information about all the columns/fields candidates for View form. |
List<View> |
getListViewObjects(String formName,
long changedSince,
ViewCriteria criteria)
Returns the detailed information of all (accessible) View objects that match with the given crteria. |
String |
getLocale()
Returns the locale. |
String |
getLocalHostID()
Get License host ID. |
LocalizedValueInfo |
getLocalizedValue(LocalizedValueCriteria criteria,
LocalizedRequestInfo request)
Gets a localized text string from the message catalog form. |
LoggingInfo |
getLogging()
Returns the client-side logging information. |
Menu |
getMenu(String name,
MenuCriteria criteria)
return the requested menu object with information specified by MenuCriteria from AR System server. |
List<String> |
getMultipleCurrencyRatioSets(List<Timestamp> ratioTimestamps)
Retrieves a list of formatted currency ratio sets valid for the time specified in the argument. |
List<LocalizedValueInfo> |
getMultipleLocalizedValues(LocalizedValueCriteria criteria,
List<LocalizedRequestInfo> requests)
Gets multiple localized texts from the catalog file. |
HashMap<Integer,ObjectOperationTimes> |
getObjectChangeTimes()
Gets a HashMap of arserver objects and the timestamps for the last create, modify, or delete operation on each object. |
Entry |
getOneEntryObject(String formName,
QualifierInfo qualification,
List<SortInfo> sortList,
int[] fieldIds,
boolean useLocale,
OutputInteger nMatches)
Returns a list of Entry objects that match the provided criteria. |
Timestamp |
getOperationTime()
Returns the operation time stamp. |
boolean |
getOverridePrevIP()
Get the override previous IP flag |
String |
getPassword()
Returns the password for the user to use to connect to the server. |
int |
getPort()
Returns the port used to connect to the server. |
com.bmc.arsys.api.Proxy |
getProxy()
For ARSystem internal use only. |
String |
getReservedParam1()
CAUTION: For AR System internal Only |
String |
getServer()
Returns the host name used to connect to the server. |
String |
getServerCharSet()
Returns the servers char set as a string. |
ServerInfoMap |
getServerInfo(int[] requestList)
Returns the requested configuration information for the specified server. |
int |
getServerRpcQueueNumber()
|
ServerInfoMap |
getServerStatistics(int[] requestList)
Returns the requested statistics for the specified server. |
String |
getServerVersion()
Return the version of the server |
int |
getServerVersionMajor()
return the major version number of this server |
int |
getServerVersionMinor()
return the minor version number of this server |
String |
getServerVersionPatch()
return the patch/build number of this server |
SupportFile |
getSupportFile(String associatedObjName,
int fileId)
Retrieves the property of the support file that is associated with the given object and with a specific file id |
SupportFile |
getSupportFile(String associatedObjName,
int fileId,
int fileType,
int supportingId,
String filePath)
Retrieves the content of the support file indicated by the key information into a local file identified by the filePath. |
SupportFile |
getSupportFile(String associatedObjName,
int fileId,
String filePath)
Retrieves the content of the support file indicated by the key information into a local file identified by the filePath. |
String |
getTextForErrorMessage(int msgId)
Returns the message text for the specified error from the local catalog (in the local language). |
int |
getTimeoutLong()
Get the long timeout |
int |
getTimeoutNormal()
Get the normal timeout |
int |
getTimeoutXLong()
Get the extra long timeout |
String |
getTimeZone()
Returns the time zone. |
String |
getTransactionHandle()
For ARSystem internal use only. |
String |
getUser()
Returns the user login name to use to connect to the server. |
String |
getUserSessionGuid()
Returns the user session authentication GUID. |
String |
getVersionString()
Deprecated. as of AR System 7.1, replaced by getServerVersion() |
View |
getView(String formName,
int viewId)
Retrieves the form view object from the AR System server. |
View |
getView(String formName,
int viewId,
ViewCriteria criteria)
Populates this object with information specified by ViewCriteria from the AR System server. |
int |
getVUIType()
Get the VUI type |
int |
hashCode()
Returns the hash code value for this instance of the current class. |
void |
impersonateUser(String impersonatedUser)
Enables plug-ins, midtier or other program to run as an administrator in this session, but to perform operations as a specific user (with that user's permission and licensing in effect). |
void |
importDefFromBuffer(String importBuffer)
Deprecated. as of AR System 7.5, replaced by importDefFromFile(java.lang.String) that takes care of file encoding. |
void |
importDefFromBuffer(String importBuffer,
int optionMask)
Deprecated. as of AR System 7.5, replaced by importDefFromFile(java.lang.String) that takes care of file encoding. |
void |
importDefFromBuffer(String importBuffer,
int optionMask,
List<StructItemInfo> items)
Deprecated. as of AR System 7.5, replaced by importDefFromFile(java.lang.String) that takes care of file encoding. |
void |
importDefFromBuffer(String importBuffer,
List<StructItemInfo> items)
Deprecated. as of AR System 7.5, replaced by importDefFromFile(java.lang.String) that takes care of file encoding. |
void |
importDefFromFile(String filePath)
Import all definitions into the server from given file. |
void |
importDefFromFile(String filePath,
int optionMask)
Import all definitions, using the given import option, into the server from given file This operation can be performed by users with AR System administrator privileges only. |
void |
importDefFromFile(String filePath,
int optionMask,
List<StructItemInfo> items)
Import the provided object definitions into the server using the specified import option. |
void |
importDefFromFile(String filePath,
List<StructItemInfo> items)
Import given object definitions into the server from given file. |
boolean |
isAdministrator()
Checks if the user is an member of the Administrator group. |
boolean |
isMemberOfCustomizeGroup()
Checks if the user is a member of the Customize group. |
boolean |
isMemberOfGroup(int groupId)
Return is the current user member of the specified group |
boolean |
isProxyInContext()
For ARSystem internal use only. |
boolean |
isSubAdministrator()
Checks if the user is a member of the Subadministrator group. |
void |
login()
Logs in to the server and verifies the user. |
void |
logout()
Releases the user from the server, and clears the user from ARServerUser. |
String |
mergeEntry(String formName,
Entry entry,
int nMergeType)
Merges an existing entry into the indicated form on the specified server. |
AssignInfo |
parseAssignment(String toForm,
int fieldId,
String fromForm,
String expression)
Parses a given readable assignment into internal structure |
AssignInfo |
parseAssignment(String assignString,
String queryString,
Field assignField,
List<Field> fieldList1,
List<Field> fieldList2,
String form,
String server,
int currentScreen,
boolean idOk,
boolean fromSQL,
boolean fromFilterAPI,
int queryContext)
Constructs a AssignInfo object given a string representation. |
Object |
parseFilterQualification(String form,
String qualification)
Parse a qualification that can be used with in a Filter Run If qualification |
QualifierInfo |
parseQualification(String queryString,
List<Field> fieldList1,
List<Field> fieldList2,
int queryContext)
Constructs a QualifierInfo object given a string representation. |
QualifierInfo |
parseQualification(String form,
String qualification)
Parses a given readable qualification string into internal structure. |
QualifierInfo |
parseQualification(String form,
String vui,
String qualification)
Parses a given qualification into internal structure. |
QualifierInfo |
parseSetIfQualification(String form1,
String form2,
String qualification)
Parses a given qualification (used as Set-If condition of a SetFields workflow action) into internal structure |
void |
registerForAlerts(int clientPort,
int registrationFlags)
Register a client with the server to receive alert signals. |
void |
removeClientManagedTransaction()
Removes a client managed transaction handle from the ARServerUser This call is reserved for future use. |
void |
runEscalation(String escalation)
Run Escalation |
void |
setActiveLink(ActiveLink object)
Updates this active link on the database. |
void |
setApplicationState(String applicationName,
String newState)
Sets the state of a given application |
void |
setAuthentication(String authentication)
Sets the authentication string. |
void |
setChunkResponseSize(int chunkResponseSize)
Set the chunk response size |
void |
setClientManagedTransaction(String transactionHandle)
Sets a client managed transaction. |
void |
setClientType(int clientType)
Set the client type |
void |
setContainer(Container object)
Updates the definition of the given container on the server. |
void |
setContainer(Container object,
boolean removeInvalidReference)
Updates the definition of the given container on the server. |
void |
setCustomDateFormat(String customDateFormat)
Sets the custom date format. |
void |
setCustomTimeFormat(String customTimeFormat)
Sets the custom time format. |
void |
setDefaultOutputDirectory(String defaultOutputDirectory)
|
void |
setEntry(String formName,
String entryId,
Entry entry,
Timestamp getTime,
int nOption)
Updates an the given entry in ARSystem server. |
void |
setEscalation(Escalation object)
Updates this Escalation object on ARSystem server |
void |
setExtendedClassRegistry(ExtendedClassRegistry ecr)
Sets the class extension registry object. |
void |
setField(Field object)
Saves the changes made to the form field object into AR System server. |
void |
setFilter(Filter object)
Updates this Filter object onto ARSystem server. |
void |
setForm(Form obj)
Saves the changes made to the form object into AR System server |
void |
setImage(Image obj)
Saves the changes made to the image object into AR System server |
void |
setLocale(String locale)
Sets the locale. |
void |
setLogging(LoggingInfo info)
Activates and deactivates client-side logging of server activities. |
void |
setLogInterface(IARServerLogInterface logInterface)
Sets the log interface used by client-side logging. |
void |
setMenu(Menu object)
Saves the changes made to the menu field object into AR System server |
void |
setMultipleFields(List<Field> fields)
Saves the changes made to the form fields into ARSystem server. |
void |
setNativeAuthenticationInfo(ARNativeAuthenticationInfo userInfo)
Sets the user name, authentication string, and user session authentication GUID from an instance of ARNativeAuthenticationInfo. |
void |
setOverridePrevIP(boolean overridePrevIP)
Set the override previous IP flag |
void |
setPassword(String password)
Sets the password for the user to use to connect to the server. |
void |
setPort(int serverPort)
Sets the port used to connect to the server. |
void |
setProxy(com.bmc.arsys.api.Proxy prxy)
For ARSystem internal use only. |
void |
setReservedParam1(String pParam)
CAUTION: For AR System internal Only |
void |
setServer(String server)
Sets the host name used to connect to the server. |
void |
setServerInfo(ServerInfoMap serverInfoMap)
Updates the indicated configuration information for the specified server. |
void |
setSupportFile(SupportFile supportFile)
Updates this support file onto ARSystem server |
void |
setTimeoutLong(int timeoutLong)
Set the long timeout |
void |
setTimeoutNormal(int timeoutNormal)
Set the normal timeout |
void |
setTimeoutXLong(int timeoutXLong)
Set the extra long timeout |
void |
setTimeZone(String timeZone)
Sets the time zone. |
void |
setUser(String user)
Sets the user login name to use to connect to the server. |
void |
setView(View object)
Updates this view on the database |
void |
setVUIType(int vuiType)
Set the VUI type |
void |
signalServer(Map<SignalType,String> signals)
send a signal to the server to perform the indicated op, i.e. |
List<String> |
startRecording(int recordingMode,
String fileNamePrefix)
Starts API recording. |
void |
stopRecording()
Stops Api Recording. |
String |
toString()
Returns a string description of the object. |
void |
useAdminRpcQueue()
Connect to the server using the admin queue. |
void |
useDefaultRpcQueue()
Connect to the server using the default queue, which is either List or Fast queue |
void |
usePrivateRpcQueue(int rpcProgramNum)
Connect to the server using a private queue |
LicenseValidInfo |
validateLicense(String licenseType)
Validates license info. |
List<LicenseValidInfo> |
validateMultipleLicense(List<String> licenseTypes)
Validates multiple license info. |
void |
verifyUser()
Returns user privilege flags. |
void |
wfdClearAllBreakpoints()
Clear All Breakpoints |
void |
wfdClearBreakpoint(int bpId)
Clear Breakpoint |
int[] |
wfdExecute(int mode)
Tell the debug worker thread to begin execution |
WfdDebugLocation |
wfdGetDebugLocation(int depth)
returns the current location of the debug thread |
int |
wfdGetDebugMode()
Get debug mode, indicating which stopping points are enforced |
List<Entry> |
wfdGetFieldValues(int depth)
Get field values |
QualifierInfo |
wfdGetFilterQual()
Get Filter qualifier |
Value |
wfdGetKeywordValue(int kwId)
Get Keyword Value |
WfdUserContext |
wfdGetUserContext(int mask)
Get User context |
List<WfdBreakpoint> |
wfdListBreakpoints()
List Breakpoints |
void |
wfdSetBreakpoint(int errorCode,
WfdBreakpoint bp)
Set Breakpoint |
void |
wfdSetDebugMode(int mode)
Set debug mode, indicating which stopping points to enforce |
void |
wfdSetFieldValues(List<Entry> fieldValues)
Set field values |
void |
wfdSetQualifierResult(boolean result)
Set qualifier result |
void |
wfdTerminateAPI(int errorCode)
Terminate API |
String |
xmlCreateEntry(String inputMapping,
String inputDoc,
String outputMapping,
String optionDoc)
AR System internal use only. |
String |
xmlExecuteService(String queryMapping,
String queryDoc,
String inputMapping,
String inputDoc,
String outputMapping,
String optionDoc)
AR System internal use only. |
String |
xmlGetEntry(String queryMapping,
String queryDoc,
String outputMapping,
String optionDoc)
AR System internal use only. |
String |
xmlSetEntry(String queryMapping,
String queryDoc,
String inputMapping,
String inputDoc,
String outputMapping,
String optionDoc)
AR System internal use only. |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int AR_RPC_ADMIN_QUEUE
public static final int AR_RPC_DEFAULT_QUEUE
public static final int AR_RPC_SPEC_QUEUE_MIN
public static final int AR_RPC_SPEC_QUEUE_MAX
public static final int AR_RPC_PRIVATE_QUEUE_MIN
public static final int AR_RPC_PRIVATE_QUEUE_MAX
| Constructor Detail |
|---|
public ARServerUser()
public ARServerUser(String user,
String password,
String locale,
String server)
public ARServerUser(String user,
String password,
String authentication,
String locale,
String server)
public ARServerUser(String user,
String password,
String authentication,
String locale,
String server,
int serverPort)
public ARServerUser(String user,
String password,
String locale,
String server,
int serverPort)
public ARServerUser(String user,
String password,
String authentication,
String locale,
String timeZone,
String customDateFormat,
String customTimeFormat,
String server)
timeZone - customDateFormat - customTimeFormat -
public ARServerUser(ARNativeAuthenticationInfo userInfo,
String locale,
String server)
userInfo parameter. Does not specify password or server port.
userInfo - User authentication information for programs that implement the ARNativeAuthenticationInfo
interface| Method Detail |
|---|
public void login()
throws ARException
ARException - if invalid loginpublic void logout()
@Deprecated public void clear()
logout()
public long getCacheId()
public Timestamp getOperationTime()
public String getUser()
public void setUser(String user)
user - String user login name. The privileges associated with this user determine whether the API function
call can be performed.public String getPassword()
public void setPassword(String password)
password - String password in clear text. The API encrypts the password before sending it to the server.public String getAuthentication()
public void setAuthentication(String authentication)
authentication - String authentication string, for example, the network domainpublic String getUserSessionGuid()
ARNativeAuthenticationInfo supplies
the user session authentication GUID which is set into this ARServerUser. API programs cannot use the user
session authentication GUID in this release.
public void setNativeAuthenticationInfo(ARNativeAuthenticationInfo userInfo)
ARNativeAuthenticationInfo. Sets the password to the empty string.
userInfo - ARNativeAuthenticationInfo that can return the required valuespublic String getLocale()
language[_territory[.codeset]][@modifier]public void setLocale(String locale)
locale - String locale in the form language[_territory[.codeset]][@modifier]public String getTimeZone()
public void setTimeZone(String timeZone)
timeZone - String time zonepublic String getCustomDateFormat()
public void setCustomDateFormat(String customDateFormat)
public String getCustomTimeFormat()
public void setCustomTimeFormat(String customTimeFormat)
public int getPort()
public void setPort(int serverPort)
serverPort - server port numberpublic String getServer()
public void setServer(String server)
login() before
you can successfully call any method that accesses the server.
server - String server host namepublic List<StatusInfo> getLastStatus()
StatusInfo status objects
public boolean isAdministrator()
throws ARException
ARException
public boolean isSubAdministrator()
throws ARException
ARException
public boolean isMemberOfCustomizeGroup()
throws ARException
ARExceptionpublic LoggingInfo getLogging()
LoggingInfo client-side logging informationsetLogging(com.bmc.arsys.api.LoggingInfo)
public void setLogging(LoggingInfo info)
throws ARException
info - LoggingInfo client-side logging information
ARExceptionpublic void setLogInterface(IARServerLogInterface logInterface)
logInterface - IARServerLogInterface log interfacepublic com.bmc.arsys.api.Proxy getProxy()
public void setProxy(com.bmc.arsys.api.Proxy prxy)
public boolean isProxyInContext()
@Deprecated public String getVersionString()
getServerVersion()
public List<String> startRecording(int recordingMode,
String fileNamePrefix)
stopRecording() a client program can start, stop, and changes
API recording during its execution.
recordingMode - bit mask that enables and controls logging
fileNamePrefix - String prefix for the log files. If no fileNamePrefix parameter is specified for this method, the
value is the concatination of the user name, the server name, and the port number.
public void stopRecording()
startRecording(int, java.lang.String)
public void verifyUser()
throws ARException
ARException - if user is not verified
public void createForm(Form obj)
throws ARException
ARException - if form is not created
public void deleteForm(String formName,
int deleteOption)
throws ARException
formName - the name of the form requesteddeleteOption - the option to take when the user choose to delete the form.deleteOption is a bitmask value indicating
the action to take if the specified form contains entries(applicable for base forms only) or is a
member of a join form. The values are:
Constants.AR_DEFAULT_DELETE_OPTION: server object default delete option For locked
objects, fails the delete attempt.For Forms, same as AR_SCHEMA_CLEAN_DELETE
Constants.AR_SCHEMA_CLEAN_DELETE: Delete form only when there is no dependancy and
there is no data in the schema,set the bit to zero(0). This is ignored in case of a join
form.Applicable for regular forms only.
Constants.AR_SCHEMA_DATA_DELETE: Delete form even if there is a dependency.All the
specified forms will be deleted.only applicable for regular forms.
Constants.AR_SCHEMA_FORCE_DELETE: delete form even there is dependency.all the
invalid schemas will be deleted.this option overrides deleteOption 1.
Constants.AR_LOCK_BLOCK_DELETE: delete the given object and all objects that are
locked with same key.only applicable for locked objects
Constants.AR_SCHEMA_SHADOW_DELETE: delete archive/audit form even if it is enabled
or part of a lock object. Applicable for both regular forms and join forms.
ARException - if form is not deleted
public Form getForm(String formName)
throws ARException
formName - the name of the form requested
ARException - if object is not loaded
public Form getForm(String formName,
FormCriteria criteria)
throws ARException
formName - the name of the form requestedcriteria - the attribute returned for the Form object
ARException - if object is not loaded
public void setForm(Form obj)
throws ARException
ARException - if form is not updated
public List<String> getListForm()
throws ARException
ARException
public List<String> getListDisplayOnlyForm(long changedSince)
throws ARException
Constants.AR_LIST_SCHEMA_DIALOG that are modified
after the specified time. This will retrieve both visible and hidden forms.
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.
ARException
public List<String> getListViewForm(long changedSince)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.
ARException
public List<String> getListVendorForm(long changedSince)
throws ARException
Constants.AR_LIST_SCHEMA_VENDOR that are modified after
the specified time. This will retrieve both visible and hidden forms.
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.
ARException
public List<String> getListJoinForm(long changedSince)
throws ARException
Constants.AR_LIST_SCHEMA_JOIN that are modified after the
specified time. This will retrieve both visible and hidden forms.
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.
ARException
public List<String> getListRegularForm(long changedSince)
throws ARException
Constants.AR_LIST_SCHEMA_REGULAR that are modified
after the specified time. This will retrieve both visible and hidden forms.
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.
ARException
public List<String> getListForm(long changedSince)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.
ARException
public List<String> getListForm(long changedSince,
int formType)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.formType - the type of forms to retrieve. The type can be:
Constants.AR_LIST_SCHEMA_ALL all form types.
Constants.AR_LIST_SCHEMA_REGULAR all regular forms
Constants.AR_LIST_SCHEMA_JOIN all join forms
Constants.AR_LIST_SCHEMA_VIEW all view forms
Constants.AR_LIST_SCHEMA_VENDOR all vendor forms
Constants.AR_LIST_SCHEMA_DIALOG all display-only forms
Constants.AR_LIST_SCHEMA_ALL_WITH_DATA all forms with data field on it
Constants.AR_HIDDEN_INCREMENT) to the
form type. For example, specify Constants.AR_LIST_SCHEMA_REGULAR |
Constants.AR_HIDDEN_INCREMENT for this parameter.
ARException
public List<String> getListForm(long changedSince,
int formType,
String formName)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.formType - the type of forms to retrieve. The type can be:
Constants.AR_LIST_SCHEMA_ALL all form types.
Constants.AR_LIST_SCHEMA_REGULAR all regular forms
Constants.AR_LIST_SCHEMA_JOIN all join forms
Constants.AR_LIST_SCHEMA_UPLINK all join forms that depend on the form specified by the
formName parameter
Constants.AR_LIST_SCHEMA_DOWNLINK all join forms that the form specified by the
formName parameter depends on
Constants.AR_LIST_SCHEMA_VIEW all view forms
Constants.AR_LIST_SCHEMA_VENDOR all vendor forms
Constants.AR_LIST_SCHEMA_DIALOG all display-only forms
Constants.AR_LIST_SCHEMA_ALL_WITH_DATA all forms with data field on it
Constants.AR_HIDDEN_INCREMENT) to the
form type. For example, specify Constants.AR_LIST_SCHEMA_REGULAR |
Constants.AR_HIDDEN_INCREMENT for this parameter.formName - If the formType is AR_LIST_SCHEMA_UPLINK, this parameter specifies the form upon which the retrieved
form depends on. If the schemaType is AR_LIST_SCHEMA_DOWNLINK, this parameter specifies the form that
depends on the retrieved form. This parameter is ignored if you don't specify AR_LIST_SCHEMA_UPLINK or
AR_LIST_SCHEMA_DOWNLINK as the formType
ARException
public List<String> getListForm(long changedSince,
int formType,
String formName,
int[] fieldIds)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.formType - the type of forms to retrieve. The type can be:
Constants.AR_LIST_SCHEMA_ALL all form types.
Constants.AR_LIST_SCHEMA_REGULAR all regular forms
Constants.AR_LIST_SCHEMA_JOIN all join forms
Constants.AR_LIST_SCHEMA_UPLINK all join forms that depend on the form specified by the
formName parameter
Constants.AR_LIST_SCHEMA_DOWNLINK all join forms that the form specified by the
formName parameter depends on
Constants.AR_LIST_SCHEMA_VIEW all view forms
Constants.AR_LIST_SCHEMA_VENDOR all vendor forms
Constants.AR_LIST_SCHEMA_DIALOG all display-only forms
Constants.AR_LIST_SCHEMA_ALL_WITH_DATA all forms with data field on it
Constants.AR_HIDDEN_INCREMENT) to the
form type. For example, specify Constants.AR_LIST_SCHEMA_REGULAR |
Constants.AR_HIDDEN_INCREMENT for this parameter.formName - If the formType is AR_LIST_SCHEMA_UPLINK, this parameter specifies the form upon which the retrieved
form depends on. If the schemaType is AR_LIST_SCHEMA_DOWNLINK, this parameter specifies the form that
depends on the retrieved form. This parameter is ignored if you don't specify AR_LIST_SCHEMA_UPLINK or
AR_LIST_SCHEMA_DOWNLINK as the formTypefieldIds - this is a list of form fields, and the API call only return the the forms that containing all these
fields in this list
ARException
public List<String> getListForm(long changedSince,
int formType,
String formName,
int[] fieldIds,
ObjectPropertyMap propsToSearch)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.formType - the type of forms to retrieve. The type can be:
Constants.AR_LIST_SCHEMA_ALL all form types.
Constants.AR_LIST_SCHEMA_REGULAR all regular forms
Constants.AR_LIST_SCHEMA_JOIN all join forms
Constants.AR_LIST_SCHEMA_UPLINK all join forms that depend on the form specified by the
formName parameter
Constants.AR_LIST_SCHEMA_DOWNLINK all join forms that the form specified by the
formName parameter depends on
Constants.AR_LIST_SCHEMA_VIEW all view forms
Constants.AR_LIST_SCHEMA_VENDOR all vendor forms
Constants.AR_LIST_SCHEMA_DIALOG all display-only forms
Constants.AR_LIST_SCHEMA_ALL_WITH_DATA all forms with data field on it
Constants.AR_HIDDEN_INCREMENT) to the
form type. For example, specify Constants.AR_LIST_SCHEMA_REGULAR |
Constants.AR_HIDDEN_INCREMENT for this parameter.formName - If the formType is AR_LIST_SCHEMA_UPLINK, this parameter specifies the form upon which the retrieved
form depends on. If the schemaType is AR_LIST_SCHEMA_DOWNLINK, this parameter specifies the form that
depends on the retrieved form. This parameter is ignored if you don't specify AR_LIST_SCHEMA_UPLINK or
AR_LIST_SCHEMA_DOWNLINK as the formTypefieldIds - A list of form fields, and the API call only return the the forms that containing all these fields in
this list.propsToSearch - A list of object properties to search for. Returns all forms that match the object properties, for
example, the application owner.
ARException
public List<FormAliasInfo> getListFormAliases(long changedSince,
int formType,
String formName,
int[] fieldIds,
String vuiLabel)
throws ARException
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.formType - the type of forms to retrieve. The type can be:
Constants.AR_LIST_SCHEMA_ALL all form types.
Constants.AR_LIST_SCHEMA_REGULAR all regular forms
Constants.AR_LIST_SCHEMA_JOIN all join forms
Constants.AR_LIST_SCHEMA_UPLINK all join forms that depend on the form specified by the
formName parameter
Constants.AR_LIST_SCHEMA_DOWNLINK all join forms that the form specified by the
formName parameter depends on
Constants.AR_LIST_SCHEMA_VIEW all view forms
Constants.AR_LIST_SCHEMA_VENDOR all vendor forms
Constants.AR_LIST_SCHEMA_DIALOG all display-only forms
Constants.AR_LIST_SCHEMA_ALL_WITH_DATA all forms with data field on it
Constants.AR_HIDDEN_INCREMENT) to the
form type. For example, specify Constants.AR_LIST_SCHEMA_REGULAR |
Constants.AR_HIDDEN_INCREMENT for this parameter.formName - If the formType is AR_LIST_SCHEMA_UPLINK, this parameter specifies the form upon which the retrieved
form depends on. If the schemaType is AR_LIST_SCHEMA_DOWNLINK, this parameter specifies the form that
depends on the retrieved form. This parameter is ignored if you don't specify AR_LIST_SCHEMA_UPLINK or
AR_LIST_SCHEMA_DOWNLINK as the formTypefieldIds - A list of form fields, and the API call only return the the forms that containing all these fields in
this list.vuiLabel - Label for the specific view from which to retrieve aliases.
ARException
public List<Form> getListFormObjects(long changedSince,
int formType,
String formName,
int[] fieldIds,
FormCriteria criteria)
throws ARException
Form objects that match the specified criteria.
changedSince - a timestamp that limits the forms retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve forms with any modification timestamp.formType - the type of forms to retrieve. The type can be:
Constants.AR_LIST_SCHEMA_ALL all form types.
Constants.AR_LIST_SCHEMA_REGULAR all regular forms
Constants.AR_LIST_SCHEMA_JOIN all join forms
Constants.AR_LIST_SCHEMA_UPLINK all join forms that depend on the form specified by the
formName parameter
Constants.AR_LIST_SCHEMA_DOWNLINK all join forms that the form specified by the
formName parameter depends on
Constants.AR_LIST_SCHEMA_VIEW all view forms
Constants.AR_LIST_SCHEMA_VENDOR all vendor forms
Constants.AR_LIST_SCHEMA_DIALOG all display-only forms
Constants.AR_LIST_SCHEMA_ALL_WITH_DATA all forms with data field on it
Constants.AR_HIDDEN_INCREMENT) to the
form type. For example, specify Constants.AR_LIST_SCHEMA_REGULAR |
Constants.AR_HIDDEN_INCREMENT for this parameter.formName - If the formType is AR_LIST_SCHEMA_UPLINK, this parameter specifies the form upon which the retrieved
form depends on. If the schemaType is AR_LIST_SCHEMA_DOWNLINK, this parameter specifies the form that
depends on the retrieved form. This parameter is ignored if you don't specify AR_LIST_SCHEMA_UPLINK or
AR_LIST_SCHEMA_DOWNLINK as the formTypefieldIds - A list of form fields, and the API call only return the the forms that containing all these fields in
this list.criteria - the attribute returned for each Form object
Form objects
ARException
public void deleteFields(String form,
int[] fieldIds,
int deleteOption)
throws ARException
form - Name of the form from which fields be deletedfieldIds - list of IDs for fields to delete.deleteOption - a value indicating the action to take if the specified field contains data or is associated with a
join form or column field in the table field. The value can be:
Constants.AR_FIELD_CLEAN_DELETE delete the field only if it does not have data and does
not have any dependent field.
Constants.AR_FIELD_DATA_DELETE delete even if the field contains data, but not if it has
dependent fields.
Constants.AR_FIELD_FORCE_DELETE delete the field and all dependent fields.
ARException - if fields are not deleted
public List<ExtFieldCandidatesInfo> getListViewFormFieldCandidates(String tableName)
throws ARException
tableName - the name of the view form table that contains the candidate column/field
ARException - if information is not returned
public List<ExtFieldCandidatesInfo> getListVendorFormFieldCandidates(String vendorName,
String tableName)
throws ARException
tableName - the name of the vendor form table that contains the candidate column/field
ARException - if information is not returned
public List<ExtFormCandidatesInfo> getListExtFormCandidates(int formType)
throws ARException
ARException - if list is not returned
public void createContainer(Container object)
throws ARException
object - the Container object to create This operation can be performed by users with AR System
administrator privileges only.
ARException - if container is not created
public void createContainer(Container object,
boolean removeInvalidReference)
throws ARException
object - the Container object to createremoveInvalidReference - a flag that specifies how invalid object references are removed. If false is specified
for this flag, references to nonexistent ARSystem objects will be removed without error generated.
Specifying null for this parameter if you don't want to change the flag.
ARException - if container is not created
public void deleteContainer(String name,
int deleteOption)
throws ARException
name - the name of the container to deletedeleteOption - A bitmask indicating the action to taken. Bit 0 Constants.AR_DEFAULT_DELETE_OPTION: Server
object default delete option. For locked objects, fail the delete attempt. Bit 2
Constants.AR_LOCK_BLOCK_DELETE: Delete this character menu and all objects that are locked
with same key. Only applicable to locked objects.
ARException - if container is not deleted
public Container getContainer(String name)
throws ARException
ARException - if container is not loaded
public Container getContainer(String name,
ContainerCriteria criteria)
throws ARException
ContainerCriteria on the specified server. It can return references of a single, specified type, of all
types, or of an exclude reference type. The system returns information for accessible references and does nothing
for references for which the user does not have access. This operation can be performed by users with access
permission for the container.
name - the name of the container to returncriteria - the attribute returned for this Container object
ARException - if container is not returned
public void setContainer(Container object)
throws ARException
object - the Container object to create
ARException - if container is not stored
public void setContainer(Container object,
boolean removeInvalidReference)
throws ARException
object - the Container object to createremoveInvalidReference - a flag that specifies how invalid object references are removed. If false, references to
nonexistent ARSystem objects will be removed without error generated. Specifying null for this
parameter if you don't want to change the flag.
ARException - if container is not stored
public List<String> getListContainer(long changedSince,
int[] containerTypes,
boolean hiddenFlag,
List<ContainerOwner> ownerList,
ObjectPropertyMap propsToSearch)
throws ARException
Container object that meet the given criteria.
changedSince - a timestamp that limits the containers retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve containers with any modification timestamp.containerTypes - a list of values indicating the container types to retrieve. They are:
Constants.ARCON_ALL retrieve all container types.
Constants.ARCON_GUIDE retrieve all guide containers
Constants.ARCON_APP retrieve all application containers
Constants.ARCON_PACK retrieve all packing list containers
Constants.ARCON_FILTER_GUIDE retrieve all filter guide containers
Constants.ARCON_WEBSERVICE retrieve all web service containers
hiddenFlag - a flag indicate if retrieve both visible and hidden containers.ownerList - a list of container owner types that own the containerpropsToSearch - list of object property to search for. Return all containers that match the object property
ARException
public List<Container> getListContainerObjects(long changedSince,
int[] containerTypes,
boolean hiddenFlag,
List<ContainerOwner> ownerList,
ObjectPropertyMap propsToSearch,
ContainerCriteria criteria)
throws ARException
Container objects that match with the given criteria
changedSince - a timestamp that limits the containers retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve containers with any modification timestamp.containerTypes - a list of values indicating the container types to retrieve. They are:
Constants.ARCON_ALL retrieve all container types.
Constants.ARCON_GUIDE retrieve all guide containers
Constants.ARCON_APP retrieve all application containers
Constants.ARCON_PACK retrieve all packing list containers
Constants.ARCON_FILTER_GUIDE retrieve all filter guide containers
Constants.ARCON_WEBSERVICE retrieve all web service containers
hiddenFlag - a flag indicate if retrieve both visible and hidden containers.ownerList - a list of container owner types that own the containerpropsToSearch - list of object property to search for. Return all containers that match the object propertycriteria - the attribute returned for each container object
Container objects
ARException
public List<Container> getListContainerObjects(List<String> containers)
throws ARException
Container objects
containers - the names of containers to retrieve
ARException
public List<MenuItem> expandMenu(Menu menu)
throws ARException
menu - the menu to expand
ARException - if menu is not expanded
public List<MenuItem> expandMenu(Menu menu,
Entry keywordList,
Entry parameterList)
throws ARException
ARException
public List<MenuItem> expandMenu(String menuName)
throws ARException
menuName - the name of the menu to expand
ARException
public List<MenuItem> expandMenu(String menuName,
Entry keywordList,
Entry parameterList)
throws ARException
ARException
public void createMenu(Menu object)
throws ARException
object - the menu object to be created in ARSystem server
ARException - if object is not created
public void deleteMenu(String name,
int deleteOption)
throws ARException
name - the name of the menu to deletedeleteOption - a bitmask indicating the action to take. Bit 0 Constants.AR_DEFAULT_DELETE_OPTION: Server
object default delete option. For locked objects, fail the delete attempt. Bit 2
Constants.AR_LOCK_BLOCK_DELETE: Delete this character menu and all objects that are locked
with same key. Only applicable to locked objects.
ARException - if object is not removed
public Menu getMenu(String name,
MenuCriteria criteria)
throws ARException
MenuCriteria from AR System server.
name - the name of the menu to getcriteria - the attribute returned for this Menu object
ARException - if object is not loaded
public void setMenu(Menu object)
throws ARException
object - the menu object to be saved in the server
ARException - if object is not saved
public List<String> getListMenu(long changedSince,
List<String> forms,
List<String> activeLinks)
throws ARException
changedSince - a timestamp that limits the menus retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve containers with any modification timestamp.forms - a list of form names that limit the menu retrieved to the ones that referenced by field in these
forms.activeLinks - a list for activelink names that limit the menu retrieved to the ones that have a change field action
with the menu.
ARException
public List<String> getListMenu(long changedSince,
List<String> forms,
List<String> activeLinks,
ObjectPropertyMap propsToSearch)
throws ARException
changedSince - a timestamp that limits the menus retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve menus with any modification timestamp.forms - a list of form names that limit the menu retrieved to the ones that referenced by field in these
forms.activeLinks - a list for activelink names that limit the menu retrieved to the ones that have a change field action
with the menu.propsToSearch - A list of object properties to search for. Returns all menus that match the object properties.
ARException
public List<Menu> getListMenuObjects(long changedSince,
List<String> forms,
List<String> activeLinks,
MenuCriteria criteria)
throws ARException
changedSince - a timestamp that limits the menus retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve menus with any modification timestamp.forms - a list of form names that limit the menu retrieved to the ones that referenced by field in these
forms.activeLinks - a list for activelink names that limit the menu retrieved to the ones that have a change field action
with the menu.criteria - the attribute returned for each Menu object
ARException - if information cannot be returned
public void createField(Field object,
boolean isReservedRangeIdOK)
throws ARException
object - the form field to be created in ARSystem serverisReservedRangeIdOK - a flag indicate if you can create the field with a reserved field id
ARException - if object is not created
public void createMultipleFields(List<Field> fields)
throws ARException
fields - fields to be created in ARSystem server
ARException - if object is not created
public void deleteField(String form,
int fieldId,
int deleteOption)
throws ARException
form - Name of the form from which fields be deletedfieldId - IDs of the field to delete.deleteOption - a value indicating the action to take if the specified field contains data or is associated with a
join form or column field in the table field. The value can be:
Constants.AR_FIELD_CLEAN_DELETE delete the field only if it does not have data and does
not have any dependent field.
Constants.AR_FIELD_DATA_DELETE delete even if the field contains data, but not if it has
dependent fields.
Constants.AR_FIELD_FORCE_DELETE delete the field and all dependent fields.
ARException - if object is not deleted
public Field getField(String form,
int fieldId)
throws ARException
form - the name of the form containing the field to retrievefieldId - the id of the field to retrieve
ARException - if object is not loaded
public Field getField(String form,
int fieldId,
FieldCriteria criteria)
throws ARException
form - the name of the form containing the field to retrievefieldId - the id of the field to retrievecriteria - the attribute returned for this Field object
ARException - if object is not loaded
public void setField(Field object)
throws ARException
object - the object to save
ARException - if object is not saved
public void setMultipleFields(List<Field> fields)
throws ARException
fields - a list of fields to save
ARException - if object is not saved
public List<Integer> getListField(String formName,
int fieldTypeMask,
long changedSince)
throws ARException
formName - the name of the form where the fields residefieldTypeMask - A bit mask value to specify types of the field. They are: bit 0: Constants.AR_FIELD_TYPE_DATA
retrieve data fields bit 1: Constants.AR_FIELD_TYPE_TRIM retrieve trim fields bit 2:
Constants.AR_FIELD_TYPE_CONTROL retrieve control fields bit 3:
Constants.AR_FIELD_TYPE_PAGE retrieve page fields bit 4:
Constants.AR_FIELD_TYPE_PAGE_HOLDER retrieve page holder fields bit 5:
Constants.AR_FIELD_TYPE_TABLE retrieve table fields bit 6:
Constants.AR_FIELD_TYPE_COLUMN retrieve column fields bit 7:
Constants.AR_FIELD_TYPE_ATTACH retrieve attachment fields bit 8:
Constants.AR_FIELD_TYPE_ATTACH_POOL retrieve attachment pool fields
Constants.AR_FIELD_TYPE_ALL retrieve all type of fieldschangedSince - A timestamp that limits the fields retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve fields with any modification timestamp.
ARException
public List<Field> getListFieldObjects(String formName)
throws ARException
formName - the name of the form containing the field to retrieve
ARException - if information is not returned
public List<Field> getListFieldObjects(String formName,
int fieldTypeMask)
throws ARException
formName - the name of the form containing the field to retrievefieldTypeMask - A bit mask value to specify types of the field. They are: bit 0: Constants.AR_FIELD_TYPE_DATA
retrieve data fields bit 1: Constants.AR_FIELD_TYPE_TRIM retrieve trim fields bit 2:
Constants.AR_FIELD_TYPE_CONTROL retrieve control fields bit 3:
Constants.AR_FIELD_TYPE_PAGE retrieve page fields bit 4:
Constants.AR_FIELD_TYPE_PAGE_HOLDER retrieve page holder fields bit 5:
Constants.AR_FIELD_TYPE_TABLE retrieve table fields bit 6:
Constants.AR_FIELD_TYPE_COLUMN retrieve column fields bit 7:
Constants.AR_FIELD_TYPE_ATTACH retrieve attachment fields bit 8:
Constants.AR_FIELD_TYPE_ATTACH_POOL retrieve attachment pool fields
Constants.AR_FIELD_TYPE_ALL retrieve all type of fields
ARException - if information is not returned
public List<Field> getListFieldObjects(String formName,
int fieldTypeMask,
long changedSince)
throws ARException
formName - the name of the form containing the field to retrievefieldTypeMask - A bit mask value to specify types of the field. They are: bit 0: Constants.AR_FIELD_TYPE_DATA
retrieve data fields bit 1: Constants.AR_FIELD_TYPE_TRIM retrieve trim fields bit 2:
Constants.AR_FIELD_TYPE_CONTROL retrieve control fields bit 3:
Constants.AR_FIELD_TYPE_PAGE retrieve page fields bit 4:
Constants.AR_FIELD_TYPE_PAGE_HOLDER retrieve page holder fields bit 5:
Constants.AR_FIELD_TYPE_TABLE retrieve table fields bit 6:
Constants.AR_FIELD_TYPE_COLUMN retrieve column fields bit 7:
Constants.AR_FIELD_TYPE_ATTACH retrieve attachment fields bit 8:
Constants.AR_FIELD_TYPE_ATTACH_POOL retrieve attachment pool fields
Constants.AR_FIELD_TYPE_ALL retrieve all type of fieldschangedSince - A timestamp that limits the fields retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve fields with any modification timestamp.
ARException - if information is not returned
public List<Field> getListFieldObjects(String formName,
int fieldTypeMask,
long changedSince,
FieldCriteria criteria)
throws ARException
Field objects that match with the given criteria.
formName - the name of the form containing the field to retrievefieldTypeMask - A bit mask value to specify types of the field. They are: bit 0: Constants.AR_FIELD_TYPE_DATA
retrieve data fields bit 1: Constants.AR_FIELD_TYPE_TRIM retrieve trim fields bit 2:
Constants.AR_FIELD_TYPE_CONTROL retrieve control fields bit 3:
Constants.AR_FIELD_TYPE_PAGE retrieve page fields bit 4:
Constants.AR_FIELD_TYPE_PAGE_HOLDER retrieve page holder fields bit 5:
Constants.AR_FIELD_TYPE_TABLE retrieve table fields bit 6:
Constants.AR_FIELD_TYPE_COLUMN retrieve column fields bit 7:
Constants.AR_FIELD_TYPE_ATTACH retrieve attachment fields bit 8:
Constants.AR_FIELD_TYPE_ATTACH_POOL retrieve attachment pool fields
Constants.AR_FIELD_TYPE_ALL retrieve all type of fieldschangedSince - A timestamp that limits the fields retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve fields with any modification timestamp.criteria - the infomation to retrieve
ARException - if information is not returned
public List<Field> getListFieldObjects(String formName,
int[] fieldIds)
throws ARException
formName - the name of the form containing the field to retrievefieldIds - the id of fields to retrieve
ARException - if information is not returned
public List<Field> getListFieldObjects(String formName,
int[] fieldIds,
FieldCriteria criteria)
throws ARException
formName - the name of the form containing the field to retrievefieldIds - the id of fields to retrievecriteria - the attribute returned for each Field object
ARException - if information is not returned
public void createView(View object)
throws ARException
object - the view object to create
ARException - if object is not saved
public void deleteView(String formName,
int viewId)
throws ARException
formName - the name of the form where the view residesviewId - the id of the view to create
ARException - if object is not removed
public View getView(String formName,
int viewId)
throws ARException
formName - Name of the form where the view residesviewId - the id of the view
ARException
public View getView(String formName,
int viewId,
ViewCriteria criteria)
throws ARException
ViewCriteria from the AR System server.
formName - the name of the form where the view residesviewId - the id of the viewcriteria - the attribute returned for this View object
ARException - if object is not loaded
public void setView(View object)
throws ARException
object - the view object to be updated
ARException - if object is not saved
public List<Integer> getListView(String formName,
long changedSince)
throws ARException
formName - the name of the form where the view resideschangedSince - A timestamp that limits the fields retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve fields with any modification timestamp.
ARException - if list is not found
public List<View> getListViewObjects(String formName,
long changedSince,
ViewCriteria criteria)
throws ARException
View objects that match with the given crteria.
formName - the name of the form where the view resideschangedSince - A timestamp that limits the fields retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve fields with any modification timestamp.criteria - the attribute returned for each View object
ARException - if list is not found
public static String encodeDiary(DiaryListValue diaryList)
throws ARException
DiaryListValue as input and encodes it into a diary string.
diaryList - the diaryList to be encoded
ARException - if DiaryListValue is not encoded
public DiaryListValue decodeDiary(String encoded)
throws ARException
DiaryListValue for easier processing.
encoded - the encoded diary string
ARException - if DiaryListValue is not decoded
public QualifierInfo parseQualification(String queryString,
List<Field> fieldList1,
List<Field> fieldList2,
int queryContext)
throws ARException
QualifierInfo object given a string representation.
queryString - representing the qualification string to be parsedfieldList1 - An array of Field objects of the form. (fieldList1 parameter is used in two different modes.)
First mode - is for parsing the queries similar to the ones created in User Tool advanced query bar.
This type of queries are always defined in terms of a single form. In this case, the Field
objects be from the form to which this qualifier is going to be applied. Second mode - is applicable
when a qualification deals with two forms. For example, a qualification in SetFields, PushFields etc
active link actions, can be defined in terms of two forms - one to which the active link belongs and
the other form to/from which the data will be set. The later is termed as remote form. In this
case, specify the array of Field objects of the remote form.fieldList2 - An array of Field objects of a form. First mode - this parameter is not applicable and can be
null. Second mode - applicable only in this mode. In this mode, this array of Field objects
comes from the local form.queryContext - Default value is AR_QUALCONTEXT_DEFAULT. Different parsing
rules apply when a query line is encountered within an Active Link (in SetFields action, Run If
condition etc), Filter, Escalation or in a Menu definition. Indicate appropriate value using
AR_QUALCONTEXT_ACTIVE_LINK,
AR_QUALCONTEXT_ESCALATION,
AR_QUALCONTEXT_FILTER, or
AR_QUALCONTEXT_MENU_DEFS.
ARException - if object is not constructed
public AssignInfo parseAssignment(String assignString,
String queryString,
Field assignField,
List<Field> fieldList1,
List<Field> fieldList2,
String form,
String server,
int currentScreen,
boolean idOk,
boolean fromSQL,
boolean fromFilterAPI,
int queryContext)
throws ARException
AssignInfo object given a string representation.
assignString - String representing the assignment string to be parsedqueryString - String representing the qualification for setfields/pushfields ifassignField - Field the destination for the assignmentfieldList1 - An array of Field objects of the form. (fieldList1 parameter is used in two different modes.)
First mode - is for parsing the queries similar to the ones created in the advanced query bar. This
type of queries are always defined in terms of a single form. In this case, the Field objects
be from the form to which this qualifier is going to be applied. Second mode - is applicable when a
qualification deals with two forms. For example, a qualification in SetFields, PushFields etc active
link actions, can be defined in terms of two forms - one to which the active link belongs and the
other form to/from which the data will be set. The later is termed as remote form. In this
case, specify the array of Field objects of the remote form.fieldList2 - An array of Field objects of a form. First mode - this parameter is not applicable and can be
null. Second mode - applicable only in this mode. In this mode, this array of Field objects
comes from the local form.form - String representing the source form, if set fields from remote formserver - String representing the source server for the above formcurrentScreen - int value indicating if its from current screenidOk - flag indicating if both field ids and names should be considered while parsingfromSQL - flag to indicate that the source for assignment is a Direct SQL callfromFilterAPI - flag to indicate that the source is filterapi actionqueryContext - context for the qualification for assignment,for eg. filter, escalation, filter setfields etc.
Indicate appropriate value using Constants.AR_CONTEXT_ACTIVE_LINK,
Constants.AR_CONTEXT_FILTER, Constants.AR_CONTEXT_ESCALATION,
Constants.AR_CONTEXT_MENU_DEFS, Constants.AR_CONTEXT_ACTIVE_LINK_SETFIELDS,
Constants.AR_CONTEXT_FILTER_SETFIELDS, Constants.AR_CONTEXT_ESCALATION_SETFIELDS,
Constants.AR_CONTEXT_ESCALATION_TIME.
AssignInfo representing the given assignment string
ARException
public String formatAssignment(AssignInfo assign,
List<Field> fieldList,
Field assignField,
boolean topLevel)
throws ARException
String object containing the string representation of a given assignment AssignInfo
object.
assign - AssignInfo assignment object to be formatedfieldList - An array of Field objects of the form. (fieldList1 parameter is used in two different modes.)
First mode - is for parsing the queries similar to the ones created in the advanced query bar. This
type of queries are always defined in terms of a single form. In this case, the Field objects
be from the form to which this qualifier is going to be applied. Second mode - is applicable when a
qualification deals with two forms. For example, a qualification in SetFields, PushFields etc active
link actions, can be defined in terms of two forms - one to which the active link belongs and the
other form to/from which the data will be set. The later is termed as remote form. In this
case, specify the array of Field objects of the remote form.assignField - Field to which assignment is being donetopLevel - flag to indicate if assignment is top level or not
String formatted to show the assignment info as string.
ARException
public String formatQualification(QualifierInfo qual,
List<Field> fieldList1,
List<Field> fieldList2,
int queryContext,
boolean isEscalation)
throws ARException
String object containing the string representation of a given qualifier object.
qual - the QualifierInfo object to be formatted.fieldList1 - An array of Field objects of the form. (fieldList1 parameter is used in two different modes.)
First mode - is for parsing the queries similar to the ones created in the advanced query bar. This
type of queries are always defined in terms of a single form. In this case, the Field objects
be from the form to which this qualifier is going to be applied. Second mode - is applicable when a
qualification deals with two forms. For example, a qualification in SetFields, PushFields etc active
link actions, can be defined in terms of two forms - one to which the active link belongs and the
other form to/from which the data will be set. The later is termed as remote form. In this
case, specify the array of Field objects of the remote form.fieldList2 - An array of Field objects of a form. First mode - this parameter is not applicable and can be
null. Second mode - applicable only in this mode. In this mode, this array of Field objects
comes from the local form.queryContext - Default value is AR_QUALCONTEXT_DEFAULT. Different parsing
rules apply when a query line is encountered within an Active Link (in SetFields action, Run If
condition etc), Filter, Escalation or in a Menu definition. Indicate appropriate value using
AR_QUALCONTEXT_ACTIVE_LINK,
AR_QUALCONTEXT_ESCALATION,
AR_QUALCONTEXT_FILTER, or
AR_QUALCONTEXT_MENU_DEFS.isEscalation - Default is false. Specify true only when in the this of a escalation's query line. When unsure specify
'false'.
ARException - if object is not constructed
public String createEntry(String formName,
Entry entry)
throws ARException
formName - the name of the form to create entry intoentry - the entry to be created
ARException - if entry is not created
public void deleteEntry(String formName,
String entryId,
int deleteOption)
throws ARException
formName - the name of the form that containing the entryentryId - the id of the entry to be deleteddeleteOption - specify 0 for this parameter (reserved for future use).
ARException - if entry is not removed
public Entry getEntry(String formName,
String entryId,
int[] entryListFields)
throws ARException
formName - the name of the form that contains the entryentryId - the id of the entryentryListFields - a list of zero or more ids specifying the fields to retrieve. specifing null or zero fields for this
parameter to retrieve all (accessible) fields. To minimize network traffic, specify only the fields
you need if you do not require the data for all fields. If an attachment field is specified in this
list, only its name, size and compress size will be returned.
ARException - if entry is not loaded
public void setEntry(String formName,
String entryId,
Entry entry,
Timestamp getTime,
int nOption)
throws ARException
formName - the name of the form that containing the entryentryId - the id of the entryentry - the entry to be updatedgetTime - Time stamp identifying when the entry was last retrieved. The system compares this value with the
value in the Modified Date core field to determine whether the entry has been changed since the last
retrieval. The system updates the entry if the value you specify is greater than Modified Date. If
not, the system returns an error. You can either retrieve the entry again and determine whether to
apply your changes or specify 0 for this parameter to bypass the time stamp comparison.nOption - Value indicating whether users can update fields specified in the join qualification (applicable for
join forms only).
AR_JOIN_SETOPTION_NONE = 0 AR_JOIN_SETOPTION_REF = 1 ARException - if entry is not updated
public Entry executeService(String formName,
String entryId,
Entry entry,
int[] entryListFields)
throws ARException
formName - the name of the form where the service is performedentryId - the id of the entry to be used in the transactionentry - the input entry used to trigger server workflowentryListFields - a list of zero or more ids specifying the fields to retrieve.
ARException
public String xmlExecuteService(String queryMapping,
String queryDoc,
String inputMapping,
String inputDoc,
String outputMapping,
String optionDoc)
throws ARException
ARException
public String mergeEntry(String formName,
Entry entry,
int nMergeType)
throws ARException
formName - the name of the form to merge entry intoentry - the entry to be mergednMergeType - A value indicating the action to take if the Entry ID already exists in the target form. This
parameter is ignored if you do not specify the Entry ID or the ID specified does not conflict with
existing entry IDs.
AR_MERGE_ENTRY_DUP_ERROR) = 1
AR_MERGE_ENTRY_DUP_NEW_ID) = 2
AR_MERGE_ENTRY_DUP_OVERWRITE) = 3
AR_MERGE_ENTRY_DUP_MERGE) = 4
To omit some field validation steps, add the appropriate increments to the merge type.
AR_MERGE_NO_REQUIRED_INCREMENT) = 1024
$MENU$) (
AR_MERGE_NO_PATTERNS_INCREMENT) = 2048
ARException - if entry is not merged
public List<EntryListInfo> getListEntry(String formName,
QualifierInfo qualification,
int firstRetrieve,
int maxRetrieve,
List<SortInfo> sortList,
List<EntryListFieldInfo> entryListFields,
boolean useLocale,
OutputInteger nMatches)
throws ARException
EntryListInfo objects that uniquely identify the entry objects that match the provided
criteria.
formName - String name of the form that containing the entriesqualification - QualifierInfo query that determines the set of entries to retrievefirstRetrieve - first entry to retrieve. A value of 0 represent the first entry.maxRetrieve - maxium number of entries to retrievesortList - list of SortInfo instances that define the sort order for list of entries returnedentryListFields - list of EntryListFieldInfo instances that define the IDs of the fields to include in the
result and the formats of the fields. The list can include any data field except diary fields and long
character field. The AR System server checks the permission for each specified field and returns only
those fields for which the user has read access.useLocale - boolean flag that controls whether the result includes only entries based on locale (1 or TRUE) or all
enties (0 or FALSE). The Localize Server option must be selected for the AR System server to return
only localized entries. For information about the Localize Server option, see the Configuring
guide.nMatches - returns the number of (accessible) entries that match the qualification criteria. Specify null for
this parameter if you do not want to retrieve this count.
EntryListInfo objects that identify the result entry objects
ARException - if list is not returned
public List<Entry> getListEntryObjects(String formName,
QualifierInfo qualification,
int firstRetrieve,
int maxRetrieve,
List<SortInfo> sortList,
int[] fieldIds,
boolean useLocale,
OutputInteger nMatches)
throws ARException
Entry objects that match the provided criteria.
formName - String name of the form that containing the entriesqualification - QualifierInfo query that determines the set of entries to retrievefirstRetrieve - first entry to retrieve. A value of 0 represent the first entry.maxRetrieve - maxium number of entries to retrievesortList - list of SortInfo instances that define the sort order for list of entries returnedfieldIds - array of int field IDs that specify the fields in the result. The fields can include any data field
except diary fields and long character field. The AR System server checks the permission for each
specified field and returns only those fields for which the user has read access.useLocale - boolean flag that controls whether the result includes only entries based on locale (1 or TRUE) or all
enties (0 or FALSE). The Localize Server option must be selected for the AR System server to return
only localized entries. For information about the Localize Server option, see the Configuring
guide.nMatches - returns the number of (accessible) entries that match the qualification criteria. Specify null for
this parameter if you do not want to retrieve this count.
Entry objects that match the provided criteria
ARException - if list is not returned
public Entry getOneEntryObject(String formName,
QualifierInfo qualification,
List<SortInfo> sortList,
int[] fieldIds,
boolean useLocale,
OutputInteger nMatches)
throws ARException
Entry objects that match the provided criteria.
formName - String name of the form that containing the entriesqualification - QualifierInfo query that determines the set of entries to retrievefirstRetrieve - first entry to retrieve. A value of 0 represent the first entry.maxRetrieve - maxium number of entries to retrievesortList - list of SortInfo instances that define the sort order for list of entries returnedfieldIds - array of int field IDs that specify the fields in the result. The fields can include any data field
except diary fields and long character field. The AR System server checks the permission for each
specified field and returns only those fields for which the user has read access.useLocale - boolean flag that controls whether the result includes only entries based on locale (1 or TRUE) or all
enties (0 or FALSE). The Localize Server option must be selected for the AR System server to return
only localized entries. For information about the Localize Server option, see the Configuring
guide.nMatches - returns the number of (accessible) entries that match the qualification criteria. Specify null for
this parameter if you do not want to retrieve this count.
Entry objects that match the provided criteria
ARException - if list is not returned
public List<Entry> getListEntryObjects(String formName,
List<String> entryIds,
int[] fieldIds)
throws ARException
Entry objects that match the provided criteria.
formName - String name of the form that containing the entriesentryIds - list of String IDs of the entries retrievefieldIds - array of int field IDs that determine the fields in the result. The fields can include any data field
except diary fields and long character field. The AR System server checks the permission for each
specified field and returns only those fields for which the user has read access.
Entry objects that match the provided criteria
ARException - if list is not returned
public void getListEntryObjects(String formName,
QualifierInfo qualification,
int firstRetrieve,
int maxRetrieve,
List<SortInfo> sortList,
int[] fieldIds,
boolean useLocale,
OutputInteger nMatches,
IARRowIterator iterator)
throws ARException
Entry object that matches the
provided criteria.
formName - String name of the form that containing the entriesqualification - QualifierInfo query that determines the set of entries to retrievefirstRetrieve - first entry to retrieve. A value of 0 represent the first entry.maxRetrieve - maxium number of entries to retrievesortList - list of SortInfo instances that define the sort order for list of entries returnedfieldIds - array of int field IDs that specify the fields in the result. The fields can include any data field
except diary fields and long character field. The AR System server checks the permission for each
specified field and returns only those fields for which the user has read access.useLocale - boolean flag that controls whether the result includes only entries based on locale (1 or TRUE) or all
enties (0 or FALSE). The Localize Server option must be selected for the AR System server to return
only localized entries. For information about the Localize Server option, see the Configuring
guide.nMatches - returns the number of (accessible) entries that match the qualification criteria. Specify null for
this parameter if you do not want to retrieve this count.iterator - instance of a class that implements IARRowIterator interface. The implementation of this class
provides the callback function that this method applies to each Entry object that matches the
provided criteria.
ARException - if search failsIARRowIterator
public List<QuerySourceValues> getListEntryObjects(RegularQuery query,
int firstRetrieve,
int maxRetrieve,
boolean useLocale,
OutputInteger nMatches)
throws ARException
QuerySourceValues objects that match the provided criteria. Supports joins, subqueries
and hierarchical queries constructs.
query - RegularQuery query that determines the set of entries to retrievefirstRetrieve - first entry to retrieve. A value of 0 represent the first entry.maxRetrieve - maximum number of entries to retrieveuseLocale - boolean flag that controls whether the result includes only entries based on locale (1 or TRUE) or all
enties (0 or FALSE). The Localize Server option must be selected for the AR System server to return
only localized entries. For information about the Localize Server option, see the Configuring
guide.nMatches - returns the number of (accessible) entries that match the qualification criteria. Specify null for
this parameter if you do not want to retrieve this count.
QuerySourceValues objects that match the provided criteria
ARException - if list is not returned
public void getEntryBlob(String formName,
String entryID,
int fieldID,
String filePath)
throws ARException
formName - the name of the form that containing the entryentryID - the id of the entry that contains the attachmentfieldID - the id of the attachment fieldfilePath - the path to a file that stores the return attachment
ARException - if blob attachment is not returned
public byte[] getEntryBlob(String formName,
String entryID,
int fieldID)
throws ARException
formName - the name of the form that containing the entryentryID - the id of the entry that contains the attachmentfieldID - the id of the attachment field
ARException - if blob attachment is not returned
public ProcessResult executeProcess(String command)
throws ARException
command - the command to execute. Must be a valid command on the specified server.
ARException - if command is not performed
public ProcessResult executeProcess(String command,
boolean waitFlag)
throws ARException
command - the command to execute. Must be a valid command on the specified server.waitFlag - To Execute Process, an independent process is spawned on server. Enter a boolean value of FALSE if you
do not wait for the process to complete.
ARException - if command is not performed
public ProcessResult executeProcessForActiveLink(String actlinkName,
int actionIndex,
int actionType,
int fieldId,
Timestamp timestamp,
List<Value> keywordList,
List<Value> parameterList)
throws ARException
ARException
public ProcessResult executeProcessForActiveLink(String actlinkName,
int actionIndex,
int actionType,
int fieldId,
Timestamp timestamp,
List<Value> keywordList,
List<Value> parameterList,
boolean waitFlag)
throws ARException
ARException
public SQLResult getListSQLForActiveLink(String actlinkName,
int actionIndex,
int actionType,
Timestamp timestamp,
List<Value> keywordList,
List<Value> parameterList,
int maxRetrieve,
boolean retrieveTotalMatches)
throws ARException
ARException
public ActiveLink getActiveLink(String name)
throws ARException
ActiveLink from the server
name - the name of the activelink
ARException
public ActiveLink getActiveLink(String name,
ActiveLinkCriteria criteria)
throws ARException
ActiveLink object
name - the name of the activelink to retrievecriteria - the attribute returned for this activelink object
ARException
public List<String> getListActiveLink()
throws ARException
ARException
public List<String> getListActiveLink(String formName)
throws ARException
formName - the name of the form that is associated with the active link.
ARException
public List<String> getListActiveLink(long changedSince)
throws ARException
changedSince - A timestamp that limits the activelinks retrieved to those modified after the specified time. Specify
0 for this parameter to retrieve activelinks with any modification timestamp.
ARException
public List<String> getListActiveLink(String formName,
long changedSince)
throws ARException
formName - the name of the form that is associated with the active link.changedSince - A timestamp that limits the activelinks retrieved to those modified after the specified time. Specify
0 for this parameter to retrieve activelinks with any modification timestamp.
ARException
public List<String> getListActiveLink(String formName,
long changedSince,
ObjectPropertyMap propsToSearch)
throws ARException
formName - the name of the form that is associated with the active link.changedSince - A timestamp that limits the activelinks retrieved to those modified after the specified time. Specify
0 for this parameter to retrieve activelinks with any modification timestamp.propsToSearch - A list of object properties to search for. Returns all activelinks that match the object properties.
ARException - if list is not returned
public List<ActiveLink> getListActiveLinkObjects(String formName)
throws ARException
ActiveLink objects that are associated with the
specified form
formName - the name of the form that is associated with the active link.
ARException
public List<ActiveLink> getListActiveLinkObjects(String formName,
long changedSince)
throws ARException
ActiveLink objects that are associated with the
specified form and modified after the given time.
formName - the name of the form that is associated with the active link.changedSince - A timestamp that limits the activeLinks retrieved to those modified after the specified time. Specify
0 for this parameter to retrieve activelinks with any modification timestamp.
ARException
public List<ActiveLink> getListActiveLinkObjects(String formName,
long changedSince,
ActiveLinkCriteria criteria)
throws ARException
ActiveLink objects specified by the criteria and
ActiveLinkCriteria.
formName - the name of the form that is associated with the active link.changedSince - A timestamp that limits the activelinks retrieved to those modified after the specified time.criteria - the infomation (attributes) to retrieve
ARException
public List<ActiveLink> getListActiveLinkObjects()
throws ARException
ActiveLink objects
ARException
public List<ActiveLink> getListActiveLinkObjects(List<String> names)
throws ARException
ActiveLink objects that the user has permission to access
names - the names of activelinks to retrieve
ARException
public List<ActiveLink> getListActiveLinkObjects(List<String> names,
ActiveLinkCriteria criteria)
throws ARException
ActiveLink objects that the user has permission to access
names - the names of activelinks to retrievecriteria - the attribute returned for each activelink object
ARException
public List<ActiveLink> getListActiveLinkObjects(List<String> names,
long changedSince,
ActiveLinkCriteria criteria)
throws ARException
ActiveLink objects that the user has permission to access
and is modified after the give time
names - the names of activelinks to retrievechangedSince - A timestamp that limits the activelinks retrieved to those modified after the specified time. Specify
0 for this parameter to retrieve activelinks with any modification timestamp.criteria - the attribute returned for each activelink object
ARException
public void createActiveLink(ActiveLink object)
throws ARException
ActiveLink object on AR System server.
object - the active link object to be created on the server
ARException - if object is not created
public void deleteActiveLink(String name,
int deleteOption)
throws ARException
name - the name of the activelink to be deleteddeleteOption - A bitmask indicates the action to take: Bit 0 Constants.AR_DEFAULT_DELETE_OPTION: Server
object default delete option. For locked object, fails the delete attempt. Bit 2
Constants.AR_LOCK_BLOCK_DELETE: Delete activelink and all object in the block that are locked
with the same key. this is applicable only to locked objects.
ARException - if object is not deleted
public void setActiveLink(ActiveLink object)
throws ARException
object - the activelink object to be updated.
ARException - if object is not saved
public Filter getFilter(String key)
throws ARException
Filter object specified by the given name.
key - Name of the filter to fetch
ARException
public Filter getFilter(String key,
FilterCriteria criteria)
throws ARException
Filter object specified by FilterCriteria and
String.
key - Name of the filter to fetchcriteria - the attribute returned for this filter object
ARException - if information is not returned
public List<String> getListFilter()
throws ARException
ARException - if list is not returned
public List<String> getListFilter(String formName)
throws ARException
formName - the name of the form that is associated with the return filters
ARException - if list is not returned
public List<String> getListFilter(long changedSince)
throws ARException
changedSince - A timestamp that limits the filters retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.
ARException - if list is not returned
public List<String> getListFilter(String formName,
long changedSince)
throws ARException
formName - the name of the form that is associated with the return filterschangedSince - A timestamp that limits the filters retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.
ARException - if list is not returned
public List<String> getListFilter(String formName,
long changedSince,
ObjectPropertyMap propsToSearch)
throws ARException
formName - the name of the form that is associated with the filter.changedSince - A timestamp that limits the filters retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.propsToSearch - A list of object properties to search for. Returns all filters that match the object properties.
ARException - if list is not returned
public List<Filter> getListFilterObjects(String formName)
throws ARException
Filter objects that are associated with the given form
formName - the name of the form that is associated with the filter
ARException
public List<Filter> getListFilterObjects(String formName,
long changedSince)
throws ARException
Filter objects that are associated with the given form and modified
after the provided timestamp
formName - the name of the form that is associated with the filterchangedSince - A timestamp that limits the filters retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.
ARException
public List<Filter> getListFilterObjects(String formName,
long changedSince,
FilterCriteria criteria)
throws ARException
Filter objects that are associated with the given form
and modified after the provided timestamp
formName - the name of the form that is associated with the filterchangedSince - A timestamp that limits the filters retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.criteria - the attribute (information) to retrieve
ARException - if information is not returned
public List<Filter> getListFilterObjects()
throws ARException
Filter objects
ARException
public List<Filter> getListFilterObjects(List<String> names)
throws ARException
Filter objects
names - the name of filters to retrieve
ARException
public List<Filter> getListFilterObjects(List<String> names,
FilterCriteria criteria)
throws ARException
Filter objects
names - the name of filters to retrievecriteria - the attribute returned for each filter object
ARException
public List<Filter> getListFilterObjects(List<String> names,
long changedSince,
FilterCriteria criteria)
throws ARException
Filter objects that are modified after the given
timestamp
names - the name of filters to retrievechangedSince - A timestamp that limits the filters retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.criteria - the attribute returned for each filter object
ARException
public void createFilter(Filter object)
throws ARException
Filter object on AR System server.
object - the filter object to create
ARException - if object is not created
public void deleteFilter(String name,
int deleteOption)
throws ARException
name - the name of the filter to deletedeleteOption - A bitmask indicates the action to take: Bit 0 Constants.AR_DEFAULT_DELETE_OPTION: Server
object default delete option. For locked object, fails the delete attempt. Bit 2
Constants.AR_LOCK_BLOCK_DELETE: Delete filter and all object in the block that are locked with
the same key. this is applicable only to locked objects.
ARException - if object is not deleted
public void setFilter(Filter object)
throws ARException
Filter object onto ARSystem server.
object - the filter object to be updated in the server
ARException - if object is not saved
public Escalation getEscalation(String key)
throws ARException
Escalation object specified by the given name.
key - Name of the escalation to fetch
ARException
public Escalation getEscalation(String key,
EscalationCriteria criteria)
throws ARException
Escalation object.
key - name of the Escalation object to retrievecriteria - A EscalationCriteria object containing the attributes to retrieve
ARException - if information is not returned
public List<String> getListEscalation()
throws ARException
Escalation objects
ARException
public List<String> getListEscalation(String formName)
throws ARException
Escalation objects that is associated with the given form
formName - the name of the form that is associated with the escalation
ARException
public List<String> getListEscalation(long changedSince)
throws ARException
Escalation objects that is modified after the specified timestamp
changedSince - A timestamp that limits escalations retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.
ARException
public List<String> getListEscalation(String formName,
long changedSince)
throws ARException
Escalation objects that is associated with the given form and
modified after the specified timestamp.
formName - the name of the form that is associated with the escalationchangedSince - A timestamp that limits escalations retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.
ARException
public List<String> getListEscalation(String formName,
long changedSince,
ObjectPropertyMap propsToSearch)
throws ARException
Escalation objects that match the given criteria
formName - the name of the form that is associated with the escalationchangedSince - A timestamp that limits escalations retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.propsToSearch - A list of object properties to search for. Returns all escalations that match the object properties.
ARException - if list is not returned
public List<Escalation> getListEscalationObjects(String formName,
long changedSince,
EscalationCriteria criteria)
throws ARException
Escalation objects that match the given criteria.
formName - the name of the form that is associated with the escalationchangedSince - A timestamp that limits escalations retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.criteria - the attribute returned for each escalation object
ARException - if information is not returned
public void createEscalation(Escalation object)
throws ARException
Escalation object into AR System server.
ARException - if object is not created
public void deleteEscalation(String name,
int deleteOption)
throws ARException
deleteOption - deleteOption is a bitmask value indicating the action to take. The values are:
Constants.AR_DEFAULT_DELETE_OPTION: server object default delete option. For locked
objects, fails the delete attempt.
Constants.AR_LOCK_BLOCK_DELETE: Delete escalation and all objects in the block.
ARException - if object is not deleted
public void setEscalation(Escalation object)
throws ARException
Escalation object on ARSystem server
object - the escalation to be updated
ARException - if object is not saved
public List<EntryPointInfo> getListEntryPoint(long changedSince,
List<String> applicationKeys,
int[] refTypes,
int viewType,
String displayTag,
boolean hiddenFlag)
throws ARException
changedSince - A timestamp that limits entry pointer retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve filters with any modification timestamp.applicationKeys - the names of a list of application that contains the entry pointrefTypes - a list of reference typeviewType - the type of view to retrieve. Specify null for this parameter if you do not want to retrieve the view
name. the type can be:
Constants.AR_VUI_TYPE_NONE no view type.
Constants.AR_VUI_TYPE_WINDOWS Windows type, fields in BMC Remedy User.
Constants.AR_VUI_TYPE_WEB Web relative type, fields in view can be adjusted.
Constants.AR_VUI_TYPE_WEB_ABS_POS Web absolute type, fields in view are fixed.
displayTag - the name of the form view to use for the entry point label. if the specified view does not exist or
you specify null for this parameter, the ARSystem uses default view instead.hiddenFlag - a flag indicate if retrieve both visible and hidden entry point.
ARException
public ServerInfoMap getServerInfo(int[] requestList)
throws ARException
Server Options Whose Values Can Be Retrieved
AR_SERVER_INFO_EXPORT_VERSION integer indicates the
server's export version number. This setting allows you to set the export version for object definitions of the
server to ensure compatibility with older clients.
AR_SERVER_INFO_ALLOW_GUESTS flag indicates whether the
server accepts guest users. Guest users are users not registered with the AR System. If allowed, guest users have
no permissions but are allowed to perform some basic operations. Guest users can submit entries to forms for
which permission has been given to the Public group and enter data in fields that have been defined as allowing
any user to submit. If not allowed, unregistered users have no access to the system. Valid values for this option
are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow guest users).
AR_SERVER_INFO_USE_ETC_PASSWD flag indicates whether the
/etc/passwd file is used to validate users not registered with the AR System (UNIX® only). If so,
users in /etc/passwd are considered valid users of the AR System and are assigned to a group identified by the
UNIX group ID. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (use password
file).
AR_SERVER_INFO_XREF_PASSWORDS flag indicates whether the
/etc/passwd file is cross-referenced if an AR System user has no password (UNIX only). This option enables you to
manage group membership and other support information by using the AR System but still manage passwords using the
/etc/passwd file. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 0 (blank
passwords are not cross referenced).
AR_SERVER_INFO_DEBUG_MODE mask indicates the server debug
modes.
AR_SERVER_INFO_SQL_LOG_FILE).
AR_SERVER_INFO_FILTER_LOG_FILE).
AR_SERVER_INFO_USER_LOG_FILE).
AR_SERVER_INFO_ESCALATION_LOG_FILE).
AR_SERVER_INFO_API_LOG_FILE).
AR_SERVER_INFO_THREAD_LOG_FILE).
AR_SERVER_INFO_CACHE_LOG_FILE).
AR_SERVER_INFO_DS_LOG_FILE).
AR_SERVER_INFO_DB_PASSWORD is the database password associated
with the AR System database or tablespace (applicable to Sybase and Oracle® databases only). The
password is stored in encrypted form.
AR_SERVER_INFO_ACTLINK_DIR is the name of a directory where all
external processes to be run by active links must reside. If the value is NULL, active links can run processes
located anywhere.
AR_SERVER_INFO_ACTLINK_SHELL is the name of a shell to use
when running external processes from an active link. If the value is NULL, processes are run from /bin/sh (UNIX)
or without a shell (Windows).
AR_SERVER_INFO_USER_CACHE_UTILS is the flag indicating
whether the ARCACHE and ARRELOAD utilities are enabled. Valid values for this option are 0 (disabled) and 1
(enabled).
AR_SERVER_INFO_SET_PROC_TIME is the number of seconds the
server waits before ending a set fields process that has not completed. Valid values for this option are 1
through 20. The default value is five seconds.
AR_SERVER_INFO_EMAIL_FROM is the sender name to use for
filter-generated email notifications where no subject is specified. Only "trusted" email users can use this name
(see the Remedy Email Engine Guide for more information about trusted email users).
AR_SERVER_INFO_SQL_LOG_FILE is the The name of the file to use
if SQL tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_FLOAT_TIMEOUT is the number of hours the server
waits before disconnecting inactive users. If a user is holding a floating write license token, the system also
frees the token at this time.
AR_SERVER_INFO_UNQUAL_QUERIES is the flag indicating whether
the server allows unqualified queries. Unqualified queries are calls in which the qualifier parameter is either
NULL or has an operation value of 0 (AR_COND_OP_NONE). These queries can cause
performance problems, especially for large forms, because they return all entries for a given form. If not
allowed, you can return all form entries by specifying a "dummy" qualification such as 1 = 1. Valid values for
this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow unqualified queries).
AR_SERVER_INFO_UNQUAL_QUERIES is the name of the file to use
if filter tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_USER_LOG_FILE is the name of the file to use if
user tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_MAX_ENTRIES is the maximum number of entries
returned by a single query. Because users can also specify the maximum number of entries returned (in query
preferences), the actual maximum is the lower of these two values. The default value is no (server-defined)
maximum.
AR_SERVER_INFO_ESCALATION_LOG_FILE is the name of the
file to use if escalation tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_SUBMITTER_MODE is the value indicating whether
the Submitter field can be changed and whether the submitter of an entry must have a license to modify it. In
locked mode, the Submitter field cannot be changed after submit, and the submitter with or a read or a write
license, but not with a restricted read license, can modify the entry (if the Submitter group has Change
permission). In changeable mode, the Submitter field can be changed after submit, but the submitter must have a
write license to modify the entry (if the Submitter group has Change permission). Valid values for this option
are 1 (locked) and 2 (changeable). The default value is 2 (changeable).
AR_SERVER_INFO_API_LOG_FILE is the name of the file to use if
API tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_FTEXT_TIMEOUT is the number of hours the server
waits before disconnecting inactive users with Full Text Search licenses. If a user is holding a floating Full
Text Search license token, the system also frees the token at this time.
AR_SERVER_INFO_DS_RPC_SOCKET is the specific server socket to
use for the distributed server. Valid values for this option are 390600 and 390680 through 390694. Any other
value causes the distributed server to use the default server.
AR_SERVER_INFO_DS_LOG_FILE is the name of the file to use if
distributed server tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_SUPPRESS_WARN is a series of zero or more
message numbers (separated by spaces) that identify the informational or warning messages that the system
suppresses.
AR_SERVER_INFO_SAVE_LOGIN is a value indicating whether users
must log in to client tools.
AR_SERVER_INFO_ADMIN_ONLY is a flag indicating whether the server
is in Administrator Only mode (1) or not (0). When not in Administrator Only mode, subadministrators can also
perform administrator duties. The default value is 0 (Not in Administrator Only mode).
AR_SERVER_INFO_FLASH_DAEMON is a flag indicating whether
Flashboards is installed (1) or not (0). The default value is 1 if the server has one or more Flashboards
licenses, and 0 if the server has no licenses.
AR_SERVER_INFO_THREAD_LOG_FILE is the name of the file to
use if thread tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE)
(Windows only).
AR_SERVER_INFO_TCD_TCP_PORT is the TCP port that the AR System
server will use.
AR_SERVER_INFO_DSO_DEST_PORT is the TCP port that the
distributed server option uses to communicate with the AR System server.
AR_SERVER_INFO_NFY_TCP_PORT is the TCP port that the Notifier
server will use.
AR_SERVER_INFO_FILT_MAX_TOTAL is the maximum number of
filters that the server will execute for a given operation. The default value is 10000.
AR_SERVER_INFO_FILT_MAX_STACK is the maximum number of levels
of recursion allowed for a given operation. The data modification performed by an
AR_FILTER_ACTION_FIELDP filter action could trigger a second set, or
level, of filters, one of which could trigger filters a third level down and so on. This option limits the number
of times such recursion can happen, preventing the server crash that would occur if the recursion continued
indefinitely. The default value is 25.
AR_SERVER_INFO_DEFAULT_ORDER_BY is an integer (1 or 0)
indicating the default order of requests in a form when issuing getListEntry calls, so that the sorting is done
on the database and before the results are returned. Valid values for this option are 0 (no sort order) or 1 (use
EntryId order). The default value is 1.
AR_SERVER_INFO_DELAYED_CACHE is a flag indicating whether to
disable recacheing of the shared cache after a time-out (1) or not (0). The default value is 0 (delayed recache
not disabled).
AR_SERVER_INFO_DSO_MERGE_STYLE is an integer (1 or 0)
indicating the merge style to use for the Distributed Server Option. A 0 indicates the new style; 1 indicates the
old style. The default is 0. For a 1 value (old style), the merge style overwrites entries; for a 0 value (new
style), a true merge is performed according to the rules of the Distributed Server Option setup. For backward
compatibility, this server option can be set to 1.
AR_SERVER_INFO_EMAIL_LINE_LEN is the maximum line length of
email messages.
AR_SERVER_INFO_EMAIL_SYSTEM is a character string that
indicates the email system on UNIX.
AR_SERVER_INFO_INFORMIX_RELAY_MOD is a character string
that indicates the Informix relay module.
AR_SERVER_INFO_EMAIL_LINE_LEN is the RPC program number and
port pairs the Private Servers will use. A value of 0 for the port means no port was specified.
AR_SERVER_INFO_REGISTER_PORTMAPPER is a flag indicating
whether to register with the portmapper (1) or not (0). The default value is 1.
AR_SERVER_INFO_SERVER_NAME is an alias server name that is
always interpreted as the current server. The name is not fully qualified. For example, the server alpha.bmc.com
would have the value alpha. See also "Server-Name" in ar.conf.
AR_SERVER_INFO_DBCONF is the complete contents of the db.conf
(ardb.cfg) file.
AR_SERVER_INFO_AP_RPC_SOCKET is the RPC program number the
approval server will use when contacting the AR System. This allows you to define a specific AR System server for
private use by the approval server.
AR_SERVER_INFO_AP_LOG_FILE is the name of the file to use if
approval tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_AP_DEFN_CHECK is the length of time in seconds
between checks by an application service to verify that definitions it is using from the AR System are correct.
The value can be from 0 to 3600 seconds (1 hour). A value of 0 means to check definitions with each command. A
larger value means a slight delay in recognizing changes to some definition, while a smaller value means the
significant overhead of checking the definitions often. The default value is 300 seconds (5 minutes).
AR_SERVER_INFO_MAX_LOG_FILE_SIZE is the maximum size for
system log files. The default value is 0 (no limit).
AR_SERVER_INFO_CLUSTERED_INDEX is a value that indicates
whether a clustered index is created on the Entry-Id field when a new form is created. Valid values for this
option are 1 (create a clustered index) and 0 (create a unique index). The default value is 1 (clustered), but
you can override this in the ar.cfg/ar.conf file.
AR_SERVER_INFO_EMAIL_TIMEOUT is the length of time
in seconds before the system closes the pipe to sendmail to unblock the AR System server. Valid values for this
option are from 1 to 300. The default value is 10.
AR_SERVER_INFO_SCC_ENABLED is a value indicating whether a
source code control system is being used with the AR System. A 0 value (default) means a source code control
system is not present.
AR_SERVER_INFO_SCC_PROVIDER_NAME is a character string for
the source code control system provider name. If none is present, this value is NULL. This string is limited to
255 characters.
AR_SERVER_INFO_SCC_TARGET_DIR is a character string for the
source code control system target directory. If none is present, this value is NULL. This string is limited to
255 characters.
AR_SERVER_INFO_SCC_COMMENT_CHECKIN is an integer (0 or
1) value indicating whether or not a source code control integration requires you to entire a comment at checkin
time. A 0 value means no comment is required.
AR_SERVER_INFO_SCC_COMMENT_CHECKOUT is an integer (0 or
1) value indicating whether or not a source code control integration requires you to entire a comment at checkout
time. A 0 value means no comment is required.
AR_SERVER_INFO_SCC_INTEGRATION_MODE is an integer (0 or
1) value indicating the level of source code control integration. A 0 (the default) value indicates an advisory
level of integration, which means you can modify and save an object without having it checked out from the source
code control application. A 1 value means enforced integration, which has strict rules for controlling source
files (for example, enforced integration means that other administrators will not be able to modify and save
changes on an object that you have checked out).integration, which has strict rules for controlling source files
(for example, enforced integration means that other administrators will not be able to modify and save changes on
an object that you have checked out).
AR_SERVER_INFO_EA_RPC_SOCKET is the RPC socket number on which
an external authentication server awaits requests for authentication. A 0 value means external authentication
will not be used. This attribute persists in the ar.cfg/ar.conf file. The default value is 0.
AR_SERVER_INFO_EA_RPC_TIMEOUT is the RPC timeout (seconds)
used when making calls to the authentication (AREA) server (for example, 30 seconds). This attribute persists in
the ar.cfg/ ar.conf file. The default value is 30 seconds.
AR_SERVER_INFO_EA_SYNC_TIMEOUT is the internal (seconds) the
AR System server uses to periodically invoke the external authentication server's AREANeedToSyncCallback()
function, which instructs the AR System server to renew its internally stored user information in the event there
are changes made to the source used to authenticate users. A 0 value means that the AR System server will not
invoke the call to the external authentication (AREA) server. This attribute persists in the ar.cfg/ ar.conf
file. The default value is 300 seconds.
AR_SERVER_INFO_LOGFILE_APPEND is an integer (0/1) value that
indicates whether to create a separate*.bak file or to append to the existing log file. A 0 value creates a *.bak
file; 1 indicates that new log information be appended to the existing file.
AR_SERVER_INFO_MINIMUM_API_VER is a value indicating the
minimum API version that the server supports. The API versions are:
Server Options Whose Values Can Be Read But Not Set
AR_SERVER_INFO_DB_TYPE is the underlying database type (character
string).
AR_SERVER_INFO_SERVER_LICENSE is the server license type
(character string).
AR_SERVER_INFO_FIXED_LICENSE is the number of fixed user
licenses (int).
AR_SERVER_INFO_VERSION is the AR System server version (character
string).
AR_SERVER_INFO_DB_NAME is the name of the underlying SQL database
(not applicable for Oracle databases). The default value is ARSystem.
AR_SERVER_INFO_HARDWARE is the server hardware type (character
string).
AR_SERVER_INFO_OS is a character string that indicates the server
operating system which includes the version number.
AR_SERVER_INFO_SERVER_DIR is the data directory for the AR
System. This directory contains support files for the underlying SQL database (but no actual database files).
AR_SERVER_INFO_DBHOME_DIR is the home directory for the
underlying SQL database.
AR_SERVER_INFO_FLOAT_LICENSE is the number of floating write
licenses defined.
AR_SERVER_INFO_REM_SERV_ID is the AR System server ID associated
with the license (character string).
AR_SERVER_INFO_MULTI_SERVER is an integer (0/1) value
indicating the use of the multi-server option. A 0 value indicates a single server; a 1 value indicates the use
of the multi-server option.
AR_SERVER_INFO_EMBEDDED_SQL is a value indicating whether the
underlying SQL database is embedded (bundled with the Action Request System). Valid values for this option are 0
(not embedded) and 1 (embedded).
AR_SERVER_INFO_MAX_SCHEMAS is the maximum number of forms
allowed. The default value is 0 (no limit).
AR_SERVER_INFO_DB_VERSION is the underlying database version
(character string).
AR_SERVER_INFO_FTEXT_FIXED is the number of fixed Full Text
Search licenses defined.
AR_SERVER_INFO_FTEXT_FLOAT is the number of floating Full Text
Search licenses defined.
AR_SERVER_INFO_SERVER_IDENT is the unique identifier for the
server (character string).
AR_SERVER_INFO_DS_SVR_LICENSE is the Distributed Server
Option license type (character string).
AR_SERVER_INFO_DS_MAPPING is the name of the form that contains
distributed mapping definitions (applicable for Distributed Server Option only).
AR_SERVER_INFO_DS_PENDING is the name of the form that contains
the pending operation list (applicable for Distributed Server Option only).
AR_SERVER_INFO_HOSTNAME is the host name of the server ("shorti"
machine name).
AR_SERVER_INFO_FULL_HOSTNAME is the full DNS host name of the
server ("long" machine name).
AR_SERVER_INFO_U_CACHE_CHANGE is the time of the last change
to the user cache.
AR_SERVER_INFO_G_CACHE_CHANGE is the time of the last change
to the group cache.
AR_SERVER_INFO_STRUCT_CHANGE is the last structure change (for
this run of the server).Int.
AR_SERVER_INFO_CASE_SENSITIVE is a value indicating whether
the underlying database is case-sensitive. Valid values for this option are 0 (case-sensitive) and 1
(case-insensitive). The default value is 1 (case-insensitive).
AR_SERVER_INFO_SERVER_LANG is the local language setting of the
server.
AR_SERVER_INFO_INFORMIX_DBN is the Informix database server
name. This option has a value only if you are using an Informix database.
AR_SERVER_INFO_INFORMIX_TBC is the Informix configuration file.
This option has a value only if you are using an Informix database. The default value is onconfig.
AR_SERVER_INFO_ORACLE_SID is the System ID of the Oracle database
you are accessing. This option has a value only if you are using an Oracle database.
AR_SERVER_INFO_ORACLE_TWO_T is the two-task environment setting
for remote access to an Oracle database. This option has a value only if you are using an Oracle database.
AR_SERVER_INFO_SYBASE_CHARSET is the character set being used
to access a Sybase database. This option has a value only if you are using a Sybase database.
AR_SERVER_INFO_SYBASE_SERV is the Sybase logical server name.
This option has a value only if you are using a Sybase database. The default value is SYBASE.
AR_SERVER_INFO_SHARED_MEM is a flag indicating
whether the shared memory is disabled or enabled. Valid values for this option are 1 (shared memory enabled) and
0 (shared memory disabled).
AR_SERVER_INFO_DB_USER is the user name the Action Request System
uses to access the underlying database.
AR_SERVER_INFO_APPL_PENDING is the name of the form that
contains the pending list of application commands to be processed. This form is specific to the use of
Application-Commands.
AR_SERVER_INFO_SERVER_TIME is the AR System server time.
ARException - if configuration information is not returned
public void setServerInfo(ServerInfoMap serverInfoMap)
throws ARException
Server Options Whose Values Can Be Retrieved
AR_SERVER_INFO_EXPORT_VERSION integer indicates the
server's export version number. This setting allows you to set the export version for object definitions of the
server to ensure compatibility with older clients.
AR_SERVER_INFO_ALLOW_GUESTS flag indicates whether the
server accepts guest users. Guest users are users not registered with the AR System. If allowed, guest users have
no permissions but are allowed to perform some basic operations. Guest users can submit entries to forms for
which permission has been given to the Public group and enter data in fields that have been defined as allowing
any user to submit. If not allowed, unregistered users have no access to the system. Valid values for this option
are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow guest users).
AR_SERVER_INFO_USE_ETC_PASSWD flag indicates whether the
/etc/passwd file is used to validate users not registered with the AR System (UNIX only). If so, users in
/etc/passwd are considered valid users of the AR System and are assigned to a group identified by the UNIX group
ID. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (use password file).
AR_SERVER_INFO_XREF_PASSWORDS flag indicates whether the
/etc/passwd file is cross-referenced if an AR System user has no password (UNIX only). This option enables you to
manage group membership and other support information by using the AR System but still manage passwords using the
/etc/passwd file. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 0 (blank
passwords are not cross referenced).
AR_SERVER_INFO_DEBUG_MODE mask indicates the server debug
modes.
AR_SERVER_INFO_SQL_LOG_FILE).
AR_SERVER_INFO_FILTER_LOG_FILE).
AR_SERVER_INFO_USER_LOG_FILE).
AR_SERVER_INFO_ESCALATION_LOG_FILE).
AR_SERVER_INFO_API_LOG_FILE).
AR_SERVER_INFO_THREAD_LOG_FILE).
AR_SERVER_INFO_CACHE_LOG_FILE).
AR_SERVER_INFO_DS_LOG_FILE).
AR_SERVER_INFO_DB_PASSWORD is the database password associated
with the AR System database or tablespace (applicable to Sybase and Oracle databases only). The password is
stored in encrypted form.
AR_SERVER_INFO_ACTLINK_DIR is the name of a directory where all
external processes to be run by active links must reside. If the value is NULL, active links can run processes
located anywhere.
AR_SERVER_INFO_ACTLINK_SHELL is the name of a shell to use
when running external processes from an active link. If the value is NULL, processes are run from /bin/sh (UNIX)
or without a shell (Windows).
AR_SERVER_INFO_USER_CACHE_UTILS is the flag indicating
whether the ARCACHE and ARRELOAD utilities are enabled. Valid values for this option are 0 (disabled) and 1
(enabled).
AR_SERVER_INFO_SET_PROC_TIME is the number of seconds the
server waits before ending a set fields process that has not completed. Valid values for this option are 1
through 20. The default value is five seconds.
AR_SERVER_INFO_EMAIL_FROM is the sender name to use for
filter-generated email notifications where no subject is specified. Only "trusted" email users can use this name
(see the Remedy Email Engine Guide for more information about trusted email users).
AR_SERVER_INFO_SQL_LOG_FILE is the The name of the file to use
if SQL tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_FLOAT_TIMEOUT is the number of hours the server
waits before disconnecting inactive users. If a user is holding a floating write license token, the system also
frees the token at this time.
AR_SERVER_INFO_UNQUAL_QUERIES is the flag indicating whether
the server allows unqualified queries. Unqualified queries are calls in which the qualifier parameter is either
NULL or has an operation value of 0 (AR_COND_OP_NONE). These queries can cause
performance problems, especially for large forms, because they return all entries for a given form. If not
allowed, you can return all form entries by specifying a "dummy" qualification such as 1 = 1. Valid values for
this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow unqualified queries).
AR_SERVER_INFO_UNQUAL_QUERIES is the name of the file to use
if filter tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_USER_LOG_FILE is the name of the file to use if
user tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_MAX_ENTRIES is the maximum number of entries
returned by a single query. Because users can also specify the maximum number of entries returned (in query
preferences), the actual maximum is the lower of these two values. The default value is no (server-defined)
maximum.
AR_SERVER_INFO_ESCALATION_LOG_FILE is the name of the
file to use if escalation tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_SUBMITTER_MODE is the value indicating whether
the Submitter field can be changed and whether the submitter of an entry must have a license to modify it. In
locked mode, the Submitter field cannot be changed after submit, and the submitter with or a read or a write
license, but not with a restricted read license, can modify the entry (if the Submitter group has Change
permission). In changeable mode, the Submitter field can be changed after submit, but the submitter must have a
write license to modify the entry (if the Submitter group has Change permission). Valid values for this option
are 1 (locked) and 2 (changeable). The default value is 2 (changeable).
AR_SERVER_INFO_API_LOG_FILE is the name of the file to use if
API tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_FTEXT_TIMEOUT is the number of hours the server
waits before disconnecting inactive users with Full Text Search licenses. If a user is holding a floating Full
Text Search license token, the system also frees the token at this time.
AR_SERVER_INFO_DS_RPC_SOCKET is the specific server socket to
use for the distributed server. Valid values for this option are 390600 and 390680 through 390694. Any other
value causes the distributed server to use the default server.
AR_SERVER_INFO_DS_LOG_FILE is the name of the file to use if
distributed server tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_SUPPRESS_WARN is a series of zero or more
message numbers (separated by spaces) that identify the informational or warning messages that the system
suppresses.
AR_SERVER_INFO_SAVE_LOGIN is a value indicating whether users
must log in to client tools.
AR_SERVER_INFO_ADMIN_ONLY is a flag indicating whether the server
is in Administrator Only mode (1) or not (0). When not in Administrator Only mode, subadministrators can also
perform administrator duties. The default value is 0 (Not in Administrator Only mode).
AR_SERVER_INFO_THREAD_LOG_FILE is the name of the file to
use if thread tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE)
(Windows only).
AR_SERVER_INFO_TCD_TCP_PORT is the TCP port that the AR System
server will use.
AR_SERVER_INFO_DSO_DEST_PORT is the TCP port that the
distributed server option uses to communicate with the AR System server.
AR_SERVER_INFO_NFY_TCP_PORT is the TCP port that the Notifier
server will use.
AR_SERVER_INFO_FILT_MAX_TOTAL is the maximum number of
filters that the server will execute for a given operation. The default value is 10000.
AR_SERVER_INFO_FILT_MAX_STACK is the maximum number of levels
of recursion allowed for a given operation. The data modification performed by an
AR_FILTER_ACTION_FIELDP filter action could trigger a second set, or
level, of filters, one of which could trigger filters a third level down and so on. This option limits the number
of times such recursion can happen, preventing the server crash that would occur if the recursion continued
indefinitely. The default value is 25.
AR_SERVER_INFO_DEFAULT_ORDER_BY is an integer (1 or 0)
indicating the default order of requests in a form when issuing getListEntry calls, so that the sorting is done
on the database and before the results are returned. Valid values for this option are 0 (no sort order) or 1 (use
EntryId order). The default value is 1.
AR_SERVER_INFO_DELAYED_CACHE is a flag indicating whether to
disable recacheing of the shared cache after a time-out (1) or not (0). The default value is 0 (delayed recache
not disabled).
AR_SERVER_INFO_DSO_MERGE_STYLE is an integer (1 or 0)
indicating the merge style to use for the Distributed Server Option. A 0 indicates the new style; 1 indicates the
old style. The default is 0. For a 1 value (old style), the merge style overwrites entries; for a 0 value (new
style), a true merge is performed according to the rules of the Distributed Server Option setup. For backward
compatibility, this server option can be set to 1.
AR_SERVER_INFO_EMAIL_LINE_LEN is the maximum line length of
email messages.
AR_SERVER_INFO_EMAIL_SYSTEM is a character string that
indicates the email system on UNIX.
AR_SERVER_INFO_INFORMIX_RELAY_MOD is a character string
that indicates the Informix relay module.
AR_SERVER_INFO_EMAIL_LINE_LEN is the RPC program number and
port pairs the Private Servers will use. A value of 0 for the port means no port was specified.
AR_SERVER_INFO_REGISTER_PORTMAPPER is a flag indicating
whether to register with the portmapper (1) or not (0). The default value is 1.
AR_SERVER_INFO_SERVER_NAME is an alias server name that is
always interpreted as the current server. The name is not fully qualified. For example, the server alpha.bmc.com
would have the value alpha. See also "Server-Name" in ar.conf.
AR_SERVER_INFO_DBCONF is the complete contents of the db.conf
(ardb.cfg) file.
AR_SERVER_INFO_AP_RPC_SOCKET is the RPC program number the
approval server will use when contacting the AR System. This allows you to define a specific AR System server for
private use by the approval server.
AR_SERVER_INFO_AP_LOG_FILE is the name of the file to use if
approval tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
AR_SERVER_INFO_AP_DEFN_CHECK is the length of time in seconds
between checks by an application service to verify that definitions it is using from the AR System are correct.
The value can be from 0 to 3600 seconds (1 hour). A value of 0 means to check definitions with each command. A
larger value means a slight delay in recognizing changes to some definition, while a smaller value means the
significant overhead of checking the definitions often. The default value is 300 seconds (5 minutes).
AR_SERVER_INFO_MAX_LOG_FILE_SIZE is the maximum size for
system log files. The default value is 0 (no limit).
AR_SERVER_INFO_CLUSTERED_INDEX is a value that indicates
whether a clustered index is created on the Entry-Id field when a new form is created. Valid values for this
option are 1 (create a clustered index) and 0 (create a unique index). The default value is 1 (clustered), but
you can override this in the ar.cfg/ar.conf file.
AR_SERVER_INFO_EMAIL_TIMEOUT is the length of time
in seconds before the system closes the pipe to sendmail to unblock the AR System server. Valid values for this
option are from 1 to 300. The default value is 10.
AR_SERVER_INFO_SCC_ENABLED is a value indicating whether a
source code control system is being used with the AR System. A 0 value (default) means a source code control
system is not present.
AR_SERVER_INFO_SCC_PROVIDER_NAME is a character string for
the source code control system provider name. If none is present, this value is NULL. This string is limited to
255 characters.
AR_SERVER_INFO_SCC_TARGET_DIR is a character string for the
source code control system target directory. If none is present, this value is NULL. This string is limited to
255 characters.
AR_SERVER_INFO_SCC_COMMENT_CHECKIN is an integer (0 or
1) value indicating whether or not a source code control integration requires you to entire a comment at checkin
time. A 0 value means no comment is required.
AR_SERVER_INFO_SCC_COMMENT_CHECKOUT is an integer (0 or
1) value indicating whether or not a source code control integration requires you to entire a comment at checkout
time. A 0 value means no comment is required.
AR_SERVER_INFO_SCC_INTEGRATION_MODE is an integer (0 or
1) value indicating the level of source code control integration. A 0 (the default) value indicates an advisory
level of integration, which means you can modify and save an object without having it checked out from the source
code control application. A 1 value means enforced integration, which has strict rules for controlling source
files (for example, enforced integration means that other administrators will not be able to modify and save
changes on an object that you have checked out).integration, which has strict rules for controlling source files
(for example, enforced integration means that other administrators will not be able to modify and save changes on
an object that you have checked out).
AR_SERVER_INFO_EA_RPC_SOCKET is the RPC socket number on which
an external authentication server awaits requests for authentication. A 0 value means external authentication
will not be used. This attribute persists in the ar.cfg/ar.conf file. The default value is 0.
AR_SERVER_INFO_EA_RPC_TIMEOUT is the RPC timeout (seconds)
used when making calls to the authentication (AREA) server (for example, 30 seconds). This attribute persists in
the ar.cfg/ ar.conf file. The default value is 30 seconds.
AR_SERVER_INFO_EA_SYNC_TIMEOUT is the internal (seconds) the
AR server uses to periodically invoke the external authentication server's AREANeedToSyncCallback() function,
which instructs the AR System server to renew its internally stored user information in the event there are
changes made to the source used to authenticate users. A 0 value means that the AR System server will not invoke
the call to the external authentication (AREA) server. This attribute persists in the ar.cfg/ ar.conf file. The
default value is 300 seconds.
AR_SERVER_INFO_LOGFILE_APPEND is an integer (0/1) value that
indicates whether to create a separate*.bak file or to append to the existing log file. A 0 value creates a *.bak
file; 1 indicates that new log information be appended to the existing file.
AR_SERVER_INFO_MINIMUM_API_VER is a value indicating the
minimum API version that the server supports. The API versions are:
Server Options Whose Values Can Be Read But Not Set
AR_SERVER_INFO_DB_TYPE is the underlying database type (character
string).
AR_SERVER_INFO_SERVER_LICENSE is the server license type
(character string).
AR_SERVER_INFO_FIXED_LICENSE is the number of fixed user
licenses (int).
AR_SERVER_INFO_VERSION is the AR System server version (character
string).
AR_SERVER_INFO_DB_NAME is the name of the underlying SQL database
(not applicable for Oracle databases). The default value is ARSystem.
AR_SERVER_INFO_HARDWARE is the server hardware type (character
string).
AR_SERVER_INFO_OS is a character string that indicates the server
operating system which includes the version number.
AR_SERVER_INFO_SERVER_DIR is the data directory for the AR
System. This directory contains support files for the underlying SQL database (but no actual database files).
AR_SERVER_INFO_DBHOME_DIR is the home directory for the
underlying SQL database.
AR_SERVER_INFO_FLOAT_LICENSE is the number of floating write
licenses defined.
AR_SERVER_INFO_REM_SERV_ID is the AR System server ID associated
with the license (character string).
AR_SERVER_INFO_MULTI_SERVER is an integer (0/1) value
indicating the use of the multi-server option. A 0 value indicates a single server; a 1 value indicates the use
of the multi-server option.
AR_SERVER_INFO_EMBEDDED_SQL is a value indicating whether the
underlying SQL database is embedded (bundled with the Action Request System). Valid values for this option are 0
(not embedded) and 1 (embedded).
AR_SERVER_INFO_MAX_SCHEMAS is the maximum number of forms
allowed. The default value is 0 (no limit).
AR_SERVER_INFO_DB_VERSION is the underlying database version
(character string).
AR_SERVER_INFO_FTEXT_FIXED is the number of fixed Full Text
Search licenses defined.
AR_SERVER_INFO_FTEXT_FLOAT is the number of floating Full Text
Search licenses defined.
AR_SERVER_INFO_SERVER_IDENT is the unique identifier for the
server (character string).
AR_SERVER_INFO_DS_SVR_LICENSE is the Distributed Server
Option license type (character string).
AR_SERVER_INFO_DS_MAPPING is the name of the form that contains
distributed mapping definitions (applicable for Distributed Server Option only).
AR_SERVER_INFO_DS_PENDING is the name of the form that contains
the pending operation list (applicable for Distributed Server Option only).
AR_SERVER_INFO_HOSTNAME is the host name of the server ("short"
machine name).
AR_SERVER_INFO_FULL_HOSTNAME is the full DNS host name of the
server ("long" machine name).
AR_SERVER_INFO_U_CACHE_CHANGE is the time of the last change
to the user cache.
AR_SERVER_INFO_G_CACHE_CHANGE is the time of the last change
to the group cache.
AR_SERVER_INFO_STRUCT_CHANGE is the last structure change (for
this run of the server).Int.
AR_SERVER_INFO_CASE_SENSITIVE is a value indicating whether
the underlying database is case-sensitive. Valid values for this option are 0 (case-sensitive) and 1
(case-insensitive). The default value is 1 (case-insensitive).
AR_SERVER_INFO_SERVER_LANG is the local language setting of the
server.
AR_SERVER_INFO_INFORMIX_DBN is the Informix database server
name. This option has a value only if you are using an Informix database.
AR_SERVER_INFO_INFORMIX_TBC is the Informix configuration file.
This option has a value only if you are using an Informix database. The default value is onconfig.
AR_SERVER_INFO_ORACLE_SID is the System ID of the Oracle database
you are accessing. This option has a value only if you are using an Oracle database.
AR_SERVER_INFO_ORACLE_TWO_T is the two-task environment setting
for remote access to an Oracle database. This option has a value only if you are using an Oracle database.
AR_SERVER_INFO_SYBASE_CHARSET is the character set being used
to access a Sybase database. This option has a value only if you are using a Sybase database.
AR_SERVER_INFO_SYBASE_SERV is the Sybase logical server name.
This option has a value only if you are using a Sybase database. The default value is SYBASE.
AR_SERVER_INFO_SHARED_MEM is a flag indicating
whether the shared memory is disabled or enabled. Valid values for this option are 1 (shared memory enabled) and
0 (shared memory disabled).
AR_SERVER_INFO_DB_USER is the user name the Action Request System
uses to access the underlying database.
AR_SERVER_INFO_APPL_PENDING is the name of the form that
contains the pending list of application commands to be processed. This form is specific to the use of
Application-Commands.
AR_SERVER_INFO_SERVER_TIME is the AR System server time.
ARException - if configuration information is not updated
public ServerInfoMap getServerStatistics(int[] requestList)
throws ARException
Can be performed by all users.
requestList - Returns a list of one or more statistics. AR_SERVER_STAT_API_REQUESTS is the total number of API requests received. AR_SERVER_STAT_API_TIME is the total processor time spent
performing API function calls. AR_SERVER_STAT_BAD_PASSWORD is the total number of times an incorrect password was specified during
login. AR_SERVER_STAT_CACHE_TIME is the
total processor time spent loading the internal cache to improve performance. AR_SERVER_STAT_CPU is the total CPU time used by the server. AR_SERVER_STAT_CREATE_E_COUNT is the total
number of calls made to the ARCreateEntry function. AR_SERVER_STAT_CREATE_E_TIME is the total processor
time spent performing the ARCreateEntry function. AR_SERVER_STAT_CURRENT_USERS is the total number of
users currently accessing the system. AR_SERVER_STAT_DELETE_E_COUNT is the total number of calls made to the ARDeleteEntry function. AR_SERVER_STAT_DELETE_E_TIME is the total
processor time spent performing the ARDeleteEntry function. AR_SERVER_STAT_ENTRY_TIME is the total processor time
spent performing API function calls that manipulate entries. AR_SERVER_STAT_ESCL_DISABLE is the total number of
escalations that were evaluated but skipped because they were marked disabled. AR_SERVER_STAT_ESCL_FAILED is the total number of
escalations that were skipped (qualification criteria not met). AR_SERVER_STAT_ESCL_FIELDP is the total number of push
fields escalation actions performed. AR_SERVER_STAT_ESCL_FIELDS is the total number of set fields escalation actions performed. AR_SERVER_STAT_ESCL_LOG is the total number of log
escalation actions performed. AR_SERVER_STAT_ESCL_NOTIFY is the total number of notify escalation actions performed. AR_SERVER_STAT_ESCL_PASSED is the total number of
escalations that were executed (qualification criteria met). AR_SERVER_STAT_ESCL_PROCESS is the total number of run
process escalation actions performed. AR_SERVER_STAT_ESCL_SQL is the total number of direct SQL escalation actions performed. AR_SERVER_STAT_ESCL_TIME is the total processor time spent
checking and processing escalations. AR_SERVER_STAT_E_STATS_COUNT is the total number of calls made to the getEntryStatistics function.
AR_SERVER_STAT_E_STATS_TIME is the total
processor time spent performing the getEntryStatistics function. AR_SERVER_STAT_FILTER_DISABLE is the total number of
filters that were evaluated but skipped because they were marked disabled. AR_SERVER_STAT_FILTER_FAILED is the total number of
filters that were skipped (qualification criteria not met). AR_SERVER_STAT_FILTER_FIELDP is the total number of
push fields filter actions performed. AR_SERVER_STAT_FILTER_FIELDS is the total number of set fields filter actions performed. AR_SERVER_STAT_FILTER_LOG is the total number of
log filter actions performed. AR_SERVER_STAT_FILTER_MESSAGE is the total number of message filter actions performed. AR_SERVER_STAT_FILTER_NOTIFY is the total number of
notify filter actions performed. AR_SERVER_STAT_FILTER_PASSED is the total number of filters that were executed (qualification
criteria met). AR_SERVER_STAT_FILTER_PROCESS is the total number of run process filter actions performed. AR_SERVER_STAT_FILTER_SQL is the total number of
direct SQL filter actions performed. AR_SERVER_STAT_FILTER_TIME is the total processor time spent checking and processing filters. AR_SERVER_STAT_FTS_SRCH_COUNT is the total
number of Full Text Search operations performed. AR_SERVER_STAT_FTS_SRCH_TIME is the total processor
time spent performing Full Text Search operations. AR_SERVER_STAT_FULL_FIXED is the total number of connected
users with fixed Full Text Search licenses. AR_SERVER_STAT_FULL_FLOATING is the total number of
connected users with floating Full Text Search licenses. AR_SERVER_STAT_FULL_NONE is the total number of connected
users with no Full Text Search license. AR_SERVER_STAT_GETLIST_E_COUNT is the total number of calls made to the getListEntry function. AR_SERVER_STAT_GETLIST_E_TIME is the total
processor time spent performing the getListEntry function. AR_SERVER_STAT_GET_E_COUNT is the total number of calls
made to the getEntry function. AR_SERVER_STAT_GET_E_TIME is the total processor time spent performing the getEntry function. AR_SERVER_STAT_IDLE_TIME is the total idle time
when the server is not processing any requests. AR_SERVER_STAT_MERGE_E_COUNT is the total number of
calls made to the ARMergeEntry function. AR_SERVER_STAT_MERGE_E_TIME is the total processor time spent performing the ARMergeEntry function.
AR_SERVER_STAT_NET_RESP_TIME is the total
time spent on the network responding to the client. AR_SERVER_STAT_NO_FULL_TOKEN is the total number of
times a user tried to connect and no floating Full Text Search token was available. AR_SERVER_STAT_NO_WRITE_TOKEN is the total number of
times a user tried to connect and no floating write token was available. AR_SERVER_STAT_NUMBER_BLOCKED is the total number of
blocked processes. This statistic, in conjunction with the
AR_SERVER_STAT_TIMES_BLOCKED statistic, enables you to
determine the approximate number of processes being blocked per instance. For example, if
AR_SERVER_STAT_TIMES_BLOCKED is three and
AR_SERVER_STAT_NUMBER_BLOCKED is six, the six blocked
processes could be distributed in three possible ways: In this example, the blocked processes could
not be distributed as five in one instance, one in one instance, and none in one instance because, by
definition, the number of instances represents those times when at least one process is blocked. AR_SERVER_STAT_OTHER_TIME is the total processor
time spent performing API function calls that do not manipulate entries or restructure the database.
AR_SERVER_STAT_RESTRUCT_TIME is the total
processor time spent performing API function calls that restructure the database. AR_SERVER_STAT_SET_E_COUNT is the total number of calls
made to the setEntry function. AR_SERVER_STAT_SET_E_TIME is the total processor time spent performing the setEntry function. AR_SERVER_STAT_SINCE_START is the number of
seconds since the server was started (i.e. the total real time that the server process has been
running). AR_SERVER_STAT_SQL_DB_COUNT is
the total number of SQL commands sent to the database. AR_SERVER_STAT_SQL_DB_TIME is the total processor time
spent performing SQL commands. AR_SERVER_STAT_START_TIME is the UNIX® time at which this server was started. AR_SERVER_STAT_TIMES_BLOCKED is the total
number of instances in which at least one process was blocked by the current process. This statistic,
in conjunction with the AR_SERVER_STAT_NUMBER_BLOCKED
statistic enables you to determine the approximate number of processes being blocked per instance. AR_SERVER_STAT_WRITE_FIXED is the total number
of connected users with fixed write licenses. AR_SERVER_STAT_WRITE_FLOATING is the total number of
connected users with floating write licenses. AR_SERVER_STAT_WRITE_READ is the total number of connected
users with no write license.
ARException - if statistics are not returned
public int createSupportFile(SupportFile supportFile)
throws ARException,
IOException
ARException - if support file is not created
IOException
public void deleteSupportFile(SupportFileKey supportFileKey)
throws ARException
supportFileKey - the key info to locate a support file in ARSystem server
ARException - if support file is not deleted
public SupportFile getSupportFile(String associatedObjName,
int fileId)
throws ARException
associatedObjName - the name of the associated activelink objectfileId - the internal id of the support file
ARException - if support file is not loaded
public SupportFile getSupportFile(String associatedObjName,
int fileId,
String filePath)
throws ARException
associatedObjName - the name of the associated activelink objectfileId - the internal id of the support filefilePath - the path of the local file that stores the support file
ARException - if support file is not loaded
public SupportFile getSupportFile(String associatedObjName,
int fileId,
int fileType,
int supportingId,
String filePath)
throws ARException
associatedObjName - the name of the associated object. It can be a form or activelink.fileId - the internal id of the support filefileType - the type of the file. The value can be Constants.AR_SUPPORT_FILE_EXTERNAL_REPORT for an
external report file that is associated with an active linkssupportingId - the id of the file or view if the associated object is a form. If it is not a form, set this parameter
to 0.filePath - the path of the local file that stores the support file
ARException - if support file is not loaded
public void setSupportFile(SupportFile supportFile)
throws ARException
supportFile - the supportFile to be updated
ARException - if support file is not saved
public List<Integer> getListSupportFile(int fileType,
String associatedObjName,
int supportingId,
long changedSince)
throws ARException
fileType - the type of the file. The value can be Constants.AR_SUPPORT_FILE_EXTERNAL_REPORT for an
external report file that is associated with an active linksassociatedObjName - the name of the associated object. It can be a form or activelink.supportingId - the id of the file or view if the associated object is a form. If it is not a form, set this parameter
to 0.changedSince - A timestamp that limits support files retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve support files with any modification timestamp.
ARException
public List<SupportFile> getListSupportFileObjects(int fileType,
String associatedObjName,
int supportingId,
long changedSince)
throws ARException
SupportFile objects that match the given criteria, and the current user has privilege to the
specified objects
fileType - the type of the file. The value can be Constants.AR_SUPPORT_FILE_EXTERNAL_REPORT for an
external report file that is associated with an active linksassociatedObjName - the name of the associated object. It can be a form or activelink.supportingId - the id of the file or view if the associated object is a form. If it is not a form, set this parameter
to 0.changedSince - A timestamp that limits support files retrieved to those modified after the specified time. Specify 0
for this parameter to retrieve support files with any modification timestamp.
ARException
public List<String> getMultipleCurrencyRatioSets(List<Timestamp> ratioTimestamps)
throws ARException
ratioTimestamps - a set of timestamps that represent times to retrieve sets of ratios. Specify
Constants.AR_CURRENT_CURRENCY_RATIOS as a timestamp to retrieve a set of current ratios for
each conversion combination.
ARException
public List<GroupInfo> getListGroup(String user,
String password)
throws ARException
Group information for the current user can be retrieved by all users. Access to group information for other users is limited to users with AR System administrator privileges only.
user - the name of the user for which the system retrieves group informationpassword - the password of the user for which the system retrieves group infomation.
ARException - if list is not returned
public List<RoleInfo> getListRole(String application,
String user,
String password)
throws ARException
Role information for the current user can be retrieved by all users. Access to role information for other users is limited to users with AR System administrator privileges only.
application - the name of the specific application to get roles fromuser - the name of the user for whom the system retrieves role information. Specify null to retrieve all
roles for the application.password - the password of the user for whom the system retrieves role information.
ARException - if list is not returned
public List<UserInfo> getListUser()
throws ARException
Information about the current user can be retrieved by all users. Access to information about other users is limited to users with AR System administrator privileges only.
ARException - if list of users cannot be returned
public List<UserInfo> getListUser(int type)
throws ARException
Information about the current user can be retrieved by all users. Access to information about other users is limited to users with AR System administrator privileges only.
type - a value indicates the type of users to retrieve. The value can be:
AR_USER_LIST_MYSELF to retrieve the current
user. AR_USER_LIST_REGISTERED to retrieve
all registered users. AR_USER_LIST_CURRENT to
retrieve all users currently accessing the server.
ARException - if list of users cannot be returned
public List<UserInfo> getListUser(int type,
long changedSince)
throws ARException
Information about the current user can be retrieved by all users. Access to information about other users is limited to users with AR System administrator privileges only.
type - a value indicates the type of users to retrieve. The value can be:
AR_USER_LIST_MYSELF to retrieve the current
user. AR_USER_LIST_REGISTERED to retrieve
all registered users. AR_USER_LIST_CURRENT to
retrieve all users currently accessing the server.
changedSince - A time stamp that limits the users retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve users with any modification time stamp. This parameter is applicable only
when retrieving registered users (i.e. type parameter is specified as
AR_USER_LIST_REGISTERED).
ARException - if list is not returned
public List<String> getAllLocalHostIDs()
throws ARException
ARException
public List<String> getListApplicationState()
throws ARException
ARException - if information is not retrieved
public String getApplicationState(String applicationName)
throws ARException
applicationName - The name of the application
ARException - (subclass ARBulkException) if an error occurs
public void setApplicationState(String applicationName,
String newState)
throws ARException
applicationName - the name of the applicationnewState - Statet of the application. The value can be maintenance, test or production
ARException - (subclass ARBulkException) if an error occurs
public List<LicenseInfo> getListLicense(String licenseType)
throws ARException
LicenseInfo for the specified type.
licenseType - the type of licenses to retrieve. If the value of this argument is null, this method returns all type
of licenses that are available.
ARException - if list is not returned
public List<String> getListAlertUser()
throws ARException
ARException - if list is not returned
public String getTextForErrorMessage(int msgId)
throws ARException
AR_MAX_MESSAGE_SIZE (255 bytes). This operation can
be performed by all users.
msgId - Error number whose message text you want to retrieve.
ARException - if message text is not returned
public String getServerCharSet()
throws ARException
ARException - for any error in this operation
public void impersonateUser(String impersonatedUser)
throws ARException
impersonatedUser - the name of the user that the API is impersonating. Specify null if you want to stop impersonating.
ARException - if impersonation failed.public String getImpersonatedUser()
public long getImpersonatedCacheId()
public List<StatisticsResultInfo> getEntryStatistics(String formKey,
QualifierInfo qual,
ArithmeticOrRelationalOperand target,
int statistic,
int[] groupByList)
throws ARException
formKey - the name of the form to compute entry statistics forqual - the query that determines the set of entries to use.target - the arithmetic operation that defines the statistics to compute.statistic - a value indicate statistic type. the value can be:
AR_STAT_OP_COUNT for total number of matching
entries.
AR_STAT_OP_SUM for the sum of values for each group.
AR_STAT_OP_AVERAGE for the average value for each
group.
AR_STAT_OP_MINIMUM for the minimum value for each
group.
AR_STAT_OP_MAXIMUM for the maximum value for each
group.
groupByList - a list of fields to group the result by.
ARException - if statistic is not computed
public SQLResult getListSQL(String sqlCommand,
int maxRetrieve,
boolean retrieveTotalMatches)
throws ARException
Can be performed by users with AR System administrator privileges only.
sqlCommand - SQL command to execute (following the syntax rules for the underlying database). The owner of the AR
System server process must have permission to perform the specified SQL operation.maxRetrieve - Enter a boolean value of TRUE to retrieve the maximum number of rows.retrieveTotalMatches - Enter an integer value to limit the number of rows retrieved.
ARException - if list is not returned
public void registerForAlerts(int clientPort,
int registrationFlags)
throws ARException
clientPort - The client port number.registrationFlags - This value is reserved for future use and should be set to zero.
ARException
public void deregisterForAlerts(int clientPort)
throws ARException
clientPort - The client port number.
ARException - if client is not deregistered
public String createAlertEvent(String user,
String alertText,
int priority,
String sourceTag,
String server,
String formName,
String objectId)
throws ARException
user - The user who receives the alert. Specify * (AR_REGISTERED_BROADCAST) to create an alert
event for all users that are currently registered to receive alerts with the AR System server. You
cannot specify a group name for this argument.alertText - The text that the alert contains.priority - A relative value that represents the priority for this alert. The range of acceptable values is
between 0 and 10.sourceTag - A string that identifies the source of the alert. The AR System provides two predefined values for
this string: AR - alert originated from the AR System FB - alert originated from Flashboardsserver - The name of the server that is the source of the alert. Use @ to specify the current server. Specify
NULL for this parameter if the parameter is not applicable to the type of alert that this call
creates.formName - The name of the form that is the source of the alert. For Flashboards, this is the name of the
Flashboard that generated the alert. Specify NULL for this parameter if the parameter is not
applicable to the type of alert that this call creates.objectId - For AR System, this value is the Entry ID of the originating request. For Flashboards, this value is
the name of the Flashboard event that the user provides. Specify NULL for this parameter if the
parameter is not applicable to the type of alert that this call creates.
ARException
public int getAlertCount(QualifierInfo qual)
throws ARException
qual - the query criteria that determines the alert count
ARException - if alert count is not returned
@Deprecated
public String encodeARQualifierStruct(QualifierInfo qual)
throws ARException
encodeQualification(com.bmc.arsys.api.QualifierInfo)
QualifierInfo. Converts QualifierInfo to serialized qualification string.
qual - the QualifierInfo object to encode
ARException - if QualifierInfo is not encoded
@Deprecated
public QualifierInfo decodeARQualifierStruct(String queryString)
throws ARException
decodeQualification(java.lang.String)
QualifierInfo. Converts serialized qualifier string to QualifierInfo.
queryString - the qualifier string to decode from
ARException - if QualifierInfo is not decoded
@Deprecated
public String encodeARAssignStruct(AssignInfo assign)
throws ARException
encodeAssignment(com.bmc.arsys.api.AssignInfo)
AssignInfo. Converts AssignInfo to serialized qualification string.
assign - the AssignInfo object to encode
ARException
@Deprecated
public AssignInfo decodeARAssignStruct(String assignString)
throws ARException
decodeAssignment(java.lang.String)
AssignInfo. Converts serialized Assign string to AssignInfo.
assignString - the assignment string to decode from
ARException - if AssignInfo is not decoded
public AlertMessageInfo decodeAlertMessage(AlertMessageCriteria criteria,
Object message,
int length)
throws ARException
Interface Change: The data supplied for the message parameter should be a byte array containing binary data received from the server. In previous versions the message parameter was a String. It was changed to an Object to facilitate the transition from String to byte array.
ARException - if message is not decoded
public String getLocalHostID()
throws ARException
ARException - if host ID is not returned
public List<MenuItem> convertStringToListMenu(String menuString)
throws ARException
MenuItem objects
ARException - if string is not converted
public String xmlCreateEntry(String inputMapping,
String inputDoc,
String outputMapping,
String optionDoc)
throws ARException
ARException
public String xmlSetEntry(String queryMapping,
String queryDoc,
String inputMapping,
String inputDoc,
String outputMapping,
String optionDoc)
throws ARException
ARException
public String xmlGetEntry(String queryMapping,
String queryDoc,
String outputMapping,
String optionDoc)
throws ARException
ARException
public void beginBulkEntryTransaction()
throws ARException
ARException
public List<BulkEntryReturn> endBulkEntryTransaction(int actionType)
throws ARException
actionType - the action to take when the bulk transaction ends. The values are:
Constants.AR_BULK_ENTRY_ACTION_SEND to transmit the queued entry calls to the server and
end the transaction
Constants.AR_BULK_ENTRY_ACTION_CANCEL to remove the queued entry calls and end the
transaction.
ARException
public BigDecimal getCurrencyRatio(String currencyRatioSet,
String fromCurrencyCode,
String toCurrencyCode)
throws ARException
currencyRatioSet - the currency ratio set that we search the currency ratio fromfromCurrencyCode - the source currency code for the conversion ratiotoCurrencyCode - the target currency code for the conversion ratio
ARException
public LocalizedValueInfo getLocalizedValue(LocalizedValueCriteria criteria,
LocalizedRequestInfo request)
throws ARException
NULL return if there was nothing found -- not even a default.
criteria - The localized value to be retrieved. The value can be a character value or an attachment. Specify NULL
for this argument if you do not want to retrieve this value.request - Identification for the localized value to be retrieved from the AR System Message Catalog. It contains
the type of value, , value name, and, for some types of values, unique identification numbers.
ARException - if string is not returned
public List<LocalizedValueInfo> getMultipleLocalizedValues(LocalizedValueCriteria criteria,
List<LocalizedRequestInfo> requests)
throws ARException
criteria - A list of the localized values to be retrieved. The values can be a character value or an attachment.
Specify NULL for this argument if you do not want to retrieve a value.requests - A list of identifications for the localized value to be retrieved. The list contains the type of
value, value name, and, for some types of values, unique identification numbers.
ARException - if localized texts are are not returned
@Deprecated
public String exportDef(List<StructItemInfo> items)
throws ARException
exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
This operation can be performed by users with AR System administrator privileges.
items - This is a raw type list that can be a collection of IARPersistentObject or
StructItemInfo objects.
ARException - if structure definition is not exported
@Deprecated
public String exportDef(List<StructItemInfo> items,
boolean asXml)
throws ARException
exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
This operation can be performed by users with AR System administrator privileges.
items - This is a raw type list that can be a collection of IARPersistentObject or
StructItemInfo objects.asXml - if export the structure in XML format
ARException - if structure definition is not exported
@Deprecated
public String exportDef(List items,
boolean asXml,
WorkflowLockInfo lockInfo)
throws ARException
exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported. This is a raw type list that can be a collection of
IARPersistentObject or StructItemInfo objects.asXml - if export the structure in XML formatlockInfo - the lock info to enable export locked objects.
ARException - if structure definition is not exported
@Deprecated
public String exportDef(List<StructItemInfo> items,
WorkflowLockInfo lockInfo)
throws ARException
exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported.lockInfo - the lock info to enable export locked objects.
ARException - if structure definition is not exported
@Deprecated
public String exportDef(List<StructItemInfo> items,
String displayTag,
int vuiType,
WorkflowLockInfo lockInfo)
throws ARException
exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported.displayTag - the label of the form view to export. This parameter is used along with structure items type
Constants.AR_STRUCT_ITEM_SCHEMA_VIEW. If the specified view does not exist or null is
specified for this parameter, the system exports the default view.vuiType - the type of view to export. The value can be:
Constants.AR_VUI_TYPE_NONE no view type. Constants.AR_VUI_TYPE_WINDOWS Windows
type, fields in BMC Remedy User. Constants.AR_VUI_TYPE_WEB Web relative type, fields in
view can be adjusted. Constants.AR_VUI_TYPE_WEB_ABS_POS Web absolute type, fields in view
are fixed.
lockInfo - the lock info to enable export locked objects.
ARException - if structure definition is not exported
@Deprecated
public String exportDef(List<StructItemInfo> items,
boolean asXml,
String displayTag,
int vuiType,
WorkflowLockInfo lockInfo)
throws ARException
exportDefToFile(java.util.List, boolean, java.lang.String, boolean) that takes care of file encoding.
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported.asXml - if export the structure in XML formatdisplayTag - the label of the form view to export. This parameter is used along with structure items type
Constants.AR_STRUCT_ITEM_SCHEMA_VIEW. If the specified view does not exist or null is
specified for this parameter, the system exports the default view.vuiType - the type of view to export. The value can be:
Constants.AR_VUI_TYPE_NONE no view type. Constants.AR_VUI_TYPE_WINDOWS Windows
type, fields in BMC Remedy User. Constants.AR_VUI_TYPE_WEB Web relative type, fields in
view can be adjusted. Constants.AR_VUI_TYPE_WEB_ABS_POS Web absolute type, fields in view
are fixed.
lockInfo - the lock info to enable export locked objects.
ARException - if structure definition is not exported
public void exportDefToFile(List<StructItemInfo> items,
boolean asXml,
String filePath,
boolean overwrite)
throws ARException,
IOException
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported. This is a raw type list that can be a collection of
IARPersistentObject or StructItemInfo objects.asXml - if export the structure in XML formatfilePath - the full name of the file that stores the exported definition.overwrite - a flag that decides if we overwrite the file if the file already exists.
ARException - if structure definition is not exported
IOException
public void exportDefToFile(List<StructItemInfo> items,
boolean asXml,
WorkflowLockInfo lockInfo,
String filePath,
boolean overwrite)
throws ARException,
IOException
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported. This is a raw type list that can be a collection of
IARPersistentObject or StructItemInfo objects.asXml - if export the structure in XML formatlockInfo - the lock info to enable export locked objects.filePath - the full name of the file that stores the exported definition.overwrite - a flag that decides if we overwrite the file if the file already exists.
ARException - if structure definition is not exported
IOException
public void exportDefToFile(List items,
boolean asXml,
String displayTag,
int vuiType,
WorkflowLockInfo lockInfo,
String filePath,
boolean overwrite)
throws ARException,
IOException
This operation can be performed by users with AR System administrator privileges.
items - the structure items to be exported. This is a raw type list that can be a collection of
IARPersistentObject or StructItemInfo objects.asXml - if export the structure in XML formatdisplayTag - the label of the form view to export. This parameter is used along with structure items type
Constants.AR_STRUCT_ITEM_SCHEMA_VIEW. If the specified view does not exist or null is
specified for this parameter, the system exports the default view.vuiType - the type of view to export. The value can be:
Constants.AR_VUI_TYPE_NONE no view type. Constants.AR_VUI_TYPE_WINDOWS Windows
type, fields in BMC Remedy User. Constants.AR_VUI_TYPE_WEB Web relative type, fields in
view can be adjusted. Constants.AR_VUI_TYPE_WEB_ABS_POS Web absolute type, fields in view
are fixed.
lockInfo - the lock info to enable export locked objects.filePath - the full name of the file that stores the exported definition.overwrite - a flag that decides if we overwrite the file if the file already exists.lockInfo - the lock info to enable export locked objects.filePath - the full name of the file that stores the exported definition.overwrite - a flag that decides if we overwrite the file if the file already exists.
ARException - if structure definition is not exported
IOException
public void importDefFromFile(String filePath)
throws ARException,
IOException
filePath - File path
IOException - if file could not be read
ARException
public void importDefFromFile(String filePath,
int optionMask)
throws ARException,
IOException
filePath - File pathoptionMask - Import option mask is one (or bit-wise OR of multiple) Constants.AR_IMPORT_OPT_* constants.
ARException - if structure definition is not imported
IOException - if file could not be read
public void importDefFromFile(String filePath,
List<StructItemInfo> items)
throws ARException,
IOException
filePath - File pathitems - list of items to import
ARException - if structure definition is not imported
IOException - if file could not be read
public void importDefFromFile(String filePath,
int optionMask,
List<StructItemInfo> items)
throws ARException,
IOException
filePath - File pathoptionMask - Import option mask is one (or bit-wise OR of multiple) Constants.AR_IMPORT_OPT_* constants.items - list of items to import
ARException - if structure definition is not imported
IOException - if file could not be read
@Deprecated
public void importDefFromBuffer(String importBuffer)
throws ARException
importDefFromFile(java.lang.String) that takes care of file encoding.
importBuffer - Buffer containing the definitions
ARException - if structure definition is not imported
@Deprecated
public void importDefFromBuffer(String importBuffer,
int optionMask)
throws ARException
importDefFromFile(java.lang.String) that takes care of file encoding.
importBuffer - Buffer containing the definitionsoptionMask - Import option mask is one (or bit-wise OR of multiple) Constants.AR_IMPORT_OPT_* constants.
ARException - if structure definition is not imported
@Deprecated
public void importDefFromBuffer(String importBuffer,
List<StructItemInfo> items)
throws ARException
importDefFromFile(java.lang.String) that takes care of file encoding.
importBuffer - Buffer containing the definitionsitems - list of items to import
ARException - if structure definition is not imported
@Deprecated
public void importDefFromBuffer(String importBuffer,
int optionMask,
List<StructItemInfo> items)
throws ARException
importDefFromFile(java.lang.String) that takes care of file encoding.
importBuffer - Buffer containing the definitionsoptionMask - Import option mask is one (or bit-wise OR of multiple) Constants.AR_IMPORT_OPT_* constants.items - list of items to import
ARException - if structure definition is not imported
public LicenseValidInfo validateLicense(String licenseType)
throws ARException
LicenseValidInfo.
ARException - if information is not validated
public List<LicenseValidInfo> validateMultipleLicense(List<String> licenseTypes)
throws ARException
LicenseValidInfo.
ARException - if information is not validated
public void signalServer(Map<SignalType,String> signals)
throws ARException
signals - signals sent to the server.
ARExceptionpublic void setChunkResponseSize(int chunkResponseSize)
public int getChunkResponseSize()
public void setTimeoutNormal(int timeoutNormal)
public int getTimeoutNormal()
public void setTimeoutLong(int timeoutLong)
public int getTimeoutLong()
public void setTimeoutXLong(int timeoutXLong)
public int getTimeoutXLong()
public void useAdminRpcQueue()
throws ARException
ARException - if the session cannot use Admin Queue
public void useDefaultRpcQueue()
throws ARException
ARException
public void usePrivateRpcQueue(int rpcProgramNum)
throws ARException
rpcProgramNum - the rpc program number for the private queue
ARException - if the rpc program number is not in the range. the range is from AR_RPC_SPEC_QUEUE_MIN to
AR_RPC_SPEC_QUEUE_MAX and from AR_RPC_PRIVATE_QUEUE_MIN to AR_RPC_PRIVATE_QUEUE_MAXpublic int getServerRpcQueueNumber()
public void setClientType(int clientType)
public int getClientType()
public void setVUIType(int vuiType)
public int getVUIType()
public void setOverridePrevIP(boolean overridePrevIP)
public boolean getOverridePrevIP()
public String getLastID()
public int getLastCount()
public void setReservedParam1(String pParam)
public String getReservedParam1()
public ExtendedClassRegistry getExtendedClassRegistry()
public void setExtendedClassRegistry(ExtendedClassRegistry ecr)
ecr - public String getDefaultOutputDirectory()
public void setDefaultOutputDirectory(String defaultOutputDirectory)
defaultOutputDirectory - the default output directory to set (used while SupportFile retrieval)public String toString()
toString in class Objectpublic int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class Objectobj - the object that we are comparing to
public String getServerVersion()
public int getServerVersionMajor()
public int getServerVersionMinor()
public String getServerVersionPatch()
public QualifierInfo decodeQualification(String encodedQualText)
throws ARException
encodedQualText - the encoded qualification query string
ARException - if the encoded string does not have a valid format
public String encodeQualification(QualifierInfo qualifier)
throws ARException
qualifier - the qualification object to be encoded
ARException - if the given QualifierInfo object is invalid
public String encodeAssignment(AssignInfo assignment)
throws ARException
assignment - the assignment object to be encoded
ARException - if the given AssignInfo object is invalid
public AssignInfo decodeAssignment(String assignString)
throws ARException
assignString - the encoded assignment string
ARException - if the encoded string does not have a valid format
public String encodeDSOPoolAssignment(AssignInfo asgnInfo)
throws ARException
asgnInfo - the assignment object to be encoded
ARException - if the given AssignInfo object is invalid
public AssignInfo decodeDSOPoolAssignment(String encodedStr)
throws ARException
encodedStr - the encoded assignment string
ARException - if the encoded string does not have a valid format
public String generateGUID()
throws ARException
ARException - if the GUID could not be generated
public String generateGUID(String prefix)
throws ARException
prefix - The prefix desired for the generated GUID. It can be one of - null, empty string (these cases are
defauld guid generation); or a non-empty string. The generated guid will have the suggested prefix (if
less than or equal to two chars length) or its first two characters.
ARException - if the GUID could not be generated
public boolean isMemberOfGroup(int groupId)
throws ARException
ARException
public AssignInfo parseAssignment(String toForm,
int fieldId,
String fromForm,
String expression)
throws ARException
toForm - Form containing the target field for this assignmentfieldId - Target fieldfromForm - The assignment expression may include field references from this formexpression - The readable assignment expression
ARException - denoting any parsing errors
public QualifierInfo parseQualification(String form,
String qualification)
throws ARException
form - Form against which this qualification is definedqualification - Readable qualification string
ARException - denoting any parsing errors
public QualifierInfo parseQualification(String form,
String vui,
String qualification)
throws ARException
form - Form against which this qualification is definedvui - One of the following values: qualification - Readable qualification string
ARException - denoting any parsing errors
public Object parseFilterQualification(String form,
String qualification)
throws ARException
form - Form against which this qualification is definedqualification - Readable qualification string
ARException - denoting any parsing errors
public String formatQualification(String form,
Object qualification)
throws ARException
form - Form against which this qualification is definedqualification - given qualification - it can be an encoded qualification representation (String) or a QualifierInfo
object
ARException - in case of formatting errors
public QualifierInfo parseSetIfQualification(String form1,
String form2,
String qualification)
throws ARException
form1 - Local form on which this Set If workflow action is definedform2 - Remote/secondary form involved in this workflow actionqualification - Readable qualification string
ARException - denoting any parsing errors
public String formatSetIfQualification(String form1,
String form2,
Object qualification)
throws ARException
form1 - Local form on which this Set If workflow action is definedform2 - Remote/secondary form involved in this workflow actionqualification - given qualification - it can be an encoded qualification representation (String) or a QualifierInfo
object
ARException - in case of formatting errors
public String formatAssignment(String form,
int fieldId,
String form2,
Object assignment)
throws ARException
form - Form name that has the field against which this assignment is targetted atfieldId - Target fieldform2 - Remote/secondary form involved in this assignment expression (fields from this secondary form may
appear in the assignment expression)assignment - Either an encoded assignment (String) or an AssignInfo
ARException - in case of formatting errors
public ProcessResult executeSpecialCommand(String cmd,
Object... parameters)
throws ARException
cmd - The command lineparameters - Appropriate parameters for the given special command
ARException - if command is not performed
public HashMap<Integer,ObjectOperationTimes> getObjectChangeTimes()
throws ARException
ARException - if called with JNI version of Java API instead of pure Java implementation
public Image getImage(String imageName)
throws ARException
imageName - the name of the image requested
ARException - if object is not loaded
public Image getImage(String imageName,
ImageCriteria criteria)
throws ARException
imageName - the name of the image requestedcriteria - the attribute returned for the Image object
ARException - if object is not loaded
public List<Image> getListImageObjects(String formName)
throws ARException
Image objects that are associated with the specified
form
formName - the name of the form that is associated with the image.
ARException
public List<Image> getListImageObjects(String formName,
long changedSince)
throws ARException
Image objects that are associated with the specified form and
modified after the given time.
formName - the name of the form that is associated with the image.changedSince - A timestamp that limits the images retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve images with any modification timestamp.
ARException
public List<Image> getListImageObjects(String formName,
long changedSince,
ImageCriteria criteria)
throws ARException
Image objects specified by the criteria and ImageCriteria.
formName - the name of the form that is associated with the image.changedSince - A timestamp that limits the images retrieved to those modified after the specified time.criteria - the infomation (attributes) to retrieve
ARException
public List<Image> getListImageObjects()
throws ARException
Image objects
ARException
public List<Image> getListImageObjects(List<String> names)
throws ARException
Image objects
names - the names of images to retrieve
ARException
public List<Image> getListImageObjects(List<String> names,
ImageCriteria criteria)
throws ARException
Image objects
names - the names of images to retrievecriteria - the attribute returned for each image object
ARException
public List<Image> getListImageObjects(List<String> names,
long changedSince,
ImageCriteria criteria)
throws ARException
Image objects and is modified after the give time
names - the names of images to retrievechangedSince - A timestamp that limits the images retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve images with any modification timestamp.criteria - the attribute returned for each image object
ARException
public void setImage(Image obj)
throws ARException
ARException - if form is not updated
public void createImage(Image obj)
throws ARException
ARException - if form is not created
public void deleteImage(String imageName,
boolean updateRef)
throws ARException
ARException - if form is not deleted
public List<String> getListImage()
throws ARException
Image objects
ARException
public List<String> getListImage(List<String> formList)
throws ARException
Image objects that are associated with the given list of forms
formList - a list of forms to check to determine whether any images are that is associated with the escalation
ARException
public List<String> getListImage(long changedSince)
throws ARException
Image objects that have been modified after the specified timestamp
changedSince - A timestamp that limits images retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve images with any modification timestamp.
ARException
public List<String> getListImage(String imageType)
throws ARException
Image objects of a specified type (ie, "jpg")
imageType - A specific image type to retrieve from the server. Specify a null string to retrieve all image types.
ARException
public List<String> getListImage(List<String> formList,
long changedSince,
String imageType)
throws ARException
Image objects that match the given criteria
formList - the list of forms to retrieve image objects from Specify null to retrieve images from all formschangedSince - A timestamp that limits images retrieved to those modified after the specified time. Specify 0 for
this parameter to retrieve images with any modification timestamp.imageType - A specific image type to retrieve from the server. Specify a null string to retrieve all image types.
ARException - if list is not returned
public void deleteAlert(String entryId)
throws ARException
entryId - This value is the Entry ID of the alert event returned at the time of creation.
ARExceptionpublic String getTransactionHandle()
public String beginClientManagedTransaction()
throws ARException
transactionHandle - The parameter which will be filled with the transactionHandle
ARException - if creating a transaction handle is not successful.
public void endClientManagedTransaction(int transactionOption)
throws ARException
transactionOption - The parameter which will be filled with the transactionHandle
ARException - if commiting/rollback of the transaction is not successful
public void setClientManagedTransaction(String transactionHandle)
throws ARException
transactionHandle - The parameter which will be filled with the transactionHandle to be set.
ARException
public void removeClientManagedTransaction()
throws ARException
ARException
public int[] wfdExecute(int mode)
throws ARException
mode - How to execute? single step, run to bp etc. 0 indicates single step.
ARException
public WfdDebugLocation wfdGetDebugLocation(int depth)
throws ARException
depth - How far back on the stack to retrieve location info 0 indicates current.
ARException
public int wfdGetDebugMode()
throws ARException
mode - Where to stop? Begin API, Pre-Qual, Phase1, etc. 0 indicates none.
ARException
public void wfdSetDebugMode(int mode)
throws ARException
mode - Where to stop? Begin API, Pre-Qual, Phase1, etc. 0 indicates none.
ARException
public List<Entry> wfdGetFieldValues(int depth)
throws ARException
depth - Stack depth for desired FV lists. 0 indicates current.
ARException
public void wfdSetFieldValues(List<Entry> fieldValues)
throws ARException
mode - Values to replace in existing transaction and database lists.
ARException
public QualifierInfo wfdGetFilterQual()
throws ARException
ARException
public void wfdSetQualifierResult(boolean result)
throws ARException
ARException
public void wfdTerminateAPI(int errorCode)
throws ARException
ARException
public Value wfdGetKeywordValue(int kwId)
throws ARException
ARException
public WfdUserContext wfdGetUserContext(int mask)
throws ARException
ARException
public void wfdSetBreakpoint(int errorCode,
WfdBreakpoint bp)
throws ARException
ARException
public void wfdClearBreakpoint(int bpId)
throws ARException
ARException
public List<WfdBreakpoint> wfdListBreakpoints()
throws ARException
ARException
public void wfdClearAllBreakpoints()
throws ARException
ARException
public List<Integer> getCacheEvent(int[] eventIdList,
int returnOption,
OutputInteger cacheCount)
throws ARException
eventIdList - Events for which clients want to know the status. Values include:
AR_CACHE_ADMINONLYCREATE_EVENT = 1,
AR_CACHE_ADMINONLYPUBLIC_EVENT = 2,
AR_CACHE_FREE_EVENT = 3.returnOption - This flag indicates whether client wants to wait(=1) for next event
or wants to return immediately(=0). Default is to return immediately.cacheCount - It returns the total number of caches present at the time of call getting returned.
ARException - If IDs are not loaded.
public void runEscalation(String escalation)
throws ARException
ARException
|
AR System Java API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||