ClientAPI (Agentflow_35SP1 API Specification)

Overview

Package

Class

Use

Tree

Index

Help

Agentflow
V3.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

pe.pase
Interface ClientAPI

All Known Implementing Classes:: BasedClientAPI, LocalClientAPI, webform.WebFormClientAPI

public interface ClientAPI

Methods defined in this interface can be invoked through default object Client in Agentflow scripts.

ex: Client.getCompany();

Since:: version 1.0.0
Author:: yschen
See Also:: ServerAPI, FormAPI

Method Summary
`void`	`addDebugLog(java.lang.String msg)` Add debug log message.
`void`	`addErrLog(java.lang.String msg)` Add err log message.
`void`	`addExeLog(java.lang.String msg)` Add execution log message.
`boolean`	`addFreqApRole(java.lang.String freID, java.lang.String rolID)` Add a PASEFreqAP role.
`void`	`addInfoLog(java.lang.String msg)` Add information log message.
`boolean`	`addMonitorRelation(java.lang.String sourceTaskID, java.lang.String createdRootTaskID)` Add task monitor relation, store root task ID and those created root task ID when executed.
`boolean`	`addMonitorRelation(java.lang.String sourceTaskID, java.util.Vector createdRootTaskIDs)` Add task monitor relation, store root task ID and those created root task ID when executed.
`int`	`addNewSessionConnectionURL(int type, java.lang.String name, java.lang.String dburl, java.lang.String username, java.lang.String password)` Add a new db URL at the end of the db configuration list.
`void`	`addSessionConnectionURL(int seq, int type, java.lang.String dburl, java.lang.String username, java.lang.String password)` Set a db URL to db configuration.
`void`	`addSessionConnectionURL(int seq, int type, java.lang.String name, java.lang.String dburl, java.lang.String username, java.lang.String password)` Set a db URL to db configuration.
`void`	`addWarningLog(java.lang.String msg)` Add warning log message.
`boolean`	`checkPassword(java.lang.String mID, java.lang.String pass)` Check user input password whether it's correct.
`boolean`	`checkTaskComplete(Task t)` Check the task and fit it to the complete-conditon.
`void`	`clearCache()` This method is using for clear client cache Examples: Client.clearCache();
`void`	`clearServerCache()` This method is using for clear server cache Examples: Client.clearServerCache();
`java.util.HashMap`	`completeTask(Task t)` Complete the task.
`java.util.HashMap`	`completeTask(Task t, java.lang.String stateID)` Complete the task with setting the artifact state.
`PASEartInstance`	`createArtInstance(java.lang.String aID)` Create artifact instance.
`javax.swing.JPanel`	`createForm(java.lang.String artInsID)` Create a artifact form by current artifact style in Agenda.
`javax.swing.JPanel`	`createForm(java.lang.String artInsID, java.lang.String stateName, boolean bRunScript)` Create a artifact form by current artifact style in Agenda.
`javax.swing.JPanel`	`createForm(java.lang.String artInsID, java.lang.String stateName, boolean bRunScript, boolean bSave, boolean print, boolean canReviewProcess, int x, int y, int width, int height)` Create a artifact form by current artifact style in Agenda.
`javax.swing.JPanel`	`createForm(java.lang.String artInsID, java.lang.String stateName, boolean bRunScript, boolean bSave, boolean print, int close, int x, int y, int width, int height)` Create a artifact form by current artifact style in Agenda.
`void`	`createFormExt(java.lang.String artInsID, java.lang.String stateName, boolean isRunScript, boolean canSave, boolean canPrint, boolean canReviewProcess)` Opens a form with the specified parameters.
`java.lang.String`	`createProcess(java.lang.String proID, java.util.HashMap args)` Create an auto-popup process and assign to current operator.
`java.lang.String`	`createProcess(java.lang.String proID, java.util.HashMap args, boolean isPopUp)` Create a process by specified isPopUp value and assign to current operator.
`java.lang.String`	`createProcess(java.lang.String userID, java.lang.String proID, java.util.HashMap args)` Create a non-auto-PopUp process and assign to specified member id.
`java.lang.String`	`createProcess(java.lang.String userID, java.lang.String proID, java.util.HashMap args, boolean isPopUp)` Create a process by specified isPopUp value and assign to specified member id.
`java.lang.String`	`createProcess(java.lang.String userID, java.lang.String proID, java.util.HashMap args, boolean isPopUp, boolean isDelible)` Create a process by specified isPopUp and isDelible value and assign to specified member id.
`java.lang.String`	`createProcess(java.lang.String userID, java.lang.String roleID, java.lang.String proID, java.util.HashMap args, boolean isPopUp, boolean isDelible, java.lang.String taskID, java.lang.String dtTemplateID, boolean isShowMonitorRelation)` Create a process by specified isPopUp and isDelible and isShowMonitorRelation value and assign to specified member id and use the specified DataTransferTemplate.
`java.lang.String`	`createProcessByRandom(java.lang.String proID, java.util.HashMap args)` Create a non-auto-PopUp process and assign to random of specified roles.
`ScheduleEvent`	`createScheduleEvent()` Create new ScheduleEvent Examples: var event = Client.createScheduleEvent();
`SessionConnection`	`createSessionConnection(int seq)` Create a `SessionConnection` object with database configuration, by the specific sequence.
`SessionConnection`	`createSessionConnection(java.lang.String name)` Create a SessionConnection object with database configuration, by the specific name.
`boolean`	`deleteCompany(Company company)` Delete a Company in organization.
`boolean`	`deleteDepartment(Department dep)` Delete a Department in organization.
`boolean`	`deleteGlobals(java.lang.String rootTaskID)` Delete globals.
`boolean`	`deleteMemberRecord(MemberRecord mbr)` Delete a MemberRecord in organization.
`boolean`	`deletePASEMessage(PASEMessage msg)` Delete message from database.
`boolean`	`deleteRole(Role role)` Delete a Role in organization.
`java.util.HashMap`	`deleteSessionConnectionURL(java.lang.String name)` Delete a db URL from db configuration.
`boolean`	`deleteTaskAttachedFile(java.lang.String fileID)` Get file content of the specified task attached file.
`boolean`	`forceCompleteATask(Task parentTask)` Completea an task, which task type is "Add Announce Sign".
`boolean`	`forceReassignTask(java.lang.String p_TaskID, java.lang.String p_MemID)` Force to reassign the task.
`java.util.Vector`	`getAddSignTaskList(java.lang.String signTaskId)` get AddCSResultData list of the same singTaskId
`java.util.Vector`	`getAllCSSignResult(java.util.Vector parseTaskList)`
`java.util.Vector`	`getAllDepartmentByName(java.lang.String mName)` Get all departments with the same name.
`java.util.Vector`	`getAllDepIDOfCompany()` Get all departments' IDs in the company.
`java.util.Vector`	`getAllDepNameOfCompany()` Get all departments' name in the company.
`java.util.Vector`	`getAllIapSignResult(java.lang.String iapTaskID)`
`java.util.List`	`getAllManager(MemberRecord mbr, boolean mainRoleOnly)` Get All mamager with the specified `MemberRecord`
`java.util.List`	`getAllManagerByID(java.lang.String memId)` Get All mamager with the specified member id
`java.util.List`	`getAllManagerByLoginID(java.lang.String loginId)` Get All mamager with the specified member's login id
`java.util.List`	`getAllManagerByNo(java.lang.String memNo)` Get All mamager with the specified member No.
`java.util.Vector`	`getAllMember()` Return all member of system
`java.util.Vector`	`getAllMemberByCName(java.lang.String mName)` Get all members with the same name.
`java.util.Vector`	`getAllProcess()` Note: JSP WebForm does not implement this method.
`java.util.Vector`	`getAllProjectRoleByName(java.lang.String mName)` Get All Project Role Objects by the same Name.
`java.util.Vector`	`getAllRoleByName(java.lang.String mName)` Get all roles with the same name.
`java.util.Vector`	`getAllRoleIDOfCompany()` Get all role id in the company.
`java.util.Vector`	`getAllRoleNameOfCompany()` Get all role name in the company.
`java.util.Vector`	`getAllUnitType()` Get All Unit Types
`java.util.Vector`	`getAllUnitType(int levelNumber, int relation, java.lang.String orderBy)` Get All UnitTypes with the specified level number, relation and orderBy
`java.lang.String`	`getApplication(java.lang.String type)` Get the registered file type mapping.
`Artifact`	`getArtifact(java.lang.String aID)` Get artifact by the specified artifact id.
`java.util.Vector`	`getArtifactForm(java.lang.String aID)` Get artifact forms of the specified artifact.
`java.util.Vector`	`getArtifactOfCompany()` Get all artifacts in the company.
`java.util.Vector`	`getArtifactOfProject(java.lang.String prjID)` Get all artifacts which will be used by the specified project.
`java.util.HashMap`	`getArtInsDefaultMap(java.lang.String properties, java.lang.String artState, java.lang.String dbType, Task task, java.lang.String artID, java.lang.String[] priorityLocaleStr)` Returns the artifact instance default value map.
`PASEartInstance`	`getArtInstance(java.lang.String iID)` Get artifact instance by the specified instance id.
`PASEartInstance`	`getArtInstance(java.lang.String iID, java.lang.String tID)` Get artifact instance with the specified instance id and task id.
`java.lang.String`	`getArtTskID(java.lang.String iID)` Get the latest associated TaskID with the Artifact Instance.
`java.util.HashMap`	`getATaskNote(java.lang.String tskID)` Get all ATask information for the specified root task.
`java.lang.String`	`getAttachFilePath(AttachFileInfo fileInfo)` get relative path of AttachFileInfo Object uploaded to Server Side Examples: var m_attached = Form.getComponent("AttachedFile0"); var m_filelist = m_attached.getProperty("FileList"); for(var i = 0, n = m_filelist.size(); i < n; ++i) { java.lang.System.out.println("FilePath : " + Client.getAttachFilePath(m_filelist.get(i))); }
`java.lang.String`	`getAttachFilePath(java.lang.String fid)` get relative path of AttachFileInfo Object uploaded to Server Side Examples: var m_attached = Form.getComponent("AttachedFile0"); var m_filelist = m_attached.getProperty("FileList"); var fid; for(var i = 0, n = m_filelist.size(); i < n; ++i) { fid = m_filelist.get(i).getFileID(); java.lang.System.out.println("FilePath : " + Client.getAttachFilePath(fid)); }
`java.awt.Frame`	`getClientMainFrame()` To getting the agenda main frame.
`java.lang.String`	`getClientMode()` Return the current .
`Company`	`getCompany()` Get company.
`CSSignInfo`	`getCSSignInfo(Task task)`
`java.util.Map`	`getCSTaskNote(java.lang.String taskId)`
`MemberRecord`	`getCurrentMember()` Get current member.
`java.lang.String`	`getDbConnectionCurrentState()` Get the information about the system database connection : Max. connection size, Min. connection size, Current used connection size.
`DBProcess`	`getDBProcess(java.lang.String pID)` Get `DBProcess` by process id Examples: var pID = "PRO0549992486182610"; var dbProcess = Client.getDBProcess(pID); //returns the `DBProcess` object
`Department`	`getDepartment(java.lang.String dID)` Get department by the specified department id.
`MemberRecord`	`getDepartmentHead(MemberRecord mbr, boolean mainRoleOnly)` Get the manager of first unit department with the specified `MemberRecord`
`MemberRecord`	`getDepartmentHeadByID(java.lang.String memId)` Get the manager of first unit department with the specified member id
`MemberRecord`	`getDepartmentHeadByLoginID(java.lang.String loginId)` Get the manager of first unit department with the specified member's login id
`MemberRecord`	`getDepartmentHeadByNo(java.lang.String memNo)` Get the manager of first unit department with the specified member No.
`java.lang.String`	`getDeputyMemID()` Get deputy member id.
`java.lang.String`	`getDeputyName()` Get deputy name.
`EmailTemplate`	`getEmailTemplate(java.lang.String etID)` getEmailTemplate by PROID or ETID Examples: var etID = "ETXXXXXXXXXXXXX"; var emailTemp = Client.getEmailTemplate(etID); var subject = emailTemp.getSubject(); var body = emailTemp.getBody(); var sender = emailTemp.getSender(); var receiver = emailTemp.getReceiver();
`UnitType`	`getFirstLevelUnitType()` Get first unit's unit types
`java.lang.String`	`getFlowServerIP()` Get IP address of server.
`java.lang.String`	`getFlowServerPort()` Get RMI port of server.
`FormAPI`	`getFormAPI(java.awt.Component cmp)` Get FormAPI of the specified component.
`java.util.Vector`	`getFreqApListOfMember(java.lang.String mID)` Get the PASEFreqAp processes of the specified member.
`java.util.HashMap`	`getGlobals(java.lang.String rootTaskID)` Get globals data from previous setGlobals function.
`java.lang.String`	`getGroupSignIDOfTask(java.lang.String taskID)` To get group sign id of the specified task id.
`java.util.List`	`getGroupSignTaskIDList(java.lang.String groupSignID)` To get task id list of the specified group sign id.
`java.util.HashMap`	`getGroupSignTaskMap(java.lang.String groupSignID)` To get a HashMap of the specified group sign id.
`java.util.Vector`	`getInvolvedExecutors(java.lang.String rootTaskID)` Return ID list of executors who involved in the root process Examples: var v = Client.getInvolvedExecutors("Tsk000000835835");
`java.util.Vector`	`getInvolvedMembers(java.lang.String rootTaskID)` Return ID list of members who involved in the root process Examples: var v = Client.getInvolvedMembers("Tsk000000835835");
`java.lang.Object`	`getLocalObject(java.lang.String id)` Get a local object by a special id.
`java.util.HashMap`	`getLocalObjectMap()` Get a local object map which contains all local object.
`java.lang.String[]`	`getManager(java.lang.String id)` Get manager id by member id, role id, or department id.
`Role`	`getManagerRole(java.lang.String id)` Get manager role by the specified member, role or department ID.
`java.util.Vector`	`getManagersOfDRM(java.lang.String id)` Get all manager id by member id, role id, or department id.
`MemberRecord`	`getMember(java.lang.String id)` Get member by id, login id, or user name.
`AccessMember`	`getMemberAccess()` Get current member function right Examples: var accessMember = Client.getMemberAccess(); //returns the `AccessMember` object
`MemberRecord`	`getMemberByCName(java.lang.String mName)` Get member by the specified user name.
`MemberRecord`	`getMemberByID(java.lang.String mID)` Get member by the specified member id.
`MemberRecord`	`getMemberByName(java.lang.String mLoginID)` Get member by the specified login id.
`java.lang.String[]`	`getMemberInfoByTree(int left, int top, int width, int height)` Show the dialog of organization tree and return member info.
`java.lang.String`	`getMemID(java.lang.String loginID)` Get member id by the specified login id Examples: var memID = Client.getMemID("Jacky");
`java.lang.String`	`getNewArtInsID()` Create a new artifact instance id Examples: var newArtID = Client.getNewArtInsID();
`java.lang.String`	`getNewFileID()` Create a new attached file id Examples: var newfileID = Client.getNewFileID();
`MemberRecord`	`getNextManager(MemberRecord mbr)` Get Next manger with the specified `MemberRecord`
`MemberRecord`	`getNextManager(MemberRecord mbr, int levelNumber)` Get Next manger with the specified `MemberRecord` and level of unit type
`MemberRecord`	`getNextManagerByID(java.lang.String memId)` Get Next manger with the specified member id
`MemberRecord`	`getNextManagerByID(java.lang.String memId, int levelNumber)` Get Next manger with the specified member id and level of unit type
`MemberRecord`	`getNextManagerByLoginID(java.lang.String loginId)` Get Next manger with the specified member's login id
`MemberRecord`	`getNextManagerByLoginID(java.lang.String loginId, int levelNumber)` Get Next manger with the specified member's login id and level of unit type
`MemberRecord`	`getNextManagerByNo(java.lang.String memNo)` Get Next manger with the specified member No.
`MemberRecord`	`getNextManagerByNo(java.lang.String memNo, int levelNumber)` Get Next manger with the specified member No. and level of unit type
`Department`	`getOneDepartmentByName(java.lang.String mName)` Get department by the specified department Name.
`Role`	`getOneRoleByName(java.lang.String mName)` Get one role by the specified role name.
`java.util.Vector`	`getOnLineUser()` Get all on-line member list Examples: var onlineUserList = Client.getOnLineUser(); for(var i = 0;i < onlineUserList.size();i++) { var member = onlineUserList.get(i); //returns `MemberRecord` object }
`java.util.Vector`	`getParentIDListOfMember(java.lang.String memID, boolean isMainRoleOnly)` Get All parent CompanyID, RolID, DepID, MemID of Member.
`PASEOrgModel`	`getPASEOrgModel()` Get the `PASEOrgModel`.
`java.util.Vector`	`getPASEProcessOfMember(java.lang.String mID)` Get the root processes of the specified member.
`java.util.Vector`	`getPDiagramDetail(java.lang.String rootTID)` Get the detail of process diagram.
`java.util.HashMap`	`getPDiagramState(java.lang.String rootTID)` Get the states of process diagram.
`java.util.HashMap`	`getProcessDiagram(java.lang.String rootPID, java.lang.String rootTaskID)` Get a process diagram.
`Project`	`getProject(java.lang.String prjID)` Get project by the specified project id.
`java.util.Vector`	`getProjectOfCompany()` Get all projects in the company.
`java.util.Vector`	`getProjectOfDepartment(java.lang.String dID)` Get the projects in the specified department.
`java.util.Vector`	`getProjectOfManager(java.lang.String managerID)` Get the projects which project manager is the same with the specified project manager.
`ProjectRole`	`getProjectRole(java.lang.String rID)` Get project role by the specified role id.
`ReportService`	`getReportService()` get ReportService
`Role`	`getRole(java.lang.String rID)` Get role by the specified role id.
`java.util.Vector`	`getRootDBProcessOfProject(java.lang.String prjID)` Get the list of the root `DBProcess` by the specified project id.
`java.util.Vector`	`getRootTaskOfMember(java.lang.String mID)` Get root tasks which managed by the specified member.
`java.util.Vector`	`getRootTaskOfMember(java.lang.String mID, int state)` Get root tasks which managed by the specified member.
`java.util.Vector`	`getRootTaskOfProcess(java.lang.String proID)` Retrieving the root `Task`s of the given `DBProcess` id.
`java.util.Vector`	`getRootTaskOfProcess(java.lang.String proID, int state)` Retrieving the root `Task`s of the given `DBProcess` id and task state.
`ScheduleEvent`	`getScheduleEvent(java.lang.String id)` Get schedule event Examples: var event = Client.getScheduleEvent(eventID);
`long`	`getServerTime()` Get the server time in milliseconds Examples: var time = Client.getServerTime(); var date = new java.util.Date(time);
`java.lang.Object`	`getService(java.lang.String serviceName)` Get Remote Service by the given service name
`java.util.HashMap`	`getSessionConnectionURL(int sequence)` Get the db configuration info with the specific sequence number Examples: var config = Client.getSessionConnectionURL(1); java.lang.System.out.println(config);
`java.util.HashMap`	`getSessionConnectionURL(java.lang.String name)` Get a db configuration by given name.
`java.util.Vector`	`getSessionConnectionURLList()` Get all db configurations.
`java.lang.String`	`getSignatureImage(java.lang.String mID)` Get the signature image by the specified member id.
`java.util.Vector`	`getSubDepIDOfDR(java.lang.String id, boolean exp)` Get sub-department's id by the specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
`java.util.Vector`	`getSubDepNameOfDR(java.lang.String id, boolean exp)` Get sub-department's name by the specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
`java.util.Vector`	`getSubMemberCNameOfDR(java.lang.String id, boolean exp)` Get sub-member's name by the specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
`java.util.Vector`	`getSubMemberIDOfDR(java.lang.String id, boolean exp)` Get sub-member's ID by the specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
`java.util.Vector`	`getSubRoleIDOfDR(java.lang.String id, boolean exp)` Get sub-role's id by the specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
`java.util.Vector`	`getSubRoleNameOfDR(java.lang.String id, boolean exp)` Get sub-role's name by the specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
`java.util.Vector`	`getSubTaskList(java.lang.String parentID)` Get subtasks of the specified task.
`Task`	`getTask(java.lang.String tID)` Get task by the specified task id.
`java.lang.String`	`getTaskAttachedFileContent(java.lang.String fileID)` Get file content of the specified task attached file.
`java.util.Vector`	`getTaskOfMember(java.lang.String mID)` Get tasks which managed by the specified member.
`java.util.Vector`	`getTaskOfMember(java.lang.String mID, int state)` Get tasks which managed by the specified member.
`java.util.Vector`	`getTaskOfProcess(java.lang.String proID)` Get tasks in the specified process.
`java.util.Vector`	`getTaskOfProcess(java.lang.String proID, int state)` Get tasks in the specified process.
`java.util.Vector`	`getTaskOfRootTask(java.lang.String rootTID)` Get tasks of the specified root task.
`java.util.Vector`	`getTranslateArtInsList(java.lang.String aID)` Artifact translate.
`java.util.Iterator`	`getTypeMap()` Get the mapping of application and type
`int`	`getUncompletePATaskNo(Task parentTask)` Calculate the tasks count which tasks are "Add Parallel Announce" and are complete under the specified task.
`UnitType`	`getUnitType(java.lang.String uid)` Get the Unit Type with the specified unit id
`UnitType`	`getUnitTypeByLoginID(java.lang.String loginId)` Get the Unit Type with the specified member's login id
`UnitType`	`getUnitTypeByMember(MemberRecord mbr)` Get the Unit Type with the specified `MemberRecord`
`UnitType`	`getUnitTypeByMemID(java.lang.String memId)` Get the Unit Type with the specified member id
`UnitType`	`getUnitTypeByNo(java.lang.String memNo)` Get the Unit Type with the specified member No.
`boolean`	`goBackTo(java.lang.String fromTaskID, java.lang.String toProID, boolean artMode)` For task schedule and flow control.
`boolean`	`goBackTo(java.lang.String fromTaskID, Task toTask, boolean artMode)` For task schedule and flow control.
`boolean`	`goBackTo(Task fromTask, java.lang.String toProID, boolean artMode)` For task schedule and flow control.
`java.util.HashMap`	`goBackToWithDetailRet(Task fromTask, java.lang.String toProID, boolean artMode)` For task schedule and flow control, go back to previous process node Examples: Client.goBackToWithDetailRet(fromTask, "ProXXXX", true);
`java.util.HashMap`	`initProcess(PASEProcess process)` Initial the process.
`boolean`	`insertDepartment(Department dep)` Insert a Department to organization.
`boolean`	`insertMemberRecord(MemberRecord mbr)` Insert a MemberRecord to organization.
`boolean`	`insertRole(Role role)` Insert a Role to organization.
`void`	`insertScheduleEvent(ScheduleEvent evt)` Insert ScheduleEvent into table Examples: Client.insertScheduleEvent(event);
`boolean`	`insertTaskAttachedFile(TaskAttachedFileInfo fileInfo)` insert a task attached file.
`boolean`	`isATaskComplete(Task t)`
`boolean`	`isCompanyManager(MemberRecord mbr)` Is manager of the company with the specified `MemberRecord`
`boolean`	`isCompanyManagerByID(java.lang.String memId)` Is manager of the company with the specified member id
`boolean`	`isCompanyManagerByLoginID(java.lang.String loginId)` Is manager of the company with the specified member's login id
`boolean`	`isCompanyManagerByNo(java.lang.String memNo)` Is manager of the company with the specified member No.
`boolean`	`isCSTaskComplete(Task t)`
`boolean`	`isHalfHoliday(java.lang.String date)` Check specified date whether it's a half of holiday in system's default calendar.
`boolean`	`isHalfHoliday(java.lang.String date, java.lang.String memID)` Check specified date whether it's a half of holiday in member's calendar.
`boolean`	`isHoliday(java.lang.String date)` Check specified date whether it's a holiday in system's default calendar.
`boolean`	`isHoliday(java.lang.String date, java.lang.String memID)` Check specified date whether it's a holiday in user's calendar.
`boolean`	`isRestSat(java.lang.String date)` Check specified date whether it's a rest Saturday.
`boolean`	`isWorkday(java.lang.String date, java.lang.String memID)` Check specified date whether it's a work day in member's calendar.
`void`	`lockTask(java.lang.String tskID)` For task schedule and flow control, set the task lock Examples: Client.lockTask("TskXXXXXXX");
`Department`	`newDepartment()` Create a Department instance.
`MemberRecord`	`newMemberRecord()` Create a MemberRecord instance.
`Role`	`newRole()` Create a Role instance.
`java.util.HashMap`	`notifyTask(java.lang.String tskID)` For task schedule and flow control, set the task notify Examples: var result = Client.notifyTask("TskXXXXXXX"); var booleanResult = result.get("retValue"); //returns `Boolean` object if(!
`java.util.Vector`	`parseAddASResultString(java.lang.String result)` Parse the countersign result string to CSResultData.
`java.util.Vector`	`parseCSResultString(java.lang.String result, java.util.List auditNameList)` Parse the countersign result string to CSResultData Examples: var task = Form.getCurrentTask(); //task is CSTask if(task.getTaskType().equals("csreview")) { var result = task.getCSInstance().getNote(); var resultObjList = Client.parseCSResultString(result, task.getAuditList()); for(var i = 0;i < resultObjList.size();i++) { var resultData = resultObjList.get(i); //resultData is CSResultData object } }
`void`	`printArtifactList(java.util.Vector artInsIDList, java.lang.String printMode, java.lang.String pageMode, java.lang.String viewState, boolean bRunScript, int top, int down, int left, int right, int orientation)` This method is using for batch printing artifact instances.
`void`	`printArtifactList(java.util.Vector artInsIDList, java.lang.String printMode, java.lang.String pageMode, java.lang.String viewState, boolean bRunScript, int width, int height, int top, int down, int left, int right, int orientation, boolean popUp)` This method is using for batch printing artifact instances.
`boolean`	`registerType(java.lang.String type, java.lang.String app)` Register file type mapping.
`boolean`	`removeAFTVElementVO(java.lang.String subject, java.lang.String item)` remove AFTVElementVO from database Examples: var artInsId = MyTask.getArtInstance().getID(); var itemId = "ITEM0"; var result = Client.removeAFTVElementVO(artInsId, itemId); returns true if it sets successfully ;false otherwise
`boolean`	`removeLocalObject(java.lang.String id)` Remove an local object.
`void`	`removeScheduleEvent(java.lang.String id)` Remove ScheduleEvent by event id Examples: Client.removeScheduleEvent(eventID);
`boolean`	`removeType(java.lang.String type)` Remove the registered file type mapping.
`void`	`reScheduleTask(Task task)` Reschedule the task Cron Event(s) Examples: var duration = 5; var task = Form.getCurrentTask(); task.setDuration(duration); Client.reScheduleTask(task);
`boolean`	`resetDeputyAndDeputyState(java.lang.String p_MemID, java.lang.String p_DeputyMemID, boolean p_DeputyState)` Reset deputy state and deputy member.
`boolean`	`resetMemberDelegation(MemberRecord mRecord)` Redispatch tasks to deputy of the member and also update memberrecord.
`boolean`	`runJScript(java.lang.String script, java.util.HashMap globalVar)` Script Runner.
`void`	`runScriptOnServer(java.lang.String code, Task t)` Run script on server.
`boolean`	`saveAFTVElementVO(AFTVElementVO vo)` save AFTVElementVO to database Examples: var artInsId = MyTask.getArtInstance().getID(); var itemId = "ITEM0"; var vo = new Packages.pe.pase.AFTVElementVO(artInsId, itemId); vo.setPrincipal("DEP00001091073095699"); vo.setOfflineReadonly(0); vo.setEditCount(1); vo.setSaveCount(-1); var result = Client.saveAFTVElementVO(vo); returns true if it sets successfully ;false otherwise
`void`	`saveArtifactListToJPG(java.util.Vector artInsIDList, java.util.Vector fileList, java.lang.String viewState, boolean bRunScript, int top, int down, int left, int right, int orientation)` This method is using for batch saving artifact instances to JPG file.
`void`	`saveArtifactListToPDF(java.util.Vector artInsIDList, java.lang.String pageMode, java.lang.String fileName, java.lang.String viewState, boolean bRunScript, int top, int down, int left, int right, int orientation)` This method is using for batch saving artifact instances to PDF file.
`java.util.Vector`	`searchScheduleEvent(ScheduleSearchCondition cond)` Search ScheduleEvent by condition search Examples: var ret = Client.searchScheduleEvent(searchEvent);
`void`	`sendHTMLMail(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String text)` Send E-Mail through internet, using HTML format.
`void`	`sendHTMLMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text)` Send E-Mail through internet, using HTML format.
`void`	`sendHTMLMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList)` Send E-Mail through internet, using HTML format.
`void`	`sendHTMLMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, java.util.HashMap auth)` Send E-Mail through internet, using HTML format.
`void`	`sendHTMLMailExt(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, java.lang.String tskID)` Send E-Mail through internet, using HTML format.
`void`	`sendHTMLMailExt(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, Task task)` Send E-Mail through internet, using HTML format.
`void`	`sendHTMLMailExt(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, Task task, java.lang.String script)` Send E-Mail through internet, using HTML format.
`void`	`sendMail(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String text)` Send E-Mail through internet.
`void`	`sendMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text)` Send E-Mail through internet.
`void`	`sendMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList)` Send E-Mail through internet.
`void`	`sendMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, java.util.HashMap auth)` Send E-Mail through internet.
`void`	`sendMailExt(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, java.lang.String tskID)` Send E-Mail through internet.
`void`	`sendMailExt(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, Task task)` Send E-Mail through internet.
`void`	`sendMailExt(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text, java.util.Vector fileList, Task task, java.lang.String script)` Send E-Mail through internet.
`boolean`	`sendPASEMessage(PASEMessage msg)` Send message through message-system built in Agentflow.
`void`	`sendTemplateMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String etID, java.util.Vector fileList, java.lang.String taskID, boolean isHtml)` Send E-Mail Template through internet, using HTML format.
`boolean`	`setArtInsState(PASEartInstance artInstance, java.lang.String stateID)` Set artifact instance state.
`void`	`setGlobals(java.lang.String rootTaskID, java.util.HashMap args)` Keep data into database and then reuse.
`void`	`setLocalObject(java.lang.String id, java.lang.Object obj)` Set a local object which belongs to this client.
`boolean`	`setMonitorRelation(java.lang.String sourceTaskID, java.lang.String createdRootTaskID)` Set task monitor relation, store root task ID and those created root task ID when executed.
`boolean`	`setMonitorRelation(java.lang.String sourceTaskID, java.util.Vector createdRootTaskIDs)` Set task monitor relation, store root task ID and those created root task ID when executed.
`boolean`	`SQLdeleteValue(java.lang.String sql)` The method is used to delete value from database (the `RTRepository`).
`boolean`	`SQLinsertValue(java.lang.String sql)` The method is used to insert value to database (the `RTRepository`).
`java.util.List`	`SQLloadValue(java.lang.String sql)` The method is used to load value from database (the `RTRepository`).
`boolean`	`SQLupdateValue(java.lang.String sql)` The method is used to update value to database (the `RTRepository`).
`java.util.HashMap`	`startTask(Task t)` Start the task.
`void`	`stopRootTask(java.lang.String rootTaskID)` For flow control, stop the root process Examples: Client.stopRootTask("Tsk000000835835");
`void`	`unlockCoSign(java.lang.String rt_proID)` Unlock a countrsign task.
`void`	`unlockTask(java.lang.String tskID)` For task schedule and flow control, set the task unlock Examples: Client.unlockTask("TskXXXXXXX");
`boolean`	`updateArtInstance(PASEartInstance instance)` Update artifact instance Notice: Artifact instance is carrying artifact state information.
`boolean`	`updateArtInstanceLog(java.lang.String tID, PASEartInstance instance)` Update artifact instance log Examples: var task = Form.getCurrentTask(); var artInstance = task.getArtInstance(); var flag = Client.updateArtInstanceLog(task.getID(), artInstance);
`boolean`	`updateAttachFileInfo(java.lang.String attachCmpName, AttachFileInfo fileInfo)` update file information of the specified attach file uploaded by attach file component attachCmpName Examples: var attachFileCmp = Form.getComponent("AttachFile0"); var fileList = attachFileCmp.getProperty("FileList"); var fileInfo = fileList.get(0); fileInfo.setNote("file note"); var result = Client.updateAttachFileInfo("AttachFile0", fileInfo);
`boolean`	`updateCompany(Company company)` Update a Company in organization.
`boolean`	`updateDepartment(Department dep)` Update a Department in organization.
`boolean`	`updateDeputyAndState(java.lang.String p_DeputyMemID, boolean p_DeputyState)` Update deputy member id and state.
`boolean`	`updateMemberRecord(MemberRecord mbr)` Update a MemberRecord in organization.
`boolean`	`updatePASEMessage(PASEMessage msg)` Update the message state includes both IsNew and IsReply fields.
`boolean`	`updateRole(Role role)` Update a Role in organization.
`void`	`updateScheduleEvent(ScheduleEvent evt)` Update ScheduleEvent Examples: Client.updateScheduleEvent(event);
`boolean`	`updateTask(Task t)` Update the task data.
`boolean`	`updateTaskState(Task t)` Update the task state.
`boolean`	`updateUnitType(UnitType unit)` Update the specified unit type
`void`	`waitTask(java.lang.String tskID)` For task schedule and flow control, set the task waiting Examples: Client.waitTask("TskXXXXXX");
`void`	`waitTask(java.lang.String tskID, java.lang.String timeString)` For task schedule and flow control, set the task waiting Examples: Client.waitTask("TskXXXXXX","2001/12/10/14/12");

Method Detail

addDebugLog

void addDebugLog(java.lang.String msg)

Add debug log message.

Examples:

        Client.addDebugLog("This is a debug log message!");

Parameters:: msg - the given message
Since:: version 1.2

addErrLog

void addErrLog(java.lang.String msg)

Add err log message.

Examples:

        Client.addErrLog("This is a err log message!");

Parameters:: msg - the given message
Since:: version 1.2

addExeLog

void addExeLog(java.lang.String msg)

Add execution log message.

Examples:

        Client.addExeLog("This is a execution log message!");

Parameters:: msg - the given message
Since:: version 1.2

addFreqApRole

boolean addFreqApRole(java.lang.String freID,
                      java.lang.String rolID)

Add a PASEFreqAP role.

Examples:

        var ret = Client.addFreqApRole(freID, rolID);

Parameters:: freID - the given PASEFreqApID; rolID - the given RoleID
Returns:: true if the adding is successful; false otherwise.
Since:: version 2.0.0

addInfoLog

void addInfoLog(java.lang.String msg)

Add information log message.

Examples:

        Client.addInfoLog("This is a information log message!");

Parameters:: msg - the given message
Since:: version 1.2

addMonitorRelation

boolean addMonitorRelation(java.lang.String sourceTaskID,
                           java.lang.String createdRootTaskID)

Add task monitor relation, store root task ID and those created root task ID when executed.

Examples:

        var taskID = Form.getCurrentTask().getID();
        var createRootTaskID = Client.createProcess(userID,proID,args,false, true);
        var result = Client.addMonitorRelation(taskID, createRootTaskID);
        if(result) {
                java.lang.System.out.println("Success!");
        } else {
                java.lang.System.out.println("Failed!");
        }

Parameters:: sourceTaskID - the given RootTaskID; createdRootTaskID - the given created RootTaskID
Returns:: true if the execution is successful; false otherwise.
Since:: version 2.0.0

addMonitorRelation

boolean addMonitorRelation(java.lang.String sourceTaskID,
                           java.util.Vector createdRootTaskIDs)

Add task monitor relation, store root task ID and those created root task ID when executed.

Examples:

        var taskID = Form.getCurrentTask().getID();
        var createRootTaskID = Client.createProcess(userID,proID,args,false, true);
        var idList = new java.util.Vector();
        idList.add(createRootTaskID);
        var result = Client.addMonitorRelation(taskID, idList);
        if(result) {
                java.lang.System.out.println("Success!");
        } else {
                java.lang.System.out.println("Failed!");
        }

Parameters:: sourceTaskID - the given RootTaskID; createdRootTaskIDs - the given created RootTaskID list
Returns:: true if the execution is successful; false otherwise.
Since:: version 2.0.0

addNewSessionConnectionURL

int addNewSessionConnectionURL(int type,
                               java.lang.String name,
                               java.lang.String dburl,
                               java.lang.String username,
                               java.lang.String password)

Add a new db URL at the end of the db configuration list. PASE Server must be restarted to execute the configuration. The database type:

0 - Oracle
1 - MSSQL
2 - SyBase
3 - MySQL
4 - Informix
5 - ODBC
6 - Progress
7 - DB2

Examples:

  Client.addSessionConnectionURL(0, "MS-SQL1", "jdbc:inetdae:192.168.8.1:1433?charset=Big5&database=Test", "sa", "sql");

Parameters:: type - the database type; name - the name to recognize the configuration; dburl - the database URL; username - the username to login in database; password - true password to login in database
Returns:: the sequence which the data is store in configuration
Since:: version 2.0.0

addSessionConnectionURL

void addSessionConnectionURL(int seq,
                             int type,
                             java.lang.String dburl,
                             java.lang.String username,
                             java.lang.String password)

Set a db URL to db configuration. System will generate a name for this configuration automatcally. It would replace another configuration by given the sequence number. PASE Server must be restarted to execute the configuration. The database type:

0 - Oracle
1 - MSSQL
2 - SyBase
3 - MySQL
4 - Informix
5 - ODBC
6 - Progress
7 - DB2

Examples:

        Client.addSessionConnectionURL(1, 0, "jdbc:inetdae:192.168.8.1:1433?charset=Big5&database=Test", "sa", "sql");

Parameters:: seq - the sequence which the data is store in configuration, from 1; type - the database type; dburl - the database URL; username - the username to login in database; password - true password to login in database
Since:: version 1.1.5

addSessionConnectionURL

void addSessionConnectionURL(int seq,
                             int type,
                             java.lang.String name,
                             java.lang.String dburl,
                             java.lang.String username,
                             java.lang.String password)

Set a db URL to db configuration. It would replace another configuration by given the sequence number. PASE Server must be restarted to execute the configuration. The database type:

0 - Oracle
1 - MSSQL
2 - SyBase
3 - MySQL
4 - Informix
5 - ODBC
6 - Progress
7 - DB2

Examples:

  Client.addSessionConnectionURL(1, 0, "MS-SQL1", "jdbc:inetdae:192.168.8.1:1433?charset=Big5&database=Test", "sa", "sql");

Parameters:: seq - the sequence which the data is store in configuration, from 1; type - the database type; name - the name to recognize the configuration; dburl - the database URL; username - the username to login in database; password - true password to login in database
Since:: version 2.0.0

addWarningLog

void addWarningLog(java.lang.String msg)

Add warning log message.

Examples:

        Client.addWarningLog("This is a warning log message!");

Parameters:: msg - the given message
Since:: version 1.2

checkPassword

boolean checkPassword(java.lang.String mID,
                      java.lang.String pass)

Check user input password whether it's correct.

Examples:

        var loginId = "f4";
        var pass = "squre";
        var Result = Client.checkPassword(loginId, pass);
        //returns true if the password is correct; false otherwise

Parameters:: loginId - the given member login ID.; pwd - the given password
Returns:: true if the password is correct; false otherwise.
Since:: version 1.0.1

checkTaskComplete

boolean checkTaskComplete(Task t)

Check the task and fit it to the complete-conditon.

Examples:

        var task = Form.getCurrentTask();
        if (Client.checkTaskComplete(task)) {
                Form.closeForm();
                Client.completeTask(task);
        }

Parameters:: t - the task
Returns:: true if the task fit the complete-condition; otherwise false
Since:: version 1.0.0

clearCache

void clearCache()

This method is using for clear client cache

Examples:

        Client.clearCache();

Since:: version 1.1.4

clearServerCache

void clearServerCache()

This method is using for clear server cache

Examples:

        Client.clearServerCache();

Since:: version 1.1.4

completeTask

java.util.HashMap completeTask(Task t)

Complete the task.

Examples:

        var taskID          = "Tsk000000221222";
        var artExitStateID  = "AST0371992486182500";
        var task            = Client.getTask(taskID);
        var artInstance     = task.getArtInstance();
        Client.setArtInsState(artInstance,artExitStateID);
        var hashmap  = Client.completeTask(task);
        var retValue = hashmap.get("retValue");
        //returns true if it starts successfully;false otherwise

Parameters:: t - the given Task
Returns:: the result ( [Key:Value] = [retValue:Boolean(true)] )
Since:: version 1.0.0
See Also:: Task

completeTask

java.util.HashMap completeTask(Task t,
                               java.lang.String stateID)

Complete the task with setting the artifact state.

Examples:

        var taskID         = "Tsk000000226229";
        var artExitStateID = "AST0371992486182500";
        var task           = Client.getTask(taskID);
        var hashmap  = Client.completeTask(task,artExitStateID);
        var retValue = hashmap.get("retValue");
        //returns true if it starts successfully;false otherwise

Parameters:: t - the given Task; stateID - the given atrifact state id
Returns:: the result ( [Key:Value] = [retValue:Boolean(true)] )
Since:: version 1.0.3
See Also:: Task

createArtInstance

PASEartInstance createArtInstance(java.lang.String aID)

Create artifact instance.

Examples:

        var aID  = "ART0099992486182440";
        var PASEartInstance = Client.createArtInstance(aID);
        //returns PASEartInstance object

Here are some more examples of how PASEartInstance can be used:

        var ArtifactName = PASEartInstance.getName();
        //returns artifact name is like "ApplyForm"

        var ArtifactID   = PASEartInstance.getArtifactID();
        //returns artifact id is like "ART0099992486182440"

Parameters:: iID - the given artifact id
Returns:: the PASEartInstanceSince:; version 1.1
See Also:: PASEartInstance





createForm
javax.swing.JPanel createForm(java.lang.String artInsID)

Create a artifact form by current artifact style in Agenda.

        
        Examples:
        
        var dlg = new Packages.javax.swing.JOptionPane();
        var panel = Client.createForm("Ans000000219219");
        if (panel != null) {
                dlg.showMessageDialog(Form,"CreatForm fail");
        }
        


Parameters:
artInsID - the given artifact instance id
Returns:
JPanel of specified artifact form.
Since:
  version 1.0.0






createForm
javax.swing.JPanel createForm(java.lang.String artInsID,
                              java.lang.String stateName,
                              boolean bRunScript)

Create a artifact form by current artifact style in Agenda.

  Notice:
  1. component enable, component visibility will be set according to
  stateName parameter, if stateName is empty then current state of this
  instance is used instead.
  2. openFormAction, okAction, closeFormAction
  scripts will be executed only when bRunScript parameter is true.
  3. The created form will provide 'save' and 'print' functions.
  i.e. The user can modify/save the data in the form and print the form
  also.

        
        Examples:
        
        Client.createForm("Ans000000219219","S1",false);
        


Parameters:
artInsID - the given artifact instance id
stateName - the prefer viewing and script-running state
bRunScript - true for running pre-Action and Action in the state defined by variable stateName
Returns:
JPanel of specified artifact form.
Since:
  version 1.1






createForm
javax.swing.JPanel createForm(java.lang.String artInsID,
                              java.lang.String stateName,
                              boolean bRunScript,
                              boolean bSave,
                              boolean print,
                              boolean canReviewProcess,
                              int x,
                              int y,
                              int width,
                              int height)

Create a artifact form by current artifact style in Agenda.

  Notice:
  1. component enable, component visibility will be set according to
  stateName parameter, if stateName is empty then current state of this
  instance is used instead.
  2. openFormAction, okAction, closeFormAction
  scripts will be executed only when bRunScript parameter is true.
  3. this method only works with jsp form.

        
        Examples:
        
        Client.createForm("Ans000000219219","S1",false,false,false,true,0,0,400,300);
        


Parameters:
artInsID - the given artifact instance id
stateName - the prefer viewing and script-running state
bRunScript - true for running pre-Action and Action in the state defined by variable stateName
bSave - show save button
print - show print and printPreview button. (only works with applet form)
canReviewProcess - show review process icon.
x - define position x.
y - define position y.
width - define width.
height - define height.
Returns:
JPanel of specified artifact form.
Since:
  version 1.1






createForm
javax.swing.JPanel createForm(java.lang.String artInsID,
                              java.lang.String stateName,
                              boolean bRunScript,
                              boolean bSave,
                              boolean print,
                              int close,
                              int x,
                              int y,
                              int width,
                              int height)

Create a artifact form by current artifact style in Agenda.

  Notice:
  1. component enable, component visibility will be set according to
  stateName parameter, if stateName is empty then current state of this
  instance is used instead.
  2. openFormAction, okAction, closeFormAction
  scripts will be executed only when bRunScript parameter is true.
  3. this method only works with applet form and java client.

        
        Examples:
        
        Client.createForm("Ans000000219219","S1",false,false,false,javax.swing.WindowConstants.DO_NOTHING_ON_CLOSE,0,0,400,300);
        


Parameters:
artInsID - the given artifact instance id
stateName - the prefer viewing and script-running state
bRunScript - true for running pre-Action and Action in the state defined by variable stateName
bSave - show save button
print - show print and printPreview button. (only works with applet form)
close - would be WindowConstants.DO_NOTHING_ON_CLOSE, WindowConstants.HIDE_ON_CLOSE, WindowConstants.DISPOSE_ON_CLOSE. (only works with applet form)
x - define position x. (only works with applet form)
y - define position y. (only works with applet form)
width - define width. (only works with applet form)
height - define height. (only works with applet form)
Returns:
JPanel of specified artifact form.
Since:
  version 1.1






createFormExt
void createFormExt(java.lang.String artInsID,
                   java.lang.String stateName,
                   boolean isRunScript,
                   boolean canSave,
                   boolean canPrint,
                   boolean canReviewProcess)

Opens a form with the specified parameters. If the given artifact
 instance is associated a task and the canReviewProcess is true, the
 form will provide information of the Task(such as Task attachments,
 notes, counter sign result, added announce/sign result, process review
 ...etc). If the atifact instance is not associated any task, the
 canReviewPorcess parameter will be inefficacious(ignored).

 Notice:
 1. This method is implemented in Web application(JSP or Applet) only.
 2. component enable, component visibility will be set according to
  stateName parameter, if stateName is empty then current state of this
  instance is used instead.
 3. openFormAction, okAction, closeFormAction
  scripts will be executed only when bRunScript parameter is true.


Parameters:
artInsID - the given artifact instance ID
stateName - the state name for running script
isRunScript - a flag denotes if the created form will run the
                scripts of the state name
canSave - a flag denotes if the user can modify the fields
                of the created form
canPrint - a flag denotes if the user can print the created
                form
canReviewProcess - a flag denotes if the user can review information
                of the Task that was associated the given artifact instance. This
                parameter will be ignored if the given artifact intance is not
                associated any Task.
Since:
  2.2.2.2






createProcess
java.lang.String createProcess(java.lang.String proID,
                               java.util.HashMap args)

Create an auto-popup process and assign to current operator.

        
        Examples:
        
        var proID = "PRO0548992486182550";
        var args = new java.util.HashMap();

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(proID,args);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        var MyTask = Form.getCurrentTask();
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
proID - the process id of the process intended to be created
args - a HashMap containing optional data provided to the new process (example: [Key:Value] = [retValue:Boolean(true/false)])
Returns:
the created root task's id
Since:
  version 1.0.0






createProcess
java.lang.String createProcess(java.lang.String proID,
                               java.util.HashMap args,
                               boolean isPopUp)

Create a process by specified isPopUp value and assign to current operator.
  Note:JSP WebForm does not implement this method.

        
        Examples:
        
        var proID = "PRO0548992486182550";
        var args = new java.util.HashMap();
        var isPopUp = false;

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(proID,args,isPopUp);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        var MyTask = Form.getCurrentTask();
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
proID - the process id of the process intended to be created
args - a HashMap data containing optional data provided to the new process ( [Key:Value] = [retValue:Boolean(true/false)])
isPopUp - true if it will auto-PopUp the frame; false otherwise.
Returns:
the created root task's id
Since:
  version 1.0.3






createProcess
java.lang.String createProcess(java.lang.String userID,
                               java.lang.String proID,
                               java.util.HashMap args)

Create a non-auto-PopUp process and assign to specified member id.

        
        Examples:
        
        var userID = "MEM0000992492169920";
        var proID = "PRO0548992486182550";
        var args = new java.util.HashMap();

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(userID,proID,args);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        var MyTask = Form.getCurrentTask();
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
userID - the given member id
proID - the process id of the process intended to be created
args - a HashMap containing optional data provided to the new process (example: [Key:Value] = [retValue:Boolean(true/false)])
Returns:
the created root task's id
Since:
  version 1.0.3






createProcess
java.lang.String createProcess(java.lang.String userID,
                               java.lang.String proID,
                               java.util.HashMap args,
                               boolean isPopUp)

Create a process by specified isPopUp value and assign to specified member id.
  Note:JSP WebForm does not implement this method.

        
        Examples:
        
        var userID = "MEM0000992492169920";
        var proID = "PRO0548992486182550";
        var args = new java.util.HashMap();
        var isPopUp = false;

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(userID,proID,args,isPopUp);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        var MyTask = Form.getCurrentTask();
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
userID - the given member id
proID - the process id of the process intended to be created
args - a HashMap containing optional data provided to the new process (example: [Key:Value] = [retValue:Boolean(true/false)])
isPopUp - true if it will auto-PopUp the frame; false otherwise.
Returns:
the created root task's id
Since:
  version 1.0.3






createProcess
java.lang.String createProcess(java.lang.String userID,
                               java.lang.String proID,
                               java.util.HashMap args,
                               boolean isPopUp,
                               boolean isDelible)

Create a process by specified isPopUp and isDelible value and assign to specified member id.
  Note:JSP WebForm does not implement this method.

        
        Examples:
        
        var userID = "MEM0000992492169920";
        var proID  = "PRO0548992486182550";
        var args = new java.util.HashMap();
        var isPopUp   = false;
        var isDelible = true;

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(userID,proID,args,isPopUp,isDelible);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        var MyTask = Form.getCurrentTask();
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
userID - the given member id
proID - the process id of the process intended to be created
args - a HashMap containing optional data provided to the new process (example: [Key:Value] = [retValue:Boolean(true/false)])
isPopUp - true if it will auto-PopUp the frame; false otherwise.
isDelible - true if it's delible; false otherwise.
Returns:
the created root task's id
Since:
  version 1.0.3






createProcess
java.lang.String createProcess(java.lang.String userID,
                               java.lang.String roleID,
                               java.lang.String proID,
                               java.util.HashMap args,
                               boolean isPopUp,
                               boolean isDelible,
                               java.lang.String taskID,
                               java.lang.String dtTemplateID,
                               boolean isShowMonitorRelation)

Create a process by specified isPopUp and isDelible and isShowMonitorRelation value and assign to specified
  member id and use the specified DataTransferTemplate.
  Note:JSP WebForm does not implement this method.

        
        Examples:
        
        var userID = "MEM0000992492169920";
        var member = Client.getMember(userID);
        var roleID = member.getMainRoleID();
        var proID  = "PRO0548992486182550";
        var args = new java.util.HashMap();
        var isPopUp   = false;
        var isDelible = true;
        var MyTask = Form.getCurrentTask();
        var taskID = MyTask.getID();
        var dtTemplateID = "DTT01701098176268071";
        var isShowMonitorRelation = false;

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(userID,roleID,proID,args,isPopUp,isDelible,taskID,dtTemplateID,isShowMonitorRelation);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
userID - the given memebr id
roleID - the given role id
proID - the process id of the process intended to be created
args - a HashMap containing optional data provided to the new process (example: [Key:Value] = [retValue:Boolean(true/false)])
isPopUp - true if it will auto-PopUp the frame; false otherwise.
isDelible - true if it's delible; false otherwise.
taskID - the task id of the task which execute this script, i.e., the task id of the current task -- the task during which this method is invoked
dtTemplateID - the given DataTransferTemplate id
isShowMonitorRelation - true if it will show monitor relation in monitor; false otherwise.
Returns:
the created root task's id
Since:
  version 2.2






createProcessByRandom
java.lang.String createProcessByRandom(java.lang.String proID,
                                       java.util.HashMap args)

Create a non-auto-PopUp process and assign to random of specified roles.

        
        Examples:
        
        var proID = "PRO0548992486182550";
        var args = new java.util.HashMap();

        //get the value of the 'txtA' component on the form, and put it into the hashmap
        args.put("txtA",Form.getValue("txtA"));

        //get the value of the 'Table' component on the form, and put it into the hashmap
        var table = Form.getComponent("Table");
        args.put("TableRowList",table.getRowList());

        //invoke the 'createProcess' method providing the prepared data -- 'txtA' and 'Table' values
        var rootTaskID = Client.createProcess(proID,args);

        //add a monitor relation from the current task to the newly created task --
        // and the new task will be shown in the task monitering page.
        var MyTask = Form.getCurrentTask();
        MyTask.addMonitorRelation(rootTaskID);
        Client.updateTask(MyTask);
        


Parameters:
proID - the process id of the process intended to be created
args - a HashMap containing optional data provided to the new process (example: [Key:Value] = [retValue:Boolean(true/false)])
Returns:
the created root task's id
Since:
  version 1.0.3






createScheduleEvent
ScheduleEvent createScheduleEvent()

Create new ScheduleEvent

        
        Examples:
        
        var event = Client.createScheduleEvent();
        



Returns:
new ScheduleEvent





createSessionConnection
SessionConnection createSessionConnection(int seq)

Create a SessionConnection object with database configuration,
  by the specific sequence.

        
        Examples:
        
        var conn = Client.createSessionConnection(1);
        var prjList = conn.loadValue("SELECT * FROM Project");
  for(var i=0;i<prjList.size();i++){
                var prj = prjList.get(i);
                java.lang.System.out.println(prj);
        }

  var result = conn.updateValue("UPDATE Project SET Name = 'ProjectName' WHERE Name = 'Project Name'");
  java.lang.System.out.println("Is the updated result(true/false) complete?" + result);
        conn.commit();

        conn.close();
        


Parameters:
seq - the sequence which the data is store in configuration, from 1
Returns:
the SessionConnection object which have connected to database
Since:
  version 1.1.5
See Also:
SessionConnection





createSessionConnection
SessionConnection createSessionConnection(java.lang.String name)

Create a SessionConnection object with database configuration,
  by the specific name.

        
        Examples:
        
        var conn = Client.createSessionConnection("MS-SQL1");
        var prjList = conn.loadValue("SELECT * FROM Project");
  for(var i=0;i<prjList.size();i++){
                var prj = prjList.get(i);
                java.lang.System.out.println(prj);
        }

  var result = conn.updateValue("UPDATE Project SET Name = 'ProjectName' WHERE Name = 'Project Name'");
  java.lang.System.out.println("Is the updated result(true/false) complete?" + result);
        conn.commit();

        conn.close();
        


Parameters:
name - the name to recognize the db configuration
Returns:
the SessionConnection object which have connected to database
Since:
  version 2.0.0
See Also:
SessionConnection





deleteCompany
boolean deleteCompany(Company company)

Delete a Company in organization.

        
        Examples:
        
        Client.deleteCompany(company);
        


Parameters:
company - Company instance
Returns:
true if succeeded
See Also:
Company





deleteDepartment
boolean deleteDepartment(Department dep)

Delete a Department in organization.

        
        Examples:
        
        Client.deleteDepartment(dep);
        


Parameters:
dep - Department instance
Returns:
true if succeeded
See Also:
Department





deleteGlobals
boolean deleteGlobals(java.lang.String rootTaskID)

Delete globals.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var rootTaskID=task.getRootID();
        var Result=Client.deleteGlobals(rootTaskID);
        //returns true if it deletes successfully; false otherwise
        


Parameters:
rootTaskID - the given root task id
Returns:
true if it deletes successfully; false otherwise
Since:
  version 1.0.3






deleteMemberRecord
boolean deleteMemberRecord(MemberRecord mbr)

Delete a MemberRecord in organization.

        
        Examples:
        
        Client.deleteMemberRecord(member);
        


Parameters:
mbr - MemberRecord instance
Returns:
true if succeeded
See Also:
MemberRecord





deletePASEMessage
boolean deletePASEMessage(PASEMessage msg)

Delete message from database.

        
        Examples:
        
        var MessageList = Client.getPASEMessageOfMember("MEM0000992492169920");
        if(MessageList != null) {
                for(var i=0;i<MessageList.size();i++){
                        var msg=MessageList.get(i);
                        var Result = Client.deletePASEMessage(msg);
                        //returns true if it's successful; false otherwise
                }
        }
        


Parameters:
msg - the given message. msg.SendID, msg.RecID, msg.SendTime are used as key to delete the message.
Returns:
true if the delete is successful; false otherwise.
Since:
  version 1.0.0
See Also:
PASEMessage





deleteRole
boolean deleteRole(Role role)

Delete a Role in organization.

        
        Examples:
        
        Client.deleteRole(role);
        


Parameters:
mbr - Role instance
Returns:
true if succeeded
See Also:
Role





deleteSessionConnectionURL
java.util.HashMap deleteSessionConnectionURL(java.lang.String name)

Delete a db URL from db configuration. It may influence other configuration's sequence number.

        
        Examples:
        
        Client.deleteSessionConnectionURL("MS-SQL1");
        


Parameters:
name - the name to recognize the db configuration
Returns:
the HashMap object which shows the deleted configuration
Since:
  version 2.0.0






deleteTaskAttachedFile
boolean deleteTaskAttachedFile(java.lang.String fileID)

Get file content of the specified task attached file.

        
        Examples:
        
        var fileInfo  = new TaskAttachedFileInfo();
        var fileID = fileInfo.getFileID();
        var result = Client.deleteTaskAttachedFile(fileID);
        


Parameters:
fileID - the given String fileID
Returns:
if deletion is successful
Since:
  version 2.0






forceCompleteATask
boolean forceCompleteATask(Task parentTask)

Completea an task, which task type is "Add Announce Sign".

        
        Examples:
        
        var ret = Client.forceCompleteATask(Form.getCurrentTask());
        


Parameters:
parentTask - the given Parent Task
Returns:
true if successful.
Since:
  version 2.0.0
See Also:
Task





forceReassignTask
boolean forceReassignTask(java.lang.String p_TaskID,
                          java.lang.String p_MemID)

Force to reassign the task.

  
  Examples:
  
  var taskID = "Tsk000000226229";
  var memID = "MEM0000000334532";
  var Result = Client.forceReassignTask(p_TaskID, p_MemID);
      returns true if it sets successfully ;false otherwise
  


Parameters:
p_TaskID - the given TaskID
p_MemID - the given MemberRecordID
Returns:
true if succeeded
Since:
  version 2.2.4






getAddSignTaskList
java.util.Vector getAddSignTaskList(java.lang.String signTaskId)

get AddCSResultData list of the same singTaskId


Parameters:
signTaskId - signTaskId;
Returns:
Vector a AddCSResultData list





getAllCSSignResult
java.util.Vector getAllCSSignResult(java.util.Vector parseTaskList)








getAllDepartmentByName
java.util.Vector getAllDepartmentByName(java.lang.String mName)

Get all departments with the same name.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var mName = mdr.getDepartmentName();
        var DepartmentList = Client.getAllDepartmentByName(mName);
        if(DepartmentList != null) {
                for(var i=0;i<DepartmentList.size();i++){
                        var department = DepartmentList.get(i);
                        //returns a Department object
                }
        }
        


Parameters:
mName - the given department name
Returns:
all departments that match the name (each element in Vector are instance of Department)
Since:
  version 1.1
See Also:
Department





getAllDepIDOfCompany
java.util.Vector getAllDepIDOfCompany()

Get all departments' IDs in the company.

        
        Examples:
        
        var departmentIDList = Client.getAllDepIDOfCompany();
        for(var i=0;i<departmentIDList.size();i++){
                var depID = departmentIDList.get(i);
        }
        



Returns:
all departments' id (each element in Vector are String)
Since:
  version 2.1
See Also:
Department





getAllDepNameOfCompany
java.util.Vector getAllDepNameOfCompany()

Get all departments' name in the company.

        
        Examples:
        
        var DepartmentNameList = Client.getAllDepNameOfCompany();
        for(var i=0;i<DepartmentNameList.size();i++){
                var Result = DepartmentNameList.get(i)
                //returns a department name is like "MIS Department"
        }
        



Returns:
all departments' name (each element in Vector are String)
Since:
  version 1.1
See Also:
Department





getAllIapSignResult
java.util.Vector getAllIapSignResult(java.lang.String iapTaskID)








getAllManager
java.util.List getAllManager(MemberRecord mbr,
                             boolean mainRoleOnly)

Get All mamager with the specified MemberRecord


Parameters:
mbr - the given MemberRecord
mainRoleOnly - whether only search manager of main role of member
Returns:
all manager members (element in List is the
         MemberRecord instance)
Since:
  version 2.2.5






getAllManagerByID
java.util.List getAllManagerByID(java.lang.String memId)

Get All mamager with the specified member id


Parameters:
memId - the given member id
Returns:
all manager members (element in List is the
         MemberRecord instance)
Since:
  version 2.2.5






getAllManagerByLoginID
java.util.List getAllManagerByLoginID(java.lang.String loginId)

Get All mamager with the specified member's login id


Parameters:
loginId - the given member's login id
Returns:
all manager members (element in List is the
         MemberRecord instance)
Since:
  version 2.2.5






getAllManagerByNo
java.util.List getAllManagerByNo(java.lang.String memNo)

Get All mamager with the specified member No.


Parameters:
memNo - the given member No.
Returns:
all manager members (element in List is the
         MemberRecord instance)
Since:
  version 2.2.5






getAllMember
java.util.Vector getAllMember()

Return all member of system


Since:
  version 2.0.4
See Also:
MemberRecord





getAllMemberByCName
java.util.Vector getAllMemberByCName(java.lang.String mName)

Get all members with the same name.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mName = mrd.getName();
        var MemberList = Client.getAllMemberByCName(mName);
        if(MemberList != null) {
                for(var i=0;i<MemberList.size();i++){
                        var memberRecord = MemberList.get(i);
                        //returns a MemberRecord object
                }
        }
        


Parameters:
mName - the given member name
Returns:
all MemberRecord objects (each element in Vector are instance of MemberRecord)
Since:
  version 1.1
See Also:
MemberRecord





getAllProcess
java.util.Vector getAllProcess()

Note: JSP WebForm does not implement this method.


Since:
  version 1.0.0
See Also:
getPASEProcessOfMember(String)





getAllProjectRoleByName
java.util.Vector getAllProjectRoleByName(java.lang.String mName)

Get All Project Role Objects by the same Name.

        
        Examples:
        
        var PrjRoleList = Client.getAllProjectRoleByName(mName);
        if(PrjRoleList != null) {
                for(var i=0;i<PrjRoleList.size();i++) {
                        var prjrole = PrjRoleList.get(i);
                        //returns a ProjectRole object
                }
        }
        


Parameters:
mName - the given ProjectRoleName
Returns:
all roless (each element in Vector are instance of ProjectRole)
Since:
  version 2.0
See Also:
ProjectRole





getAllRoleByName
java.util.Vector getAllRoleByName(java.lang.String mName)

Get all roles with the same name.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var mName = mdr.getRoleName();
        var RoleList = Client.getAllRoleByName(mName);
        if(RoleList != null) {
                for(var i=0;i<RoleList.size();i++){
                        var role = RoleList.get(i);
                        //returns a Role object
                }
        }
        


Parameters:
mName - the given role name
Returns:
all Role objects (each element in Vector are instance of Role)
Since:
  version 1.1
See Also:
Role





getAllRoleIDOfCompany
java.util.Vector getAllRoleIDOfCompany()

Get all role id in the company.

        
        Examples:
        
        var roleIDList = Client.getAllRoleIDOfCompany();
        if(roleIDList != null) {
                for(var i=0;i<roleIDList.size();i++){
                        var roleID = roleIDList.get(i);
                }
        }
        



Returns:
all role IDs (each element in Vector are String)
Since:
  version 2.1
See Also:
Role





getAllRoleNameOfCompany
java.util.Vector getAllRoleNameOfCompany()

Get all role name in the company.

        
        Examples:
        
        var roleNameList = Client.getAllRoleNameOfCompany();
        if(roleNameList != null) {
                for(var i=0;i<roleNameList.size();i++){
                        var roleName = roleNameList.get(i);
                        //returns a role name is like "general manager"
                }
        }
        



Returns:
all role names (each element in Vector are String)
Since:
  version 1.1
See Also:
Role





getAllUnitType
java.util.Vector getAllUnitType()

Get All Unit Types



Returns:
all unit types in the organization(element in Vector
         is the UnitType
Since:
  version 2.2.5






getAllUnitType
java.util.Vector getAllUnitType(int levelNumber,
                                int relation,
                                java.lang.String orderBy)

Get All UnitTypes with the specified level number, relation and orderBy


Parameters:
levelNumber - the given level number
relation - the given relation of levelNumber, UnitType.GT indicates
            greater than, UnitType.EQ indicates equal, UnitType.LT
            indicates less than.
orderBy - the given unit type order, UnitType.DESC or UnitType.ASC
Returns:
all unit types that conform these conditions (element in Vector
         is the UnitType
Since:
  version 2.2.5
See Also:
UnitType





getApplication
java.lang.String getApplication(java.lang.String type)

Get the registered file type mapping.

        
        Examples:
        
        var type = "html";
        var Result = Client.getApplication(type);
        //returns registered file type mapping is like "C:\Program Files\Internet Explorer\IEXPLORE.EXE"
        


Parameters:
type - the given secondary filename
Returns:
true if it removes successfully; false otherwise
Since:
  version 1.0.0






getArtifact
Artifact getArtifact(java.lang.String aID)

Get artifact by the specified artifact id.

        
        Examples:
        
        var aID  = "ART0101993090926140";
        var Artifact = Client.getArtifact(aID);
        //returns a Artifact object
        


Parameters:
aID - the given artifact id
Returns:
the Artifact object
Since:
  version 1.0.0
See Also:
Artifact





getArtifactForm
java.util.Vector getArtifactForm(java.lang.String aID)

Get artifact forms of the specified artifact.

        
        Examples:
        
        var aID = "ART0101993090926140";
        var ArtFormList = Client.getArtifactForm(aID);
        for (var i=0;i<ArtFormList.size();i++) {
                var ArtFormItem=ArtFormList.get(i);
                //returns a ArtFormItem object
        }
        


Parameters:
aID - the given artifact id
Returns:
the correspondence artifact forms(each element in Vector are instance of ArtFormItem)
Since:
  version 1.0.0
See Also:
ArtFormItem





getArtifactOfCompany
java.util.Vector getArtifactOfCompany()

Get all artifacts in the company.

        
        Examples:
        
        var ArtifactList = Client.getArtifactOfCompany();
        if(ArtifactList != null) {
                for(var i=0;i<ArtifactList.size();i++){
                        var Artifact =ArtifactList.get(i);
                        //returns a Artifact object
                }
        }
        



Returns:
all artifacts (each element in Vector are instance of Artifact)
Since:
  version 1.0.0
See Also:
Artifact





getArtifactOfProject
java.util.Vector getArtifactOfProject(java.lang.String prjID)

Get all artifacts which will be used by the specified project.

        
        Examples:
        
        var prjID  = "PRJ0023992486182440";
        var ArtifactList = Client.getArtifactOfProject(prjID);
        if(ArtifactList != null) {
                for(var i=0;i<ArtifactList.size();i++){
                        var Artifact =ArtifactList.get(i);
                        //returns a Artifact Object
                }
        }
        


Parameters:
prjID - the given project id
Returns:
the correspondence artifacts(each element in Vector are instance of Artifact)
Since:
  version 1.0.0
See Also:
Artifact





getArtInsDefaultMap
java.util.HashMap getArtInsDefaultMap(java.lang.String properties,
                                      java.lang.String artState,
                                      java.lang.String dbType,
                                      Task task,
                                      java.lang.String artID,
                                      java.lang.String[] priorityLocaleStr)

Returns the artifact instance default value map.
 key: the atrifact item name
 value: the default value at the given artifact state and execution timing.








getArtInstance
PASEartInstance getArtInstance(java.lang.String iID)

Get artifact instance by the specified instance id.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var iID  = task.getInstanceID();
        var PASEartInstance = Client.getArtInstance(iID);
        //returns PASEartInstance object
        

        
        Here are some more examples of how PASEartInstance can be used:
        
        var ArtifactName = PASEartInstance.getName();
        //returns artifact name is like "ApplyForm"

        var ArtifactID   = PASEartInstance.getArtifactID();
        //returns artifact id is like "ART0099992486182440"
        


Parameters:
iID - the given artifact instance id
Returns:
the PASEartInstance object
Since:
  version 1.0.0
See Also:
PASEartInstance





getArtInstance
PASEartInstance getArtInstance(java.lang.String iID,
                               java.lang.String tID)

Get artifact instance with the specified instance id and task id.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var iID  = task.getInstanceID();
        var tID  = task.getID();
        var PASEartInstance = Client.getArtInstance(iID,tID);
        //returns PASEartInstance object
        

        
        Here are some more examples of how PASEartInstance can be used:
        
        var ArtifactName = PASEartInstance.getName();
        //returns artifact name is like "ApplyForm"

        var ArtifactID   = PASEartInstance.getArtifactID();
        //returns artifact id is like "ART0099992486182440"
        


Parameters:
iID - the given artifact instance id
tID - the given task id
Returns:
the PASEartInstance object
Since:
  version 1.0.0
See Also:
PASEartInstance





getArtTskID
java.lang.String getArtTskID(java.lang.String iID)

Get the latest associated TaskID with the Artifact Instance.

        
        Examples:
        
        var latestTskID = Client.getArtTskID(artInsID);
        


Parameters:
iID - the given artifact instance id
Returns:
the latest TaskID
Since:
  version 1.2






getATaskNote
java.util.HashMap getATaskNote(java.lang.String tskID)

Get all ATask information for the specified root task.
  The value of key "data" is not null when the value of key "retValue" is Boolean.TRUE.

        
        Examples:
        
        var note = Client.getATaskNote("TskXXXXXXX");
        if(note.get("retValue").booleanValue()) {
                java.lang.System.out.println("data == " + note.get("data"));
        } else {
                java.lang.System.out.println("This task has no result of add announce sign.");
        }
        


Parameters:
tskID - the given Task ID
Returns:
the result ( [Key:Value] = [data:AllATaskNote(String)] ; [retValue:Boolean(true/false)])





getAttachFilePath
java.lang.String getAttachFilePath(AttachFileInfo fileInfo)

get relative path of AttachFileInfo Object uploaded to Server Side

 
 Examples:
 
 var m_attached = Form.getComponent("AttachedFile0");
 var m_filelist = m_attached.getProperty("FileList");
 for(var i = 0, n = m_filelist.size(); i < n; ++i) {
   java.lang.System.out.println("FilePath : " + Client.getAttachFilePath(m_filelist.get(i)));
 }
 


Parameters:
AttachFileInfo - 
Returns:
the relative path of AttachFileInfo Object uploaded to Server Side





getAttachFilePath
java.lang.String getAttachFilePath(java.lang.String fid)

get relative path of AttachFileInfo Object uploaded to Server Side

 
 Examples:
 
 var m_attached = Form.getComponent("AttachedFile0");
 var m_filelist = m_attached.getProperty("FileList");
 var fid;
 for(var i = 0, n = m_filelist.size(); i < n; ++i) {
   fid = m_filelist.get(i).getFileID();
   java.lang.System.out.println("FilePath : " + Client.getAttachFilePath(fid));
 }
 


Parameters:
fid - the given AttachFileInfo's FileID
Returns:
the relative path of AttachFileInfo Object uploaded to Server Side





getClientMainFrame
java.awt.Frame getClientMainFrame()

To getting the agenda main frame.

  Note: JSP WebForm does not implement this method.

        
        Examples:
        
        var fileChooser =  new Packages.javax.swing.JFileChooser();
        var returnVal = fileChooser.showSaveDialog(Form.getMainFrame());
        if (returnVal == Packages.javax.swing.JFileChooser.APPROVE_OPTION) {
                var file = fileChooser.getSelectedFile();
                filePath = file.getPath();
                ....
        }
        



Returns:
the agenda main frame
Since:
  version 1.0.0






getClientMode
java.lang.String getClientMode()

Return the current .



Returns:
the result "JavaMode", "WebMode", "JspMode", "AdmMode"
Since:
  version 1.2






getCompany
Company getCompany()

Get company.

        
        Examples:
        
        var Company = Client.getCompany();
        //returns a Company object
        



Returns:
the Company object
Since:
  version 1.0.0
See Also:
Company





getCSSignInfo
CSSignInfo getCSSignInfo(Task task)








getCSTaskNote
java.util.Map getCSTaskNote(java.lang.String taskId)








getCurrentMember
MemberRecord getCurrentMember()

Get current member.

        
        Examples:
        
        var memberRecord = Client.getCurrentMember();
        //returns a MemberRecord object
        



Returns:
the MemberRecord object which includes the data of current member
Since:
  version 1.0.0






getDbConnectionCurrentState
java.lang.String getDbConnectionCurrentState()

Get the information about the system database connection : 
 Max. connection size, Min. connection size, Current used connection size.



Returns:
String the information string.
Since:
  V3.0






getDBProcess
DBProcess getDBProcess(java.lang.String pID)

Get DBProcess by process id

        
        Examples:
        
        var pID = "PRO0549992486182610";
        var dbProcess = Client.getDBProcess(pID);
        //returns the DBProcess object
        


Parameters:
pID - the process id
Returns:
the DBProcess object
Since:
  version 1.1
See Also:
DBProcess





getDepartment
Department getDepartment(java.lang.String dID)

Get department by the specified department id.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var dID  = task.getDepartmentID();
        var Department = Client.getDepartment(dID);
        //returns a Department object
        


Parameters:
dID - the given department id
Returns:
the Department object
Since:
  version 1.1
See Also:
Department





getDepartmentHead
MemberRecord getDepartmentHead(MemberRecord mbr,
                               boolean mainRoleOnly)

Get the manager of first unit department with the specified MemberRecord


Parameters:
mbr - the given MemberRecord
mainRoleOnly - whether only search manager of main role of member
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getDepartmentHeadByID
MemberRecord getDepartmentHeadByID(java.lang.String memId)

Get the manager of first unit department with the specified member id


Parameters:
memId - the given member id
mainRoleOnly - whether only search department of main role of member
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getDepartmentHeadByLoginID
MemberRecord getDepartmentHeadByLoginID(java.lang.String loginId)

Get the manager of first unit department with the specified member's
 login id


Parameters:
loginId - the given member's login id
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getDepartmentHeadByNo
MemberRecord getDepartmentHeadByNo(java.lang.String memNo)

Get the manager of first unit department with the specified member No.


Parameters:
memNo - the given member No.
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getDeputyMemID
java.lang.String getDeputyMemID()

Get deputy member id.

        
        Examples:
        
        var Result = Client.getDeputyMemID();
        //returns the deputy member id is like "MEM0002972876172780"
        



Returns:
the deputy member id
Since:
  version 1.0.0






getDeputyName
java.lang.String getDeputyName()

Get deputy name.

        
        Examples:
        
        var Result = Client.getDeputyName();
        //returns the deputy name is like "JackLin"
        



Returns:
the deputy name
Since:
  version 1.0.0






getEmailTemplate
EmailTemplate getEmailTemplate(java.lang.String etID)

getEmailTemplate by PROID or ETID

        
        Examples:
        
      var etID = "ETXXXXXXXXXXXXX";
      var emailTemp = Client.getEmailTemplate(etID);
      var subject = emailTemp.getSubject();
      var body = emailTemp.getBody();
      var sender = emailTemp.getSender();
      var receiver = emailTemp.getReceiver();
        


Parameters:
etID - can be etID or PROID
Since:
  version 2.2.0






getFirstLevelUnitType
UnitType getFirstLevelUnitType()

Get first unit's unit types



Returns:
the first unit's unit type
Since:
  version 2.2.5






getFlowServerIP
java.lang.String getFlowServerIP()

Get IP address of server.

        
        Examples:
        
        var Result = Client.getFlowServerIP();
        //returns IP address of server is like "192.168.8.60"
        



Returns:
the IP address of server
Since:
  version 1.0.0






getFlowServerPort
java.lang.String getFlowServerPort()

Get RMI port of server.

        
        Examples:
        
        var Result = Client.getFlowServerPort();
        //returns RMI port of server is like "1099"
        



Returns:
the RMI port of server
Since:
  version 1.0.0






getFormAPI
FormAPI getFormAPI(java.awt.Component cmp)

Get FormAPI of the specified component.


Parameters:
cmp - the given Component
Returns:
the FormAPI
Since:
  version 1.0.0
See Also:
FormAPI





getFreqApListOfMember
java.util.Vector getFreqApListOfMember(java.lang.String mID)

Get the PASEFreqAp processes of the specified member.

        
        Examples:
        
        var mID = "MEM0002993177798390";
        var PASEFreqApList = Client.getFreqApListOfMember(mID);
        if(PASEFreqApList != null) {
                for(var i=0;i<PASEFreqApList.size();i++){
                        var PASEFreqAp =PASEFreqApList.get(i);
                        //returns a PASEFreqAp object
                }
        }
        


Parameters:
mID - the given member id
Returns:
the correspondence PASEFreqAp processes(each element in Vector are instance of PASEFreqAp)
Since:
  version 1.1.5
See Also:
PASEFreqAp





getGlobals
java.util.HashMap getGlobals(java.lang.String rootTaskID)

Get globals data from previous setGlobals function.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var rootTaskID = task.getRootID();
        var ht=Client.getGlobals(rootTaskID);
        var value = ht.get("ItemName");
        //returns key value is like "Pen"
        


Parameters:
rootTaskID - the given root task id
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)])
Since:
  version 1.0.0






getGroupSignIDOfTask
java.lang.String getGroupSignIDOfTask(java.lang.String taskID)

To get group sign id of the specified task id. You can use ths group sign id to get the task ids of the same group sign id.
 Example:
   var taskID = From.getCurrentTask().getID();
  var groupSignID = Client.getGroupSignIDOfTask(taskID);
 


Parameters:
taskID - 
Returns:
String group sign id, ex: GPS000000000001
Since:
  V2.4






getGroupSignTaskIDList
java.util.List getGroupSignTaskIDList(java.lang.String groupSignID)

To get task id list of the specified group sign id. These task ids are completed at the same time by Group Sign.
 Example:
   var taskID = From.getCurrentTask().getID();
  var groupSignID = Client.getGroupSignIDOfTask(taskID);
  var taskIDList = Client.getGroupSignTaskIDList(groupSignID)
 


Parameters:
groupSignID - 
Returns:
List taskIDList. Each element is a String task id.
Since:
  V2.4






getGroupSignTaskMap
java.util.HashMap getGroupSignTaskMap(java.lang.String groupSignID)

To get a HashMap of the specified group sign id. 
 Each element(key, value) in HashMap is (String taskID, LongcompleteTime).
 These tasks are completed at the same time by Group Sign.
   var taskID = From.getCurrentTask().getID();
  var groupSignID = Client.getGroupSignIDOfTask(taskID);
  var hm = new java.util.HashMap();
  hm = Client.getGroupSignTaskMap(groupSignID);
 


Parameters:
groupSignID - 
Returns:
HashMap groupSignTaskMap. Each element(key, value) in HashMap is (String taskID, LongcompleteTime).
Since:
  V2.4






getInvolvedExecutors
java.util.Vector getInvolvedExecutors(java.lang.String rootTaskID)

Return ID list of executors who involved in the root process
        
        Examples:
        
        var v = Client.getInvolvedExecutors("Tsk000000835835");
        


Parameters:
rootTaskID - the root task id.
Since:
  version 1.1.6






getInvolvedMembers
java.util.Vector getInvolvedMembers(java.lang.String rootTaskID)

Return ID list of members who involved in the root process
        
        Examples:
        
        var v = Client.getInvolvedMembers("Tsk000000835835");
        


Parameters:
rootTaskID - the root task id.
Since:
  version 1.1.6






getLocalObject
java.lang.Object getLocalObject(java.lang.String id)

Get a local object by a special id.

        
        Examples:
        
        var myTaskList = Client.getTaskOfMember("MEM0000992492169920",Constant.TASK_STATE_ALL);
        Client.setLocalObject("myTaskList1",myTaskList);
        var list = Client.getLocalObject("myTaskList1");
        if(list != null) {
                for(var i=0;i<list.size();i++){
                        var data=list.get(i);
                        //returns element of a Vector object is like "[Tsk000000213214]Process1"
                }
        }
        


Parameters:
id - the id of local object
Returns:
the local object
Since:
  version 1.0.0






getLocalObjectMap
java.util.HashMap getLocalObjectMap()

Get a local object map which contains all local object.

        
        Examples:
        
        var localMap = Client.getLocalObjectMap();
        java.lang.System.out.println(localMap.toString());
        



Returns:
the HashMap which contains all local object
          ( key : value = local object's id : local object )
Since:
  version 1.0.0






getManager
java.lang.String[] getManager(java.lang.String id)

Get manager id by member id, role id, or department id.
 
 
 Examples:
 
 
 var mID = "MEM00041091074401237";
 var rID = "ROL00021091073923770";
 var dID = "DEP00051091073824187";
 var strAryOfMemId = Server.getManager(mID);
 var strAryOfRolId = Server.getManager(rID);
 var strAryOfDepId = Server.getManager(dID);
 
 java.lang.System.out.println("depID=" + strAryOfMemId[0]);
 java.lang.System.out.println("rolID=" + strAryOfMemId[1]);
 java.lang.System.out.println("memID=" + strAryOfMemId[2]);
 
 
 Note:

 java.lang.System.out.println("depID=" + strAryOfMemId[2]);

 will print the the depId of upward level department's manager ID.


Parameters:
id - the given member id, role id, or department id
Returns:
the String Array
Since:
  version 2.2.3






getManagerRole
Role getManagerRole(java.lang.String id)

Get manager role by the specified member, role or department ID. Note: This method returns
  the major role of the specific member if this specific member in the company is assigned
  as manager of a department.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var mID  = task.getMemberID();
        var rID  = task.getRoleID();
        var dID  = task.getDepartmentID();
        var Result_company = Client.getManagerRole("company");
        //returns a Role object
        var Result_mID     = Client.getManagerRole(mID);
        //returns a Role object
        var Result_rID     = Client.getManagerRole(rID);
        //returns a Role object
        var Result_dID     = Client.getManagerRole(dID);
        //returns a Role object
        


Parameters:
id - the given member id, role id, department id, or "company"
Returns:
the Role object which includes the data of manager
Since:
  version 1.0.3
See Also:
MemberRecord, 
Role, 
Department





getManagersOfDRM
java.util.Vector getManagersOfDRM(java.lang.String id)

Get all manager id by member id, role id, or department id.

  
  Examples:
  
  var mID  = "MEM00041091074401237";
  var rID  = "ROL00021091073923770";
  var dID  = "DEP00051091073824187";
  var Result_mID = Server.getManagersOfDRM(mID);
      //returns a Vector Object
  var Result_rID = Server.getManagersOfDRM(rID);
      //returns a Vector Object
  var Result_dID = Server.getManagersOfDRM(dID);
      //returns a Vector Object
  if(Reslut_mID != null){
        for(var i=0; i


Parameters:
id - the given member id, role id, or department id
Returns:
the Vector object (each element in Vector are array of String)
Since:
  version 2.2.3






getMember
MemberRecord getMember(java.lang.String id)

Get member by id, login id, or user name. The method is used while
  the content of parameter has not been known. Otherwise, methods  getMemberByID(),
  getMemberByName(), getMemberByCName()  is more applied.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var mID  = task.getMemberID();
        var mLoginID = "square";
        var mName= "JackLin";
        var MemberBymID = Client.getMember(mID);
        //returns a MemberRecord object
        var MemberBymLoginID = Client.getMember(mLoginID);
        //returns a MemberRecord object
        var MemberBycName = Client.getMember(mName);
        //returns a MemberRecord object
        


Parameters:
mID - the given member id, member login id, or member user name
Returns:
the MemberRecord object which includes the data of member
Since:
  version 1.0.0
See Also:
MemberRecord, 
getMemberByID(String), 
getMemberByName(String), 
getMemberByCName(String)





getMemberAccess
AccessMember getMemberAccess()

Get current member function right

        
        Examples:
        
        var accessMember = Client.getMemberAccess();
        //returns the AccessMember object
        



Returns:
the AccessMember object
Since:
  version 1.1
See Also:
AccessMember





getMemberByCName
MemberRecord getMemberByCName(java.lang.String mName)

Get member by the specified user name.

        
        Examples:
        
        var mName  = "JackLin";
        var MemberRecord = Client.getMemberByCName(mName);
        //returns a MemberRecord object
        


Parameters:
mLoginID - the given member user name
Returns:
the MemberRecord object which includes the data of member
Since:
  version 1.0.0
See Also:
MemberRecord





getMemberByID
MemberRecord getMemberByID(java.lang.String mID)

Get member by the specified member id.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var mID  = task.getMemberID();
        var MemberRecord = Client.getMemberByID(mID);
        //returns a MemberRecord object
        


Parameters:
mID - the given member id
Returns:
the MemberRecord object which includes the data of member
Since:
  version 1.0.0
See Also:
MemberRecord





getMemberByName
MemberRecord getMemberByName(java.lang.String mLoginID)

Get member by the specified login id.

        
        Examples:
        
        var mLoginID = "square";
        var MemberRecord = Client.getMemberByName(mLoginID);
        //returns a MemberRecord object
        


Parameters:
mID - the given member login id
Returns:
the MemberRecord object which includes the data of member
Since:
  version 1.0.0
See Also:
MemberRecord





getMemberInfoByTree
java.lang.String[] getMemberInfoByTree(int left,
                                       int top,
                                       int width,
                                       int height)

Show the dialog of organization tree and return member info.
  String[0] to String[5] for (0)deppartment id, 
                                                           (1)role id, 

                                                           (2)member id, 

                                                           (3)department name, 

                                                           (4)role name, 

                                                           (5)member name 


  Note: JSP WebForm does not implement this method.

        

        Examples:
        
            var s = Client.getMemberInfoByTree(0,0,120,120);
                java.lang.System.out.println("Department ID" + s[0]);
                java.lang.System.out.println("Role ID" + s[1]);
                java.lang.System.out.println("Member ID" + s[2]);
                java.lang.System.out.println("Department name" + s[3]);
                java.lang.System.out.println("Role name" + s[4]);
                java.lang.System.out.println("Member name" + s[5]);
        


Parameters:
left - the left position of the dialog
top - the top position of the dialog
width - the width of the dialog
height - the height of the dialog
Returns:
the String array which includes current member info
Since:
  version 1.0.0






getMemID
java.lang.String getMemID(java.lang.String loginID)

Get member id by the specified login id

        
        Examples:
        
        var memID = Client.getMemID("Jacky");
        


Parameters:
loginID - the given login id
Returns:
the member id
Since:
  version 1.0.0






getNewArtInsID
java.lang.String getNewArtInsID()

Create a new artifact instance id

        
        Examples:
        
        var newArtID = Client.getNewArtInsID();
        



Returns:
a new artifact instance id
Since:
  version 1.0.0






getNewFileID
java.lang.String getNewFileID()

Create a new attached file id

        
        Examples:
        
        var newfileID = Client.getNewFileID();
        



Returns:
a new attached file id
Since:
  version 2.0






getNextManager
MemberRecord getNextManager(MemberRecord mbr)

Get Next manger with the specified MemberRecord


Parameters:
mbr - the given MemberRecord
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManager
MemberRecord getNextManager(MemberRecord mbr,
                            int levelNumber)

Get Next manger with the specified MemberRecord and level
 of unit type


Parameters:
mbr - the given MemberRecord
levelNumber - the given unit type's level
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManagerByID
MemberRecord getNextManagerByID(java.lang.String memId)

Get Next manger with the specified member id


Parameters:
memId - the given member id
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManagerByID
MemberRecord getNextManagerByID(java.lang.String memId,
                                int levelNumber)

Get Next manger with the specified member id and level of unit type


Parameters:
memId - the given member id
levelNumber - the given unit type's level
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManagerByLoginID
MemberRecord getNextManagerByLoginID(java.lang.String loginId)

Get Next manger with the specified member's login id


Parameters:
loginId - the given member's login id
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManagerByLoginID
MemberRecord getNextManagerByLoginID(java.lang.String loginId,
                                     int levelNumber)

Get Next manger with the specified member's login id and level of unit
 type


Parameters:
loginId - the given member's login id
levelNumber - the given unit type's level
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManagerByNo
MemberRecord getNextManagerByNo(java.lang.String memNo)

Get Next manger with the specified member No.


Parameters:
memNo - the given member No.
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getNextManagerByNo
MemberRecord getNextManagerByNo(java.lang.String memNo,
                                int levelNumber)

Get Next manger with the specified member No. and level of unit type


Parameters:
memNo - the given member No.
levelNumber - the given unit type's level
Returns:
MemberRecord of this manager
Since:
  version 2.2.5






getOneDepartmentByName
Department getOneDepartmentByName(java.lang.String mName)

Get department by the specified department Name.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var mName = mdr.getDepartmentName();
        var DepartmentList = Client.getOneDepartmentByName(mName);
        //returns a Department object
        


Parameters:
mName - the given department name
Returns:
the Department object
Since:
  version 1.1
See Also:
Department





getOneRoleByName
Role getOneRoleByName(java.lang.String mName)

Get one role by the specified role name.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var mName = mdr.getRoleName();
        var role = Client.getOneRoleByName(mName);
        //returns a Role object
        


Parameters:
mName - the given role name
Returns:
the Role object
Since:
  version 1.1
See Also:
Role





getOnLineUser
java.util.Vector getOnLineUser()

Get all on-line member list

        
        Examples:
        
        var onlineUserList = Client.getOnLineUser();
        for(var i = 0;i < onlineUserList.size();i++) {
                var member = onlineUserList.get(i);
                //returns MemberRecord object
        }
        



Returns:
all on-line members (each element in Vector are instance of MemberRecord)
Since:
  version 1.1
See Also:
MemberRecord





getParentIDListOfMember
java.util.Vector getParentIDListOfMember(java.lang.String memID,
                                         boolean isMainRoleOnly)

Get All parent CompanyID, RolID, DepID, MemID of Member.
        
        Examples:
        
        var mID = "MEM000003495111";
        var parentIDList = Client.getParentIDListOfMember(mID, true);
        


Parameters:
memID - the given MemberID
isMainRoleOnly - if "true", only the MainRole will be retrived. "false" for all role will be retrived.
Returns:
all parent ID (each element in Vector are CompanyID, RoleID, DepID or MemID)





getPASEOrgModel
PASEOrgModel getPASEOrgModel()

Get the PASEOrgModel.

        
        Examples:
        
        var paseOrgModel = Client.getPASEOrgModel();
        //returns the PASEOrgModel object
        



Returns:
the PASEOrgModel object
Since:
  version 1.1
See Also:
PASEOrgModel





getPASEProcessOfMember
java.util.Vector getPASEProcessOfMember(java.lang.String mID)

Get the root processes of the specified member.

        
        Examples:
        
        var mID = "MEM0002993177798390";
        var PASEProcessList = Client.getPASEProcessOfMember(mID);
        if(PASEProcessList != null) {
                for(var i=0;i<PASEProcessList.size();i++){
                        var PASEProcess =PASEProcessList.get(i);
                        //returns a PASEProcess object
                }
        }
        


Parameters:
mID - the given member id
Returns:
the correspondence root processes(each element in Vector are instance of PASEProcess)
Since:
  version 1.0.0
See Also:
PASEProcess





getPDiagramDetail
java.util.Vector getPDiagramDetail(java.lang.String rootTID)

Get the detail of process diagram.

        
        Examples:
        
        var currTask= Form.getCurrentTask();
        var rootTID     = currTask.getRootID();
        var Result      = Client.getPDiagramDetail(rootTID);
        for(var i=0;i<Result.size();j++) {
                var taskInfo = Result.get(i);
                //returns TaskInfo object
        }
        

        
        Here are some more examples of how TaskInfo can be used:
        

        function getFormatedTime( lTime ){
                var date = new Packages.java.util.Date(lTime);
                var simpledateformat = new Packages.java.text.SimpleDateFormat("yyyy/MM/dd HH:mm");
                return simpledateformat.format(date);
        }

        var taskName = taskInfo.getTaskName();
        //returns task name is like "Process1"

        var RealExecutorName = taskInfo.getRealExecutorName();
        //returns real executor name is like "JackLin"

        var RealExecutorID = taskInfo.getRealExecutorID();
        //returns real executor member id is like "MEM0000992492169920"

        var DefaultExecutorName = taskInfo.getDefaultExecutorName();
        //returns default executor name is like "Jean"

        var DefaultExecutorID = taskInfo.getDefaultExecutorID();
        //returns default executor member id is like "MEM0000212392162210"

        var ArtiName = taskInfo.getArtiName();
        //returns artifact name is like "Artifact1"

        var ArtiKeyWord = taskInfo.getArtiKW();
        //returns artifact keyword by user input

        var ArriTime = taskInfo.getArriTime();
        //returns task arrivate time is like 993524946300

        var ArriTimeStr = getFormatedTime(ArriTime);
        //returns the time formate of arrivate time is like "2001/06/26 11:09"

        var DuraTime = taskInfo.getDuraTime();
        //returns duration time is like -993524946300

        var DuraTimeStr = getFormatedTime(DuraTime);
        //returns the time formate of duration time is like "1938/07/09 04:50"

        var TaskID = taskInfo.getTaskID();
        //returns task id is like "Tsk000000258259"

        var ArtiID = taskInfo.getArtiID();
        //returns artifact instance id is like "Ans000000248248"

        var TaskState = taskInfo.getTaskState();
        //returns task state is like "running"

        var Task = taskInfo.getTask();
        //returns Task object
        


Parameters:
rootPID - the given process id
Returns:
the detail information in process diagram
Since:
  version 1.0.0
See Also:
PDiagramManager, 
PDiagramManager.getPDiagramDetail





getPDiagramState
java.util.HashMap getPDiagramState(java.lang.String rootTID)

Get the states of process diagram.

        
        Examples:
        
        var task    = Form.getCurrentTask();
        var rootTID = task.getRootID();
        var Result  =  Client.getPDiagramState(rootTID);
        for(var i = Result.entrySet().iterator();i.hasNext(); ){
                var entry = i.next();
                //returns "PRO0549992486182610Root_POPUP_DELIBLE=running"
        };
        


Parameters:
rootPID - the given process id
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)])
Since:
  version 1.0.0
See Also:
PDiagramManager, 
PDiagramManager.getPDiagramState





getProcessDiagram
java.util.HashMap getProcessDiagram(java.lang.String rootPID,
                                    java.lang.String rootTaskID)

Get a process diagram.

        
        Examples:
        
        var currtask   = Form.getCurrentTask();
        var rootTaskID = currtask.getRootID();
        var task       = Client.getTask(rootTaskID);
        var rootPID    = task.getProcessID();
        var Result     = Client.getProcessDiagram(rootPID,rootTaskID);
      //return a HashMap object which includes the data of process diagram
        for(var i = Result.entrySet().iterator();i.hasNext(); ){
                var entry = i.next();
        };
        


Parameters:
rootPID - the given process id
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)])
Since:
  version 1.0.0
See Also:
PDiagramManager, 
PDiagramManager.getProcessDiagram





getProject
Project getProject(java.lang.String prjID)

Get project by the specified project id.

        
        Examples:
        
        var task  = Form.getCurrentTask();
        var prjID = task.getProjectID();
        var Project = Client.getProject(prjID);
        //returns a Project object
        


Parameters:
prjID - the given project id
Returns:
the Project object
Since:
  version 1.0.0
See Also:
Project





getProjectOfCompany
java.util.Vector getProjectOfCompany()

Get all projects in the company.

        
        Examples:
        
        var ProjectList = Client.getProjectOfCompany();
        if(ProjectList != null) {
                for(var i=0;i<ProjectList.size();i++){
                        var Project =ProjectList.get(i);
                        //returns a Project object
                }
        }
        



Returns:
all projects (each element in Vector are instance of Project)
Since:
  version 1.0.0
See Also:
Project





getProjectOfDepartment
java.util.Vector getProjectOfDepartment(java.lang.String dID)

Get the projects in the specified department.

        
        Examples:
        
        var dID = "DEP0000972876387719";
        var ProjectList = Client.getProjectOfDepartment(dID);
        if(ProjectList != null) {
                for(var i=0;i<ProjectList.size();i++){
                        var Project =ProjectList.get(i);
                        //returns a Project object
                }
        }
        


Parameters:
dID - the given department id
Returns:
all projects (each element in Vector are instance of Project)
Since:
  version 1.0.0
See Also:
Project





getProjectOfManager
java.util.Vector getProjectOfManager(java.lang.String managerID)

Get the projects which project manager is the same with the specified project manager.

        
        Examples:
        
        var managerID = "MEM953256027740";
        var ProjectList = Client.getProjectOfManager(managerID);
        if(ProjectList != null) {
                for(var i=0;i<ProjectList.size();i++){
                        var Project =ProjectList.get(i);
                        //returns a Project object
                }
        }
        


Parameters:
managerID - the given member id
Returns:
all projects (each element in Vector are instance of Project)
Since:
  version 1.0.0
See Also:
Project





getProjectRole
ProjectRole getProjectRole(java.lang.String rID)

Get project role by the specified role id.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var rID  = task.getRoleID();
        var ProjectRole = Client.getProjectRole(rID);
        //returns a ProjectRole object
        


Parameters:
rID - the given project role id
Returns:
the ProjectRole object
Since:
  version 1.0.0
See Also:
ProjectRole





getReportService
ReportService getReportService()

get ReportService



Returns:
ReportService





getRole
Role getRole(java.lang.String rID)

Get role by the specified role id.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var rID  = task.getRoleID();
        var role = Client.getRole(rID);
        //returns a Role object
        


Parameters:
dID - the given role id
Returns:
the Role object
Since:
  version 1.0.0
See Also:
Role





getRootDBProcessOfProject
java.util.Vector getRootDBProcessOfProject(java.lang.String prjID)

Get the list of the root DBProcess by the specified project id.

        
        Examples:
        
        var task  = Form.getCurrentTask();
        var prjID = task.getProjectID();
        var rootDBProcessList = Client.getRootDBProcessOfProject(prjID);
        for(var i = 0;i < rootDBProcessList.size();i++) {
                var rootDBProcess = rootDBProcessList.get(i);
                //returns the DBProcess object
        }
        


Parameters:
prjID - the given project id
Returns:
the list of root DBProcess(each element in Vector are instance of DBProcess)
Since:
  version 1.1
See Also:
DBProcess





getRootTaskOfMember
java.util.Vector getRootTaskOfMember(java.lang.String mID)

Get root tasks which managed by the specified member.

        
        Examples:
        
        var mID  = "MEM953256027740";
        var TaskList = Client.getRootTaskOfMember(mID);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
mID - the given member id
Returns:
all correspondence root tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getRootTaskOfMember
java.util.Vector getRootTaskOfMember(java.lang.String mID,
                                     int state)

Get root tasks which managed by the specified member.

        
        Examples:
        
        var mID   = "MEM953256027740";
        var state = Constant.TASK_STATE_RUNNING;
        var TaskList = Client.getRootTaskOfMember(mID,state);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
mID - the given member id
state - the given task state, see attributes TASK_STATE_XXX in pe.pase.Task
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getRootTaskOfProcess
java.util.Vector getRootTaskOfProcess(java.lang.String proID)

Retrieving the root Tasks
 of the given DBProcess id.


Parameters:
proID - 
Returns:
all correspondence tasks (each element in Vector is a instance of Task)
Since:
  2.2.3
See Also:
Task, {@link #getTaskOfProcess(String)}





getRootTaskOfProcess
java.util.Vector getRootTaskOfProcess(java.lang.String proID,
                                      int state)

Retrieving the root Tasks
 of the given DBProcess id and task state.


Parameters:
proID - process id
state - task state
Returns:
all correspondence tasks (each element in Vector is a instance of Task)
Since:
  2.2.3
See Also:
Task, {@link #getTaskOfProcess(String, int)}





getScheduleEvent
ScheduleEvent getScheduleEvent(java.lang.String id)

Get schedule event

        
        Examples:
        
        var event = Client.getScheduleEvent(eventID);
        


Parameters:
id - event id of ScheduleEvent
Returns:
event of specified id





getServerTime
long getServerTime()

Get the server time in milliseconds

        
        Examples:
        
        var time = Client.getServerTime();
        var date = new java.util.Date(time);
        



Returns:
the server time in milliseconds
Since:
  version 1.1.5






getService
java.lang.Object getService(java.lang.String serviceName)

Get Remote Service by the given service name


See Also:
RemoteServiceProvider.DBSERVICE, 
RemoteServiceProvider.FILESERVICE, 
RemoteServiceProvider.FLOWSERVICE, 
RemoteServiceProvider.ORGSERVICE, 
RemoteServiceProvider.PDESERVICE, 
RemoteServiceProvider.SECURITYSERVICE, 
RemoteServiceProvider.UTILITYSERVICE, 
RemoteServiceProvider.REPORTSERVICE, 
RemoteServiceProvider.COMPRESSSERVICE





getSessionConnectionURL
java.util.HashMap getSessionConnectionURL(int sequence)

Get the db configuration info with the specific sequence number

        
        Examples:
        
        var config = Client.getSessionConnectionURL(1);
        java.lang.System.out.println(config);
        


Parameters:
seq - the sequence which the data is store in configuration, from 1
Returns:
the HashMap object shows the SessionConnection configuration
Since:
  version 1.1.5






getSessionConnectionURL
java.util.HashMap getSessionConnectionURL(java.lang.String name)

Get a db configuration by given name.

        
        Examples:
        
        var config = Client.getSessionConnectionURL("MS-SQL1");
        java.lang.System.out.println(config);
        


Parameters:
name - the name to recognize the db configuration, from 1
Returns:
the HashMap object shows the SessionConnection configuration
Since:
  version 2.0.0






getSessionConnectionURLList
java.util.Vector getSessionConnectionURLList()

Get all db configurations.

        
        Examples:
        
        var list = Client.getSessionConnectionURLList();
  for (var i=0; i<list.size(); i++) {
                var config = list.get(i);
                java.lang.System.out.println(config);
        }
        



Returns:
all SessionConnection configurations(each element in Vector are instance of HashMap)
Since:
  version 2.0.0






getSignatureImage
java.lang.String getSignatureImage(java.lang.String mID)

Get the signature image by the specified member id.

        
        Examples:
        
        var currentMember = Client.getCurrentMember();
        var memID = currentMember.getID();
        var signature = Client.getSignatureImage(memID);
        


Parameters:
mID - the given member id
Returns:
the signature
Since:
  version 1.0.0






getSubDepIDOfDR
java.util.Vector getSubDepIDOfDR(java.lang.String id,
                                 boolean exp)

Get sub-department's id by the specified department id or role id,
  and that search directly down the organizer according to the 'exp' argument.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var id = mdr.getDepartmentID();
        var exp = true;
        var depIDList = Client.getSubDepIDOfDR(id,exp);
        if(depIDList != null) {
                for(var i=0;i<depIDList.size();i++){
                        var depID = depIDList.get(i);
                }
        }
        


Parameters:
id - the given department id or role id
exp - the given true if it will expand all sub-node and get it's department name ;false otherwise.
Returns:
dpartment id (each element in Vector are String)
Since:
  version 2.1
See Also:
Department





getSubDepNameOfDR
java.util.Vector getSubDepNameOfDR(java.lang.String id,
                                   boolean exp)

Get sub-department's name by the specified department id or role id,
  and that search directly down the organizer according to the 'exp' argument.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var id = mdr.getDepartmentID();
        var exp = true;
        var depNameList = Client.getSubDepNameOfDR(id,exp);
        if(depNameList != null) {
                for(var i=0;i<depNameList.size();i++){
                        var depName = depNameList.get(i);
                        //returns a department name is like "MIS Department"
                }
        }
        


Parameters:
id - the given department id or role id
exp - the given true if it will expand all sub-node and get it's department name ;false otherwise.
Returns:
dpartment name (each element in Vector are String)
Since:
  version 1.1
See Also:
Department





getSubMemberCNameOfDR
java.util.Vector getSubMemberCNameOfDR(java.lang.String id,
                                       boolean exp)

Get sub-member's name by the specified department id or role id,
  and that search directly down the organizer according to the 'exp' argument.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var id = mrd.getMainRoleID();
        var exp = true;
        var memberNameList = Client.getSubMemberCNameOfDR(id,exp);
        if(memberNameList != null) {
                for(var i=0;i<memberNameList.size();i++){
                        var memberName = memberNameList.get(i);
                        //returns a member name is like "JackLin"
                }
        }
        


Parameters:
id - the given department id or role id
exp - the given true if it will expand all sub-node and get it's member Name ;false otherwise.
Returns:
member Name (each element in Vector are String)
Since:
  version 1.1
See Also:
MemberRecord





getSubMemberIDOfDR
java.util.Vector getSubMemberIDOfDR(java.lang.String id,
                                    boolean exp)

Get sub-member's ID by the specified department id or role id,
  and that search directly down the organizer according to the 'exp' argument.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var id = mrd.getMainRoleID();
        var exp = true;
        var memberIDList = Client.getSubMemberIDOfDR(id,exp);
        if(memberIDList != null) {
                for(var i=0;i<memberIDList.size();i++){
                        var memberName = memberIDList.get(i);
                }
        }
        


Parameters:
id - the given department id or role id
exp - the given true if it will expand all sub-node and get it's member Name ;false otherwise.
Returns:
member ID (each element in Vector are String)
Since:
  version 2.1
See Also:
MemberRecord





getSubRoleIDOfDR
java.util.Vector getSubRoleIDOfDR(java.lang.String id,
                                  boolean exp)

Get sub-role's id by the specified department id or role id,
  and that search directly down the organizer according to the 'exp' argument.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var id = mdr.getDepartmentID();
        var exp = true;
        var roleIDList = Client.getSubRoleIDOfDR(id,exp);
        if(roleIDList != null) {
                for(var i=0;i<roleIDList.size();i++){
                        var roleID = roleIDList.get(i);
                }
        }
        


Parameters:
id - the given department id or role id
exp - the given true if it will expand all sub-node and get it's role name ;false otherwise.
Returns:
role id (each element in Vector are String)
Since:
  version 2.3.1 SP1
See Also:
Role





getSubRoleNameOfDR
java.util.Vector getSubRoleNameOfDR(java.lang.String id,
                                    boolean exp)

Get sub-role's name by the specified department id or role id,
  and that search directly down the organizer according to the 'exp' argument.

        
        Examples:
        
        var mrd = Client.getCurrentMember();
        var mdr = mrd.getMemberDR(mrd.getMainRoleID());
        var id = mdr.getDepartmentID();
        var exp = true;
        var roleNameList = Client.getSubRoleNameOfDR(id,exp);
        if(roleNameList != null) {
                for(var i=0;i<roleNameList.size();i++){
                        var roleName = roleNameList.get(i);
                        //returns a role name is like "accountant"
                }
        }
        


Parameters:
id - the given department id or role id
exp - the given true if it will expand all sub-node and get it's role name ;false otherwise.
Returns:
role name (each element in Vector are String)
Since:
  version 1.1
See Also:
Role





getSubTaskList
java.util.Vector getSubTaskList(java.lang.String parentID)

Get subtasks of the specified task.

        
        Examples:
        
        var parentID = "Tsk000000254284";
        var TaskList = Client.getSubTaskList(parentID);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
parentTID - the given task id
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getTask
Task getTask(java.lang.String tID)

Get task by the specified task id.

        
        Examples:
        
        var taskID  = "Tsk000000226229";
        var Task    = Client.getTask(taskID);
        //returns a Task object
        


Parameters:
tID - the given task id
Returns:
the Task object
Since:
  version 1.0.0
See Also:
Task





getTaskAttachedFileContent
java.lang.String getTaskAttachedFileContent(java.lang.String fileID)

Get file content of the specified task attached file.

        
        Examples:
        
        var fileID  = "File000000254284";
        var fileContent = Client.getTaskAttachedFileContent(fileID);
        


Parameters:
fileID - the given String fileID
Returns:
file content of specified file id
Since:
  version 2.0
See Also:
Task





getTaskOfMember
java.util.Vector getTaskOfMember(java.lang.String mID)

Get tasks which managed by the specified member.

        
        Examples:
        
        var mID = "MEM953256027740";
        var TaskList = Client.getTaskOfMember(mID);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
mID - the given member id
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getTaskOfMember
java.util.Vector getTaskOfMember(java.lang.String mID,
                                 int state)

Get tasks which managed by the specified member.

        
        Examples:
        
        var mID   = "MEM953256027740";
        var state = Constant.TASK_STATE_RUNNING;
        var TaskList = Client.getTaskOfMember(mID,state);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
mID - the given member id
state - the given task state, see attributes TASK_STATE_XXX in pe.pase.Task
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getTaskOfProcess
java.util.Vector getTaskOfProcess(java.lang.String proID)

Get tasks in the specified process.

        
        Examples:
        
        var proID = "PRO0549992486182610";
        var TaskList = Client.getTaskOfProcess(proID);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
proID - the given process id
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.1.6
See Also:
Task





getTaskOfProcess
java.util.Vector getTaskOfProcess(java.lang.String proID,
                                  int state)

Get tasks in the specified process.

        
        Examples:
        
        var T_STATE_READY = 1;
        var T_STATE_RUNNING = 2;
        var T_STATE_COMPLETE = 4;
        var T_STATE_SUSPENDED = 8;
        var T_STATE_DEAD = 16;
        var T_STATE_QUEUE = 32;
        var T_STATE_SERVER_WAITING = 64;
        var T_STATE_CLIENT_WAITING = 128;
        var T_STATE_LOCK = 256;
        var T_STATE_ALL = 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256;

        var proID = "PRO0549992486182610";
        var TaskList = Client.getTaskOfProcess(proID,T_STATE_READY);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
proID - the given process id
state - the given task state
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getTaskOfRootTask
java.util.Vector getTaskOfRootTask(java.lang.String rootTID)

Get tasks of the specified root task.

        
        Examples:
        
        var rootTID  = "Tsk000000254284";
        var TaskList = Client.getTaskOfRootTask(rootTID);
        for (var i=0;i<TaskList.size();i++) {
                var Task=TaskList.get(i);
                //returns a Task object
        }
        


Parameters:
rootTID - the given task id
Returns:
all correspondence tasks (each element in Vector are instance of Task)
Since:
  version 1.0.0
See Also:
Task





getTranslateArtInsList
java.util.Vector getTranslateArtInsList(java.lang.String aID)

Artifact translate.

        
        Examples:
        
        var ArtInsList=Client.getTranslateArtInsList("ART0099992486182440");
        if(ArtInsList != null) {
                for(var i=0;i


Parameters:
aID - the given artifact id
Returns:
the TranslateArtIns list.(each element in Vector are instance of TranslateArtIns)
Since:
  version 1.0.0
See Also:
TranslateArtIns





getTypeMap
java.util.Iterator getTypeMap()

Get the mapping of application and type



Returns:
the Iterator object
Since:
  version 1.0.0






getUncompletePATaskNo
int getUncompletePATaskNo(Task parentTask)

Calculate the tasks count which tasks are "Add Parallel Announce" and are complete under the specified task.

        
        Examples:
        
        var count = Client.getUncompletePATaskNo(Form.getCurrentTask());
        


Parameters:
parentTask - the given Parent Task
Returns:
the tasks count.
Since:
  version 2.0.0
See Also:
Task





getUnitType
UnitType getUnitType(java.lang.String uid)

Get the Unit Type with the specified unit id


Parameters:
uid - the given unit type id
Returns:
the UnitType
Since:
  version 2.2.5
See Also:
UnitType





getUnitTypeByLoginID
UnitType getUnitTypeByLoginID(java.lang.String loginId)

Get the Unit Type with the specified member's login id


Parameters:
loginId - the given member's login id
Returns:
Unit Type of the department belong to member
Since:
  version 2.2.5






getUnitTypeByMember
UnitType getUnitTypeByMember(MemberRecord mbr)

Get the Unit Type with the specified MemberRecord


Parameters:
mbr - the given MemberRecord
Returns:
Unit Type of the department belong to member
Since:
  version 2.2.5






getUnitTypeByMemID
UnitType getUnitTypeByMemID(java.lang.String memId)

Get the Unit Type with the specified member id


Parameters:
memId - the given member id
Returns:
Unit Type of the department belong to member
Since:
  version 2.2.5






getUnitTypeByNo
UnitType getUnitTypeByNo(java.lang.String memNo)

Get the Unit Type with the specified member No.


Parameters:
memNo - the given member No.
Returns:
Unit Type of the department belong to member
Since:
  version 2.2.5






goBackTo
boolean goBackTo(java.lang.String fromTaskID,
                 java.lang.String toProID,
                 boolean artMode)

For task schedule and flow control. Go back to previous process node.
        
        Examples:
        
   Client.goBackTo("Tsk000000000001", "Pro000000000001", true);
        


Parameters:
fromTaskID - a task id. If it equals to root task id, complete all task and reserve attatched file list of the toTask then go back.
toProID - the previous process id.
artMode - true for using the new data.
Returns:
true if succeeded; false otherwise.
Since:
  version 1.1.5






goBackTo
boolean goBackTo(java.lang.String fromTaskID,
                 Task toTask,
                 boolean artMode)

For task schedule and flow control. Go back to previous process node.
        
        Examples:
        
   Client.goBackTo("Tsk000000000001", toTask, true);
        


Parameters:
fromTaskID - a task id. If it equals to root task id, complete all task and reserve attatched file list of the toTask then go back.
toTask - the previous Task.
artMode - true for using the new data.
Returns:
true if succeeded; false otherwise.
Since:
  version 1.1.5






goBackTo
boolean goBackTo(Task fromTask,
                 java.lang.String toProID,
                 boolean artMode)

For task schedule and flow control. Go back to previous process node.
        
        Examples:
        
   Client.goBackTo(fromTask, "Pro000000000001", true);
        


Parameters:
fromTask - a task id. If it equals to root task id, complete all task and reserve attatched file list of the toTask then go back.
toProID - the previous process id.
artMode - true for the newest form data on the final task; false for the bypast form data on the specific task.
Returns:
true if succeeded; false otherwise.
Since:
  version 1.1.5






goBackToWithDetailRet
java.util.HashMap goBackToWithDetailRet(Task fromTask,
                                        java.lang.String toProID,
                                        boolean artMode)

For task schedule and flow control, go back to previous process node
        
        Examples:
        
        Client.goBackToWithDetailRet(fromTask, "ProXXXX", true);
        


Parameters:
fromTask - the task id, if the task id equals root task id, complete all task and reserve attatched file list of the toTask then go back.
toProID - the previous process id
artMode - true for the newest form data on the final task; false for the bypast form data on the specific task
Returns:
the HashMap
Since:
  version 1.1.5






initProcess
java.util.HashMap initProcess(PASEProcess process)

Initial the process.

        
        Examples:
        
        var pID = "PRO0549992486182610";
        var paseProcess = new Packages.pe.pase.PASEProcess(pID);
        var hashmap = Client.initProcess(paseProcess);
        var rootTaskID = hashmap.get("rootTaskID");
        //returns root task id is like "Tsk000000263264"
        var retValue   = hashmap.get("retValue");
        //returns true if it gets successfully;false otherwise
        


Parameters:
process - the given PASEProcess
Returns:
the result ( [Key:Value] = [rootTaskID:rootTaskID] ; [retValue:Boolean(true/false)])
Since:
  version 1.0.0
See Also:
PASEProcess





insertDepartment
boolean insertDepartment(Department dep)

Insert a Department to organization.

        
        Examples:
        
        Client.insertDepartment(dep);
        


Parameters:
dep - Department instance
Returns:
true if succeeded
See Also:
Department





insertMemberRecord
boolean insertMemberRecord(MemberRecord mbr)

Insert a MemberRecord to organization.

        
        Examples:
        
        Client.insertMemberRecord(member);
        


Parameters:
mbr - MemberRecord instance
Returns:
true if succeeded
See Also:
MemberRecord





insertRole
boolean insertRole(Role role)

Insert a Role to organization.

        
        Examples:
        
        Client.insertRole(role);
        


Parameters:
role - Role instance
Returns:
true if succeeded
See Also:
Role





insertScheduleEvent
void insertScheduleEvent(ScheduleEvent evt)

Insert ScheduleEvent into table

        
        Examples:
        
        Client.insertScheduleEvent(event);
        


Parameters:
evt - insert event into table





insertTaskAttachedFile
boolean insertTaskAttachedFile(TaskAttachedFileInfo fileInfo)

insert a task attached file.

        
        Examples:
        
        var fileInfo  = new TaskAttachedFileInfo();
        var result = Client.insertTaskAttachedFile(fileInfo);
        


Parameters:
fileInfo - the given TaskAttachedFileInfo object
Returns:
if insertion is successful
Since:
  version 2.0






isATaskComplete
boolean isATaskComplete(Task t)








isCompanyManager
boolean isCompanyManager(MemberRecord mbr)

Is manager of the company with the specified MemberRecord


Parameters:
mbr - the given MemberRecord
Returns:
true if the member is manager of company, otherwise false
Since:
  version 2.2.5






isCompanyManagerByID
boolean isCompanyManagerByID(java.lang.String memId)

Is manager of the company with the specified member id


Parameters:
loginId - the given member id
Returns:
true if the member is manager of company, otherwise false
Since:
  version 2.2.5






isCompanyManagerByLoginID
boolean isCompanyManagerByLoginID(java.lang.String loginId)

Is manager of the company with the specified member's login id


Parameters:
loginId - the given member's login id
Returns:
true if the member is manager of company, otherwise false
Since:
  version 2.2.5






isCompanyManagerByNo
boolean isCompanyManagerByNo(java.lang.String memNo)

Is manager of the company with the specified member No.


Parameters:
memNo - the given member No.
Returns:
true if the member is manager of company, otherwise false
Since:
  version 2.2.5






isCSTaskComplete
boolean isCSTaskComplete(Task t)








isHalfHoliday
boolean isHalfHoliday(java.lang.String date)

Check specified date whether it's a half of holiday in system's default calendar.

        
        Examples:
        
        var sDate = "2001/06/17";
        var Result = Client.isHalfHoliday(sDate);
        //returns true if it's a half of holiday; false otherwise
        


Parameters:
date - the given Date format string
Returns:
true if the date is a half of holiday; false otherwise.
Since:
  version 1.0.0






isHalfHoliday
boolean isHalfHoliday(java.lang.String date,
                      java.lang.String memID)

Check specified date whether it's a half of holiday in member's calendar.

  
  Examples:
  
  var sDate = "2001/06/17";
  var memID = "MEMxxx"
  var Result = Server.isHalfHoliday(sDate, memID);
  //returns true if it's a half of holiday; false otherwise
  


Parameters:
date - the given Date format string
memID - the given member id string
Returns:
true if the date is a half of holiday; false otherwise.
Since:
  V3.1






isHoliday
boolean isHoliday(java.lang.String date)

Check specified date whether it's a holiday in system's default calendar.

        
        Examples:
        
        var sDate = "2001/06/17";
        var Result = Client.isHoliday(sDate);
        //returns true if it's a holiday; false otherwise
        


Parameters:
date - the given Date format string
Returns:
true if the date is a holiday; false otherwise.
Since:
  version 1.0.0






isHoliday
boolean isHoliday(java.lang.String date,
                  java.lang.String memID)

Check specified date whether it's a holiday in user's calendar.

  
  Examples:
  
  var sDate = "2001/06/17";
  var memID = "MEMxxx";
  var Result = Server.isHoliday(sDate, memID);
  //returns true if it's a holiday; false otherwise
  


Parameters:
date - the given Date format string
memID - the give member id string
Returns:
true if the date is a holiday; false otherwise.
Since:
  V3.1






isRestSat
boolean isRestSat(java.lang.String date)

Check specified date whether it's a rest Saturday.

        
        Examples:
        
        var sDate = "2001/06/17";
        var Result = Client.isRestSat(sDate);
        //returns true if it's rest Saturday; false otherwise
        


Parameters:
date - the given Date format string
Returns:
true if the date is rest Saturday; false otherwise.
Since:
  version 1.0.0






isWorkday
boolean isWorkday(java.lang.String date,
                  java.lang.String memID)

Check specified date whether it's a work day in member's calendar.

  
  Examples:
  
  var sDate = "2001/06/17";
  var memID = "MEMxxx"
  var Result = Server.isWorkday(sDate, memID);
  //returns true if it's a work day; false otherwise
  


Parameters:
date - the given Date format string
memID - the given member id string
Returns:
true if the date is a work day; false otherwise.
Since:
  V3.1






lockTask
void lockTask(java.lang.String tskID)

For task schedule and flow control, set the task lock
        
        Examples:
        
        Client.lockTask("TskXXXXXXX");
        


Parameters:
tskID - the task id
Since:
  version 1.1.5






newDepartment
Department newDepartment()

Create a Department instance.

        
        Examples:
        
        var dep = Client.newDepartment();
        



Returns:
Department
See Also:
Department





newMemberRecord
MemberRecord newMemberRecord()

Create a MemberRecord instance.

        
        Examples:
        
        var member = Client.newMemberRecord();
        



Returns:
MemberRecord
See Also:
MemberRecord





newRole
Role newRole()

Create a Role instance.

        
        Examples:
        
        var role = Client.newRole();
        



Returns:
Role
See Also:
Role





notifyTask
java.util.HashMap notifyTask(java.lang.String tskID)

For task schedule and flow control, set the task notify
        
        Examples:
        
        var result = Client.notifyTask("TskXXXXXXX");
        var booleanResult = result.get("retValue");
        //returns Boolean object
        if(!booleanResult.booleanValue()) {
                var reason = result.get("reason");
                //returns String
        }
        


Parameters:
tskID - the task id
Returns:
the refult. ( [Key:Value] = [retValue:Boolean(true/false)]; [reason:String]).
Since:
  version 1.1.5






parseAddASResultString
java.util.Vector parseAddASResultString(java.lang.String result)

Parse the countersign result string to CSResultData.

        
        Examples:
        
        var task = Form.getCurrentTask();  //task is ATask
        if(task.isAnnounceReviewMode() || task.isSignCompleteMode() || task.isSignRejectMode()) {
                var result = task.getCSInstance().getNote();
                var resultObjList = Client.parseAddASResultString(result);
                for(var i = 0;i < resultObjList.size();i++) {
                        var resultData = resultObjList.get(i);
                        //resultData is CSResultData object
                }
        }
        


Parameters:
result - the given countersign result string
Returns:
all correspondence countersign result instances (each elemen in Vector are instance of CSResultData)
Since:
  version 2.0
See Also:
CSResultData





parseCSResultString
java.util.Vector parseCSResultString(java.lang.String result,
                                     java.util.List auditNameList)

Parse the countersign result string to CSResultData

        
        Examples:
        
        var task = Form.getCurrentTask();  //task is CSTask
        if(task.getTaskType().equals("csreview")) {
                var result = task.getCSInstance().getNote();
                var resultObjList = Client.parseCSResultString(result, task.getAuditList());
                for(var i = 0;i < resultObjList.size();i++) {
                        var resultData = resultObjList.get(i);
                        //resultData is CSResultData object
                }
        }
        


Parameters:
result - the given countersign result string
auditNameList - the given auditing member list(each elemen in Vector are instance of String[3], String[0] for MemberID, String[1] for RoleID, String[2] for DepartmentID)
Returns:
all correspondence countersign result instances (each elemen in Vector are instance of CSResultData)
Since:
  version 2.0
See Also:
CSResultData





printArtifactList
void printArtifactList(java.util.Vector artInsIDList,
                       java.lang.String printMode,
                       java.lang.String pageMode,
                       java.lang.String viewState,
                       boolean bRunScript,
                       int top,
                       int down,
                       int left,
                       int right,
                       int orientation)

This method is using for batch printing artifact instances.

  Note: JSP WebForm does not implement this method.

        
        Examples:
        
        var v = new Packages.java.util.Vector();
        v.add("Ans000000658671");
        v.add("Ans000000658665");
        Client.printArtifactList(v,"PdfFile","FullPage", "", true, 0,0,0,0,0);
        


Parameters:
artInsIDList - the vector of artifact instance id
printMode - the String type of printing mode, should be "Java", "Pdf", "JpgFile" or "PdfFile"
pageMode - the String type of page mode, should be "FullPage", "CutPage" or "OriginalPage"
viewState - the state of artifact to display
bRunScript - true for running script on viewState
top - the top margin in millimeter
down - the bottom margin in millimeter
left - the left margin in millimeter
right - the right margin in millimeter
orientation - given 0 for horizontal, 1 for vertical
Since:
  version 1.1.4






printArtifactList
void printArtifactList(java.util.Vector artInsIDList,
                       java.lang.String printMode,
                       java.lang.String pageMode,
                       java.lang.String viewState,
                       boolean bRunScript,
                       int width,
                       int height,
                       int top,
                       int down,
                       int left,
                       int right,
                       int orientation,
                       boolean popUp)

This method is using for batch printing artifact instances.

  Note: JSP WebForm does not implement this method.

        
        Examples:
        
        var v = new Packages.java.util.Vector();
        v.add("Ans000000658671");
        v.add("Ans000000658665");
        Client.printArtifactList(v,"PdfFile","FullPage", "", true, 200, 200,0,0,0,0,0,false);
        


Parameters:
artInsIDList - the vector of artifact instance id
printMode - the String type of printing mode, should be "Java", "Pdf", "JpgFile" or "PdfFile"
pageMode - the String type of page mode, should be "FullPage", "CutPage" or "OriginalPage"
viewState - the state of artifact to display
bRunScript - true for running script on viewState
width - the width of drawing Window
height - the height of drawing Window
top - the top margin in millimeter
down - the bottom margin in millimeter
left - the left margin in millimeter
right - the right margin in millimeter
orientation - given 0 for horizontal, 1 for vertical
popUp - pop-up the print setting dialog
Since:
  version 1.1.4






registerType
boolean registerType(java.lang.String type,
                     java.lang.String app)

Register file type mapping.

        
        Examples:
        
        var type = "html";
        var app  = "C:\\Program Files\\Internet Explorer\\IEXPLORE.EXE";
        var Result = Client.registerType(type,app);
        //returns true if it registers successfully; false otherwise
        


Parameters:
type - the given secondary filename
app - the given execute file path and name
Returns:
true if it registers successfully; false otherwise
Since:
  version 1.0.0






removeAFTVElementVO
boolean removeAFTVElementVO(java.lang.String subject,
                            java.lang.String item)

remove AFTVElementVO from database

 
 Examples:
 
 var artInsId = MyTask.getArtInstance().getID();
 var itemId = "ITEM0";
 var result = Client.removeAFTVElementVO(artInsId, itemId);
      returns true if it sets successfully ;false otherwise
 


Parameters:
subject - the given AFTVElementVO's subject
item - this give AFTVElementVO's item
Returns:
true if succeeded





removeLocalObject
boolean removeLocalObject(java.lang.String id)

Remove an local object.

        
        Examples:
        
        var myTaskList = Client.getTaskOfMember("MEM0000992492169920",Constant.TASK_STATE_ALL);
        Client.setLocalObject("myTaskList1",myTaskList);
        var Result = Client.removeLocalObject("myTaskList1");
        //returns true if it's successful; false otherwise
        


Parameters:
id - the id of the local object which want to be removed
Returns:
ture if removing this object successfully; otherwise, false
Since:
  version 1.0.0






removeScheduleEvent
void removeScheduleEvent(java.lang.String id)

Remove ScheduleEvent by event id

        
        Examples:
        
        Client.removeScheduleEvent(eventID);
        


Parameters:
id - event id





removeType
boolean removeType(java.lang.String type)

Remove the registered file type mapping.

        
        Examples:
        
        var type = "html";
        var Result = Client.removeType(type);
        //returns true if it removes successfully; false otherwise
        


Parameters:
type - the given secondary filename
Returns:
true if it removes successfully; false otherwise
Since:
  version 1.0.0






reScheduleTask
void reScheduleTask(Task task)

Reschedule the task Cron Event(s)

        
        Examples:
        
   var duration = 5;
        var task = Form.getCurrentTask();
        task.setDuration(duration);
        Client.reScheduleTask(task);
        


Since:
  V2.1






resetDeputyAndDeputyState
boolean resetDeputyAndDeputyState(java.lang.String p_MemID,
                                  java.lang.String p_DeputyMemID,
                                  boolean p_DeputyState)

Reset deputy state and deputy member.

        
        Examples:
        
        var p_MyMemID = "MEM0000992492169920";
        var p_DeputyMemID = "MEM0002972876172780";
        var p_DeputyState = true; // set DeputyState ON
        var Result = Client.resetDeputyAndDeputyState(p_MyMemID,p_DeputyMemID,p_DeputyState);
        //returns true if it reset successfully; false otherwise
        


Parameters:
p_MemID - the given member id whom starts up the deputation
p_DeputyMemID - the given member id whom is a deputy
p_DeputyState - the given true for set deputy state is on ,else false
Returns:
true if it reset successfully; false otherwise
Since:
  version 1.1.5






resetMemberDelegation
boolean resetMemberDelegation(MemberRecord mRecord)

Redispatch tasks to deputy of the member and also update memberrecord.

  
  Examples:
  
   var member = Client.getCurrentMember();
   var stateTime = Form.getValue("FTextField0"); // Format "2006/01/31 17:30"
   var endTime = Form.getValue("FTextField1");
   member.setExeucteDeputyDuration(true);
   // Set start deputy duration
   member.setStartExecuteDeputyTime(stateTime);
   // Set end deputy duration
   member.setEndExecuteDeputyTime(endTime);
   // Set single deputy member
   member.setByDeputyRule(false);
   member.setDeputyID("MEM000000000003");
   // Set turn on deputy state
   member.setDeputyState(true);
   Client.resetMemberDelegation(member);
  


Parameters:
mRecord - MemberRecord memberrecord
Returns:
boolean true if success else false
Since:
  V2.2.3.4
See Also:
MemberRecord





runJScript
boolean runJScript(java.lang.String script,
                   java.util.HashMap globalVar)

Script Runner.

        
        Examples:
        
        var script = Form.getValue("TextArea1");  // Input script into TextArea1
        var globalVar = new java.util.HashMap();
        globalVar.put("Form",Form);
        Client.runJScript(script,globalVar);
        


Parameters:
script - the input script data string
globalVar - the HashMap which is a global variable
Returns:
false if some error occurred; otherwise, true
Since:
  version 1.0.0






runScriptOnServer
void runScriptOnServer(java.lang.String code,
                       Task t)

Run script on server.

        
        Examples:
        
        var script = Form.getValue("TextArea1");  // Input script into TextArea1
        var task = Form.getCurrentTask();
        Client.runScriptOnServer(script,task);
        


Parameters:
script - the input script data string
t - the task
Since:
  version 1.2






saveAFTVElementVO
boolean saveAFTVElementVO(AFTVElementVO vo)

save AFTVElementVO to database

 
 Examples:
 
 var artInsId = MyTask.getArtInstance().getID();
 var itemId = "ITEM0";
 var vo = new Packages.pe.pase.AFTVElementVO(artInsId, itemId);
 vo.setPrincipal("DEP00001091073095699");
 vo.setOfflineReadonly(0);
 vo.setEditCount(1);
 vo.setSaveCount(-1);
  var result = Client.saveAFTVElementVO(vo);
      returns true if it sets successfully ;false otherwise
 


Parameters:
vo - the given AFTVElementVO
Returns:
true if succeeded





saveArtifactListToJPG
void saveArtifactListToJPG(java.util.Vector artInsIDList,
                           java.util.Vector fileList,
                           java.lang.String viewState,
                           boolean bRunScript,
                           int top,
                           int down,
                           int left,
                           int right,
                           int orientation)

This method is using for batch saving artifact instances to JPG file.

  Note: JSP WebForm does not implement this method.

        This function would not proceed in Actions of client side.

        
        Examples:
        
        var v = new Packages.java.util.Vector();
        v.add("Ans000000658671");
        v.add("Ans000000658665");
        var fv = new Packages.java.util.Vector();
        fv.add("fa.jpg");
        fv.add("fb.jpg");
        Client.saveArtifactListToJPG(v,fv,"",true,0,0,0,0,0);
        


Parameters:
artInsIDList - the vector of artifact instance id
fileList - the file name list of JPG file
viewState - the state of artifact to display
bRunScript - true for running script on viewState
top - the top margin in millimeter
down - the bottom margin in millimeter
left - the left margin in millimeter
right - the right margin in millimeter
orientation - given 0 for horizontal, 1 for vertical
Since:
  version 1.1.6






saveArtifactListToPDF
void saveArtifactListToPDF(java.util.Vector artInsIDList,
                           java.lang.String pageMode,
                           java.lang.String fileName,
                           java.lang.String viewState,
                           boolean bRunScript,
                           int top,
                           int down,
                           int left,
                           int right,
                           int orientation)

This method is using for batch saving artifact instances to PDF file.

  Note: JSP WebForm does not implement this method.

        This function would not proceed in Actions of client side.

        
        Examples:
        
        var v = new Packages.java.util.Vector();
        v.add("Ans000000658671");
        v.add("Ans000000658665");
        Client.saveArtifactListToPDF(v,"OriginalPage","t111.pdf","",true,0,0,0,0,0);
        


Parameters:
artInsIDList - the vector of artifact instance id
pageMode - the String type of page mode, should be "FullPage", "CutPage" or "OriginalPage"
fileName - the file name of PDF file
viewState - the state of artifact to display
bRunScript - true for running script on viewState
top - the top margin in millimeter
down - the bottom margin in millimeter
left - the left margin in millimeter
right - the right margin in millimeter
orientation - given 0 for horizontal, 1 for vertical
Since:
  version 1.1.4






searchScheduleEvent
java.util.Vector searchScheduleEvent(ScheduleSearchCondition cond)

Search ScheduleEvent by condition search

        
        Examples:
        
        var ret = Client.searchScheduleEvent(searchEvent);
        


Parameters:
cond - ScheduleSearchCondition of event
Returns:
Vector contains object of ScheduleEvent





sendHTMLMail
void sendHTMLMail(java.lang.String from,
                  java.lang.String to,
                  java.lang.String subject,
                  java.lang.String text)

Send E-Mail through internet, using HTML format.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        Client.sendHTMLMail(from,to,subject,text);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
subject - the "subject" field of E-Mail
text - the content of E-Mail
Since:
  version 2.0.0






sendHTMLMail
void sendHTMLMail(java.lang.String from,
                  java.lang.String to,
                  java.lang.String cc,
                  java.lang.String subject,
                  java.lang.String text)

Send E-Mail through internet, using HTML format.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to      = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowring.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        Client.sendHTMLMail(from,to,cc,subject,text);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
Since:
  version 2.0.0






sendHTMLMail
void sendHTMLMail(java.lang.String from,
                  java.lang.String to,
                  java.lang.String cc,
                  java.lang.String subject,
                  java.lang.String text,
                  java.util.Vector fileList)

Send E-Mail through internet, using HTML format.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        Client.sendHTMLMail(from,to,cc,subject,text,fileList);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server, not Client.
Since:
  version 2.0.0






sendHTMLMail
void sendHTMLMail(java.lang.String from,
                  java.lang.String to,
                  java.lang.String cc,
                  java.lang.String subject,
                  java.lang.String text,
                  java.util.Vector fileList,
                  java.util.HashMap auth)

Send E-Mail through internet, using HTML format.

        
        Examples:
        
        var CurrMember = Client.getMember(MyTask.getMemberID());
        var FrontMember= Client.getMember(MyTask.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        var auth = new java.util.HashMap();
        auth.put("username", "test");
        auth.put("password", "testpassword");
        Client.sendHTMLMail(from,to,cc,subject,text,fileList,auth);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server.
auth - the login information of the mail server. {"username"=, "password"=}
Since:
  version 2.0.0






sendHTMLMailExt
void sendHTMLMailExt(java.lang.String from,
                     java.lang.String to,
                     java.lang.String cc,
                     java.lang.String subject,
                     java.lang.String text,
                     java.util.Vector fileList,
                     java.lang.String tskID)

Send E-Mail through internet, using HTML format.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content. $taskID";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        Client.sendHTMLMailExt(from,to,cc,subject,text,fileList,task.getID());
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server, not Client.
tskID - the designated task ID to execute
Since:
  version 2.0.0






sendHTMLMailExt
void sendHTMLMailExt(java.lang.String from,
                     java.lang.String to,
                     java.lang.String cc,
                     java.lang.String subject,
                     java.lang.String text,
                     java.util.Vector fileList,
                     Task task)

Send E-Mail through internet, using HTML format.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content. $taskID";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        Client.sendHTMLMailExt(from,to,cc,subject,text,fileList,task);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server, not Client.
task - the designated task to execute
Since:
  version 2.0.0






sendHTMLMailExt
void sendHTMLMailExt(java.lang.String from,
                     java.lang.String to,
                     java.lang.String cc,
                     java.lang.String subject,
                     java.lang.String text,
                     java.util.Vector fileList,
                     Task task,
                     java.lang.String script)

Send E-Mail through internet, using HTML format.


Parameters:
from - the "from" filed of E-Mail.
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as
            the destination of the E-Mail.
cc - the "cc" field of E-Mail address.
subject - the "subject" field of E-Mail.
text - the content of E-Mail.
fileList - the attached file name list. The file name is based on PASE
            Server.
task - the designated task to execute.
script - the designated script to execute.
Since:
  version 2.2.3.6






sendMail
void sendMail(java.lang.String from,
              java.lang.String to,
              java.lang.String subject,
              java.lang.String text)

Send E-Mail through internet.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to      = FrontMember.getEmail(); // Receiver e-mail
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        Client.sendMail(from,to,subject,text);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
subject - the "subject" field of E-Mail
text - the content of E-Mail
Since:
  version 1.0.0






sendMail
void sendMail(java.lang.String from,
              java.lang.String to,
              java.lang.String cc,
              java.lang.String subject,
              java.lang.String text)

Send E-Mail through internet.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        Client.sendMail(from,to,cc,subject,text);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
Since:
  version 2.0.0






sendMail
void sendMail(java.lang.String from,
              java.lang.String to,
              java.lang.String cc,
              java.lang.String subject,
              java.lang.String text,
              java.util.Vector fileList)

Send E-Mail through internet.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowring.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        Client.sendMail(from,to,cc,subject,text,fileList);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server, not Client.
Since:
  version 2.0.0






sendMail
void sendMail(java.lang.String from,
              java.lang.String to,
              java.lang.String cc,
              java.lang.String subject,
              java.lang.String text,
              java.util.Vector fileList,
              java.util.HashMap auth)

Send E-Mail through internet.

        
        Examples:
        
        var CurrMember = Client.getMember(MyTask.getMemberID());
        var FrontMember= Client.getMember(MyTask.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        var auth = new java.util.HashMap();
        auth.put("username", "test");
        auth.put("password", "testpassword");
        Client.sendMail(from,to,cc,subject,text,fileList,auth);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server.
auth - the login information of the mail server. {"username"=, "password"=}
Since:
  version 2.0.0






sendMailExt
void sendMailExt(java.lang.String from,
                 java.lang.String to,
                 java.lang.String cc,
                 java.lang.String subject,
                 java.lang.String text,
                 java.util.Vector fileList,
                 java.lang.String tskID)

Send E-Mail through internet.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content. $taskID";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        Client.sendMailExt(from,to,cc,subject,text,fileList,task.getID());
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server, not Client.
tskID - the designated task ID to execute
Since:
  version 2.0.0






sendMailExt
void sendMailExt(java.lang.String from,
                 java.lang.String to,
                 java.lang.String cc,
                 java.lang.String subject,
                 java.lang.String text,
                 java.util.Vector fileList,
                 Task task)

Send E-Mail through internet.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var subject = "This is a subject";    // Mail Subject
        var text    = "This is a content. $taskID";    // Mail Content
        var fileList = new java.util.Vector();
        fileList.add("c:\\test.jpg");
        Client.sendMailExt(from,to,cc,subject,text,fileList,task);
        


Parameters:
from - the "from" filed of E-Mail
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail
cc - the "cc" field of E-Mail address
subject - the "subject" field of E-Mail
text - the content of E-Mail
fileList - the attached file name list. The file name is based on PASE Server, not Client.
task - the designated task to execute
Since:
  version 2.0.0






sendMailExt
void sendMailExt(java.lang.String from,
                 java.lang.String to,
                 java.lang.String cc,
                 java.lang.String subject,
                 java.lang.String text,
                 java.util.Vector fileList,
                 Task task,
                 java.lang.String script)

Send E-Mail through internet.


Parameters:
from - the "from" filed of E-Mail.
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as
            the destination of the E-Mail.
cc - the "cc" field of E-Mail address.
subject - the "subject" field of E-Mail.
text - the content of E-Mail.
fileList - the attached file name list. The file name is based on PASE
            Server.
task - the designated task to execute.
script - the designated script to execute.
Since:
  version 2.2.3.6






sendPASEMessage
boolean sendPASEMessage(PASEMessage msg)

Send message through message-system built in Agentflow.

        
        Examples:
        
        var task =  Form.getCurrentTask();
        var CurrMember = Client.getCurrentMember();
        var FrontMember= Client.getMember(task.getFrontUser());
        var msg = new Packages.pe.pase.PASEMessage();
        msg.setSendID(CurrMember.getID());     // Sender MemID
        msg.setSendName(CurrMember.getName()); // Sender Name
        msg.setRecID(FrontMember.getID());     // Receiver MemID
        msg.setRecName(FrontMember.getName()); // Receiver Name
        msg.setTitle("This is a title");       // Message Title
        msg.setMsg("This is a content");       // Message Content
        msg.setTime(java.lang.System.currentTimeMillis()); // Message create time
        var Result = Client.sendPASEMessage(msg);
        //returns true if it's successful; false otherwise
        


Parameters:
msg - the deliverable message
Returns:
true if the sending is successful; false otherwise.
Since:
  version 1.0.0
See Also:
PASEMessage





sendTemplateMail
void sendTemplateMail(java.lang.String from,
                      java.lang.String to,
                      java.lang.String cc,
                      java.lang.String etID,
                      java.util.Vector fileList,
                      java.lang.String taskID,
                      boolean isHtml)

Send E-Mail Template through internet, using HTML format.

        
        Examples:
        
        var CurrMember = Client.getMember(MyTask.getMemberID());
        var FrontMember= Client.getMember(MyTask.getFrontUser());
        var from = CurrMember.getEmail();     // Sender e-mail
        var to = FrontMember.getEmail(); // Receiver e-mail
        var cc = "manager@flowrin.com";
        var fileList = new java.util.Vector();
      var etID = "ETPXXXXXXXXXXX";
        fileList.add("c:\\test.jpg");
        Client.sendTemplateMail(from,to,cc,etID,fileList,MyTask.getID(),true);
        


Parameters:
from - the "from" filed of E-Mail auto append EmailTemplate form
to - the "to" field of E-Mail address(format:aaa@x.y.z), used as the destination of the E-Mail,auto append EmailTemplate to
cc - the "cc" field of E-Mail address
etID - EmailTemplate ID
fileList - the attached file name list. The file name is based on PASE Server.
taskID - the designated taskID to execute
isHtml - set mail format is html or text
Since:
  version 2.2.0






setArtInsState
boolean setArtInsState(PASEartInstance artInstance,
                       java.lang.String stateID)

Set artifact instance state.

        
        Examples:
        
        var stateID = "AST0371992486182500";
        var taskID  = "Tsk000000226232";
        var task    = Client.getTask(taskID);
        var artInstance = task.getArtInstance();
        var Result  = Client.setArtInsState(artInstance,stateID);
        //returns true if it sets successfully ;false otherwise
        


Parameters:
artInstance - the given PASEartInstance
stateID - the given artifact state id
Returns:
true if it sets successfully; false otherwise
Since:
  version 1.0.2
See Also:
PASEartInstance





setGlobals
void setGlobals(java.lang.String rootTaskID,
                java.util.HashMap args)

Keep data into database and then reuse.

        
        Examples:
        
        var task = Form.getCurrentTask();
        var rootTaskID = task.getRootID();
        var ht =  new java.util.HashMap();
        ht.put("ItemName","Pen");
        Client.setGlobals(rootTaskID,ht);
        


Parameters:
rootTaskID - the given root task id
args - the given a HashMap data ( [Key:Value] = [retValue:Boolean(true/false)])
Since:
  version 1.0.0






setLocalObject
void setLocalObject(java.lang.String id,
                    java.lang.Object obj)

Set a local object which belongs to this client.

        
        Examples:
        
        var myTaskList = Client.getTaskOfMember("MEM0000992492169920",Constant.TASK_STATE_ALL);
        Client.setLocalObject("myTaskList1",myTaskList);
        var list = Client.getLocalObject("myTaskList1");
        if(list != null) {
                for(var i=0;i<list.size();i++){
                        var data=list.get(i);
                        //returns element of a Vector object is like "[Tsk000000213214]Process1"
                }
        }
        


Parameters:
id - this object's id
obj - the object.
Since:
  version 1.0.0






setMonitorRelation
boolean setMonitorRelation(java.lang.String sourceTaskID,
                           java.lang.String createdRootTaskID)

Set task monitor relation, store root task ID and those created root task ID when executed.

        
        Examples:
        
        var taskID = Form.getCurrentTask().getID();
        var createRootTaskID = Client.createProcess(userID,proID,args,false, true);
        var result = Client.setMonitorRelation(taskID, createRootTaskID);
        if(result) {
                java.lang.System.out.println("Success!");
        } else {
                java.lang.System.out.println("Failed!");
        }
        


Parameters:
sourceTaskID - the given RootTaskID
createdRootTaskIDs - the given created RootTaskID list
Returns:
true if the execution is successful; false otherwise.
Since:
  version 2.0.0






setMonitorRelation
boolean setMonitorRelation(java.lang.String sourceTaskID,
                           java.util.Vector createdRootTaskIDs)

Set task monitor relation, store root task ID and those created root task ID when executed.

        
        Examples:
        
        var taskID = Form.getCurrentTask().getID();
        var createRootTaskID = Client.createProcess(userID,proID,args,false, true);
        var idList = new java.util.Vector();
        idList.add(createRootTaskID);
        var result = Client.setMonitorRelation(taskID, idList);
        if(result) {
                java.lang.System.out.println("Success!");
        } else {
                java.lang.System.out.println("Failed!");
        }
        


Parameters:
sourceTaskID - the given RootTaskID
createdRootTaskIDs - the given created RootTaskID list
Returns:
true if the execution is successful; false otherwise.
Since:
  version 2.0.0






SQLdeleteValue
boolean SQLdeleteValue(java.lang.String sql)

The method is used to delete value from database (the RTRepository).

        
        Examples:
        
        var sql = "delete from MyTable where Name=\'Pen\'";
        var Result = Client.SQLdeleteValue(sql);
        //returns true if it's successful; false otherwise
        


Parameters:
sql - the input SQL data string
Returns:
true if the deletion is successful; false otherwise.
Since:
  version 1.0.0






SQLinsertValue
boolean SQLinsertValue(java.lang.String sql)

The method is used to insert value to database (the RTRepository).

        
        Examples:
        
        var sql = "Insert MyTable (ItemID,Name,Price) values (101,\'Pen\',350)";
        var Result = Client.SQLinsertValue(sql);
        //returns true if it's successful; false otherwise
        


Parameters:
sql - the input SQL data string
Returns:
true if the insertion is successful; false otherwise.
Since:
  version 1.0.0






SQLloadValue
java.util.List SQLloadValue(java.lang.String sql)

The method is used to load value from database (the RTRepository).

        
        Examples:
        
        var sql = "select ID,UserName from Mem_GenInf ";
        var dataSet = Client.SQLloadValue(sql);
        if (dataSet.size()>0) {
                for (var i=0; i<dataSet.size(); i++){
                        var record = dataSet.get(i);
                        var userID = record.get("ID");
                        //returns the ID field value is like "FR099"
                        var userName = record.get("UserName");
                        //returns the userName field value is like "JeanLin"
                }
        }
        


Parameters:
sql - the input SQL data string
Returns:
the value mapping to the SQL syntax
Since:
  version 1.0.0






SQLupdateValue
boolean SQLupdateValue(java.lang.String sql)

The method is used to update value to database (the RTRepository).

        
        Examples:
        
        var sql = "update MyTable set Price =350 where Name=\'Pen\'";
        var Result = Client.SQLupdateValue(sql);
        //returns true if it's successful; false otherwise
        


Parameters:
sql - the input SQL data string
Returns:
true if the update is successful; false otherwise.
Since:
  version 1.0.0






startTask
java.util.HashMap startTask(Task t)

Start the task.

        
        Examples:
        
        var taskID  = "Tsk000000213214";
        var task    = Client.getTask(taskID);
        var hashmap = Client.startTask(task);
        var retValue = hashmap.get("retValue");
        //returns true if it starts successfully;false otherwise
        


Parameters:
t - the given Task
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)])
Since:
  version 1.0.0
See Also:
Task





stopRootTask
void stopRootTask(java.lang.String rootTaskID)

For flow control, stop the root process
        
        Examples:
        
        Client.stopRootTask("Tsk000000835835");
        


Parameters:
rootTaskID - the root task id.
Since:
  version 1.1.6






unlockCoSign
void unlockCoSign(java.lang.String rt_proID)

Unlock a countrsign task.


Parameters:
rt_proID - the given RootTask-Process string





unlockTask
void unlockTask(java.lang.String tskID)

For task schedule and flow control, set the task unlock
        
        Examples:
        
        Client.unlockTask("TskXXXXXXX");
        


Parameters:
tskID - the task id
Since:
  version 1.1.5






updateArtInstance
boolean updateArtInstance(PASEartInstance instance)

Update artifact instance
  Notice: Artifact instance is carrying artifact state information.
  If the state of instance parameter is not the same as current instance,
  current instance will not be updated with parameter instance.
  Use updateArtInstanceLog(java.lang.String tID, PASEartInstance instance) method
  instead. This behavior is for protecting those processes which are not completed
  yet. Update artifact instance with wrong artifact state could damage process routing.

        
        Examples:
        
      var newArtInstance = Client.createArtInstance("ART0099992486182440");
      var flag = Client.updateArtInstance(newArtInstance);
      


Parameters:
instance - the given PASEartInstance
Returns:
true for success, else false
Since:
  version 1.1.5
See Also:
PASEartInstance





updateArtInstanceLog
boolean updateArtInstanceLog(java.lang.String tID,
                             PASEartInstance instance)

Update artifact instance log

        
        Examples:
        
      var task = Form.getCurrentTask();
      var artInstance = task.getArtInstance();
      var flag = Client.updateArtInstanceLog(task.getID(), artInstance);
      


Parameters:
tID - the given task id
instance - the given PASEartInstance
Returns:
true for success, else false
Since:
  version 1.1.5
See Also:
PASEartInstance





updateAttachFileInfo
boolean updateAttachFileInfo(java.lang.String attachCmpName,
                             AttachFileInfo fileInfo)

update file information of the specified attach file uploaded by attach file component attachCmpName

        
        Examples:
        
        var attachFileCmp = Form.getComponent("AttachFile0");
      var fileList = attachFileCmp.getProperty("FileList");
      var fileInfo = fileList.get(0);
      fileInfo.setNote("file note");
        var result = Client.updateAttachFileInfo("AttachFile0", fileInfo);
        


Parameters:
attachCmpName - the attach file component which fileInfo belongs to
fileInfo - the given AttachFileInfo object
Returns:
if update is successful
Since:
  version 2.0
See Also:
FormAPI





updateCompany
boolean updateCompany(Company company)

Update a Company in organization.

        
        Examples:
        
        Client.updateCompany(company);
        


Parameters:
company - Company instance
Returns:
true if succeeded
See Also:
Company





updateDepartment
boolean updateDepartment(Department dep)

Update a Department in organization.

        
        Examples:
        
        Client.updateDepartment(dep);
        


Parameters:
dep - Department instance
Returns:
true if succeeded
See Also:
Department





updateDeputyAndState
boolean updateDeputyAndState(java.lang.String p_DeputyMemID,
                             boolean p_DeputyState)

Update deputy member id and state.

        
        Examples:
        
        var myTaskList = Client.getTaskOfMember("MEM0000992492169920",Constant.TASK_STATE_ALL);
        var p_DeputyMemID = "MEM0000992492169920";
        var p_DeputyState = true;  // set DeputyState is true
        var Result = Client.updateDeputyAndState(p_DeputyMemID,p_DeputyState);
        //returns true if it's successful; false otherwise
        


Parameters:
p_DeputyMemID - the given the deputy member id
p_DeputyState - the given true if it will start deputy; false otherwise.
Returns:
ture if updating deputy and state successfully; otherwise, false
Since:
  version 1.0.0






updateMemberRecord
boolean updateMemberRecord(MemberRecord mbr)

Update a MemberRecord in organization.

        
        Examples:
        
        Client.updateMemberRecord(member);
        


Parameters:
mbr - MemberRecord instance
Returns:
true if succeeded
See Also:
MemberRecord





updatePASEMessage
boolean updatePASEMessage(PASEMessage msg)

Update the message state includes both IsNew and IsReply fields.

        
        Examples:
        
        var MessageList = Client.getPASEMessageOfMember("MEM0000992492169920");
        if(MessageList != null) {
                for(var i=0;i<MessageList.size();i++){
                        var msg=MessageList.get(i);
                        msg.setNew(true);
                        msg.setReply(false);
                        var Result = Client.updatePASEMessage(msg);
                        //returns true if it's successful; false otherwise
                }
        }
        


Parameters:
msg - the renewable message
Returns:
true if the update is successful; false otherwise.
Since:
  version 1.0.0
See Also:
PASEMessage





updateRole
boolean updateRole(Role role)

Update a Role in organization.

        
        Examples:
        
        Client.updateRole(role);
        


Parameters:
mbr - Role instance
Returns:
true if succeeded
See Also:
Role





updateScheduleEvent
void updateScheduleEvent(ScheduleEvent evt)

Update ScheduleEvent

        
        Examples:
        
        Client.updateScheduleEvent(event);
        


Parameters:
evt - ScheduleEvent which will be updated





updateTask
boolean updateTask(Task t)

Update the task data.

        
        Examples:
        
        var taskID = "Tsk000000226232";
        var task   = Client.getTask(taskID);
        task.setKeyWord("Hello");
        Client.updateTask(task);
        


Parameters:
t - the given Task
Returns:
true for success. false for unsuccess.
Since:
  version 1.0.2
See Also:
Task





updateTaskState
boolean updateTaskState(Task t)

Update the task state.

        
        Examples:
        
        var taskID = "Tsk000000226232";
        var task   = Client.getTask(taskID);
        task.setTaskState(task.TASK_STATE_READY);
        Client.updateTaskState(task);
        


Parameters:
t - the given Task
Returns:
true for success. false for unsuccess.
Since:
  version 1.0.2
See Also:
Task





updateUnitType
boolean updateUnitType(UnitType unit)

Update the specified unit type


Parameters:
unit - the given UnitType
Returns:
true if successful, otherwise false
Since:
  version 2.2.5
See Also:
UnitType





waitTask
void waitTask(java.lang.String tskID)

For task schedule and flow control, set the task waiting
        
        Examples:
        
        Client.waitTask("TskXXXXXX");
        


Parameters:
tskID - the task id
Since:
  version 1.1.5






waitTask
void waitTask(java.lang.String tskID,
              java.lang.String timeString)

For task schedule and flow control, set the task waiting
        
        Examples:
        
        Client.waitTask("TskXXXXXX","2001/12/10/14/12");
        


Parameters:
tskID - the task id
timeString - the time to notify the task
Since:
  version 1.1.5















  
      Overview 
      Package 
    Class 
      Use 
      Tree 
      Index 
      Help 
  



Agentflow
V3.1





 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD






Submit a bug or feature
Copyright 1999-2010 Flowring , Inc. 12F., No.120, Sec2, Gongdao 5th Rd., 
Hsinchu City 300, Taiwan (R.O.C.) All Rights Reserved.

pe.pase Interface ClientAPI

addDebugLog

addErrLog

addExeLog

addFreqApRole

addInfoLog

addMonitorRelation

addMonitorRelation

addNewSessionConnectionURL

addSessionConnectionURL

addSessionConnectionURL

addWarningLog

checkPassword

checkTaskComplete

clearCache

clearServerCache

completeTask

completeTask

createArtInstance

createForm

createForm

createForm

createForm

createFormExt

createProcess

createProcess

createProcess

createProcess

createProcess

createProcess

createProcessByRandom

createScheduleEvent

createSessionConnection

createSessionConnection

deleteCompany

deleteDepartment

deleteGlobals

deleteMemberRecord

deletePASEMessage

deleteRole

deleteSessionConnectionURL

deleteTaskAttachedFile

forceCompleteATask

forceReassignTask

getAddSignTaskList

getAllCSSignResult

getAllDepartmentByName

getAllDepIDOfCompany

getAllDepNameOfCompany

getAllIapSignResult

getAllManager

getAllManagerByID

getAllManagerByLoginID

getAllManagerByNo

getAllMember

getAllMemberByCName

getAllProcess

getAllProjectRoleByName

getAllRoleByName

getAllRoleIDOfCompany

getAllRoleNameOfCompany

getAllUnitType

getAllUnitType

getApplication

getArtifact

getArtifactForm

getArtifactOfCompany

getArtifactOfProject

getArtInsDefaultMap

getArtInstance

getArtInstance

getArtTskID

getATaskNote

getAttachFilePath

getAttachFilePath

getClientMainFrame

getClientMode

getCompany

getCSSignInfo

getCSTaskNote

pe.pase
Interface ClientAPI