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

si.wfinterface
Interface WFCI

public interface WFCI

WFCI: WorkFlow Common Interface.

Version:
1.1.5,
Author:
Flowring co.

Method Summary
 boolean activeBBSBoard(java.lang.String bbsBoardID)
          Active a bbs board in db with a board ID.
 void addAFDBConnectionURL(int seq, int type, java.lang.String dburl, java.lang.String username, java.lang.String password)
          Sets a db URL to db configuration.
 void addAFDBConnectionURL(int seq, int type, java.lang.String name, java.lang.String dburl, java.lang.String username, java.lang.String password)
          Sets a db URL to db configuration.
 void addDebugLog(java.lang.String msg)
           
 void addErrLog(java.lang.String msg)
           
 void addExeLog(java.lang.String msg)
           
 boolean addFreqApRole(java.lang.String freID, java.lang.String rolID)
           
 void addInfoLog(java.lang.String msg)
           
 boolean addMonitorRelation(java.lang.String sourceTaskID, java.lang.String createdRootTaskID)
           
 boolean addMonitorRelation(java.lang.String sourceTaskID, java.util.Vector createdRootTaskIDs)
           
 int addNewAFDBConnectionURL(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 addWarningLog(java.lang.String msg)
           
 java.util.Vector ArtSQLloadValue(java.lang.String sql)
          The method is used to load value from database by nickname (the RTRepository).
 java.util.Vector batchProcess(java.util.Vector completeTask, java.util.Vector removeRootTask, java.util.Vector createPro)
          Batch create, remove and complete process.
 boolean bypassTask(Task p_Task, java.lang.String p_AstID)
          Bypass the task.
 boolean canPrintPASESharedFile(java.lang.String fId, java.lang.String mId)
           
 boolean canReadPASESharedFile(java.lang.String fId, java.lang.String mId)
           
 boolean canWritePASESharedFile(java.lang.String fId, java.lang.String mId)
           
 boolean changePassword(java.lang.String loginID, java.lang.String newPwd)
          The method is used to change the password of some member without checking old password.
 boolean changePassword(java.lang.String memID, java.lang.String oldPwd, java.lang.String newPwd)
          The method is used to change the password of some member.
 boolean checkValidNameUser()
          check if the license of Name User is bigger than the number in DB
 void clearCache()
          Clear the cache of the PASE server.
 void clearCache(java.lang.String type)
          Clear this type cache of the PASE server.
 boolean clearQuestionnaireViews(java.lang.String qneId)
          The implement method should clear views count when updated a specified questionnaire result.
 void closeAFDBConnection(java.lang.String session)
          Close a SessionConnection object.
 void commitAFDBConnection(java.lang.String session)
          Make commit in the session connection.
 java.util.HashMap completeTask(Task t)
          Complete the task.
 java.util.HashMap completeTask(Task t, java.lang.String stateID)
          Complete the task.
 int connectServer(java.lang.String host, java.lang.String port)
          Connect to the PASE server by the given host address and host port.
 AFDBConnection createAFDBConnection(int seq)
          Create an AFDBConnection object with database configuration, by the specific sequence.
 AFDBConnection createAFDBConnection(java.lang.String name)
          Create an AFDBConnection object with database configuration, by the specific name.
 PASEartInstance createArtInstance(java.lang.String aID)
          Create artifact instance.
 PASEartInstance createFreqArtInstance(java.lang.String aID)
          Create artifact instance, for FreqAp use.
 PASEGroup createPASEGroup()
           
 PASESharedFile createPASESharedFile()
           
 java.lang.String createProcess(java.lang.String userID, java.lang.String proID, java.util.HashMap args, boolean isPopUp)
          Create a Process.
 java.lang.String createProcess(java.lang.String userID, java.lang.String proID, java.util.HashMap args, boolean isPopUp, boolean isDelible)
          Create a Process.
 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.
 ScheduleEvent createScheduleEvent()
          Creates new ScheduleEvent.
 boolean delBBSMsg(java.lang.String bbsBoardID, java.lang.String msgID)
          Delete a bbs message in db with a borad ID and a message ID.
 boolean deleteActivity(com.flowring.onlineregister.entity.Activity act)
           
 boolean deleteActivityPerm(java.lang.String aId, java.lang.String memId)
           
 boolean deleteAeppServerOfMultiOrg(java.lang.String ID)
          Delete a AEPP Server with specified AEPP Server ID.
 java.util.HashMap deleteAFDBConnectionURL(java.lang.String name)
          Delete a db URL from db configuration.
 boolean deleteBBSBoard(java.lang.String bbsBoardID)
          Deletes a bbs board in db with a board ID.
 boolean deleteBoardAdmin(java.lang.String memId)
           
 boolean deleteBoardPerm(java.lang.String messageId, java.lang.String memId)
           
 boolean deleteDashboard(java.lang.String boardId)
           Deletes a Dashboard and its style list.
 boolean deleteDashboardStyle(java.lang.String styleId)
          Deletes a DashboardStyle from table.
 boolean deleteGlobals(java.lang.String rootTaskID)
          Delete Globals data from database.
 boolean deleteMailLoginTimeStamp(java.lang.String mailId)
          To delete the data from database by the mail id .
 boolean deleteMailLoginTimeStampByTaskId(java.lang.String taskId)
          To delete the data from database by the task id .
 boolean deleteMbrSignGroup(java.lang.String mbrId, AFGroup group)
           
 boolean deleteMultiOrgPerm(java.lang.String memId)
          Delete the user's multiorg permission with specified member ID.
 boolean deleteOption(com.flowring.questionnaire.entity.Option opt)
          The implement method should remove a option datas from database by the given option object.
 boolean deleteOption(java.lang.String optId)
          The implement method should remove a option datas from database by the given option id.
 void deletePASEGroup(java.lang.String id)
           
 boolean deletePASEMessage(PASEMessage msg)
          Delete message from database.
 boolean deletePASEMessageByID(java.lang.String msgID)
          Delete message from database with message ID.
 void deletePASESharedFile(java.lang.String fId)
           
 boolean deletePersonalDboard(java.lang.String dboardId, PersonalConfig pConfig)
           
 boolean deletePersonalFavorite(java.util.Vector vec, PersonalConfig pConfig)
           
 boolean deleteProcessMapCategory(java.lang.String id)
          Delete a ProcessMap Categoty with specified ID.
 boolean deleteProcessMapLink(Link link)
          Delete one ProcessMap Link with specified ID and parent ID of the Link bean.
 boolean deleteQuestionnaire(com.flowring.questionnaire.entity.Questionnaire q)
          The implement method should remove a questionnaire and its related datas from database by the given questionnaire object.
 boolean deleteQuestionnaire(java.lang.String qId)
          The implement method should remove a questionnaire and its related datas from database by the questionnaire id.
 boolean deleteQuestionnaireAdmin(java.lang.String memId)
          The implement method should remove a manager from questionnaire manager list by the given member id.
 boolean deleteQuestionnairePerm(java.lang.String qneId, java.lang.String memId)
          The implement method should remove a questionnaire permission from database by the given parameters.
 boolean deleteRegAdmin(java.lang.String mbrId)
           
 boolean deleteTaskAttachedFile(java.lang.String fileID)
           
 void deleteUserCalendar(java.lang.String calendarID)
          delete user calendar with specified calendar id
 boolean deleteVotAdmin(java.lang.String memId)
           
 boolean deleteVote(com.flowring.onlinevote.entity.Vote vote)
           
 boolean deleteVoteOpt(com.flowring.onlinevote.entity.VoteOpt voteOpt)
           
 boolean deleteVotPerm(java.lang.String votId, java.lang.String memId)
           
 int disconnectServer()
          Disconnect to the PASE server.
 boolean doVote(java.util.List ticketList)
           
 boolean forceReassignTask(java.lang.String p_TaskID, java.lang.String p_MemID)
          Force to reassign the task.
 boolean forceReassignTask(Task p_Task, MemberRecord p_MR)
          Force to reassign the task.
 boolean genQuestionnaire(java.lang.String qneId)
          The implement method should generate empty Questionnaires result when add a new questionnaire or update a questionnaire.
 boolean genTicket(java.lang.String votId, java.util.List memIdList)
          ²£¥Í¿ï²¼
 com.flowring.onlineregister.entity.Activity getActivity(java.lang.String actId)
           
 java.util.Vector getActivityList()
           
 java.util.Vector getActivityList(java.lang.String memId)
           
 java.util.Vector getActivityListByMbrId(java.lang.String id)
           
 java.util.Vector getActivityListByMbrIdAndActDate(java.lang.String id)
           
 java.util.Vector getActivityListByRegDate()
           
 java.util.Vector getActivityListByVersionId(java.lang.String versionId)
           
 java.util.Vector getActivityPermList(java.lang.String aId)
           
 java.util.Vector getAddSignTaskList(java.lang.String signTaskId)
           
 java.util.List getAeppServerListOfMultiOrg()
          Get all AEPP Server in database.
 com.flowring.aeppServer.AeppServer getAeppServerOfMultiOrg(java.lang.String ID)
          Get the AeppServer bean with specified AEPP Server ID.
 AFConnection getAFConnection()
          Gets AFConnection, retrieve the connection between wfci and server.
 java.util.HashMap getAFDBConnectionURL(int seq)
          Gets a db configuration by given sequence number.
 java.util.HashMap getAFDBConnectionURL(java.lang.String name)
          Gets a db configuration by given name.
 java.util.Vector getAFDBConnectionURLList()
          Gets all db configurations.
 AFTask getAFTask(java.lang.String tID)
          Returns a data object of AFTask.
 java.util.Collection getAllAddASResult(java.lang.String taskID)
          Returns all add AS result that were written before the given task.
 java.util.Vector getAllBBSBoard()
          Gets all bbs boards, including active and suspended.
 java.util.Vector getAllBBSBoardByComID(java.lang.String comID)
          Gets all bbs boards(include the announcement board) by company id.
 java.util.Vector getAllComIDOfMember(java.lang.String memID)
           
 java.util.Collection getAllCSTaskNote(java.lang.String taskID)
          Returns all CS Tasks' note that were written before the given task.
 java.util.Vector getAllDepartmentByName(java.lang.String mName)
          Gets all departments by the same name.
 java.util.Vector getAllDepIDOfCompany()
          Gets all departments' id in the company.
 java.util.Vector getAllDepIDOfMember(java.lang.String memID)
           
 java.util.Vector getAllDepNameOfCompany()
          Gets all departments' name in the company.
 java.util.Collection getAllIapSignResult(java.lang.String taskID)
          Returns all add AS result that were written before the given task.
 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()
          Returns all member of system.
 java.util.Vector getAllMemberByCName(java.lang.String mName)
          Gets all members by the same name.
 java.util.Vector getAllMessageOfMem(java.lang.String boardID, java.lang.String memID)
           
 java.util.List getAllPASEGroupByName(java.lang.String name)
           
 java.util.Vector getAllProjectRoleByName(java.lang.String mName)
           
 java.util.Vector getAllRoleByName(java.lang.String mName)
          Gets all roles by the same name.
 java.util.Vector getAllRoleIDOfCompany()
          Gets all role id in the company.
 java.util.Vector getAllRoleNameOfCompany()
          Gets all role name in the company.
 java.util.List getAllTimeZones()
          get all timezones in database
 java.util.Vector getAllTskIDListByGPro(java.lang.String gProID, java.lang.String frontTaskID)
           
 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.util.List getAllUserCalendar()
          get all user calendar
 java.lang.String getAnnouncementCompanyName(java.lang.String boardID)
          get the name of company by announcement board id
 AFTaskList getApprovalHistoryRootTaskOfJoinMember(java.lang.String mbrID)
          Returns a Approval History Root Task List of the Member(mbrID).
 Artifact getArtifact(java.lang.String aID)
          Returns a data object of artifact.
 java.util.Vector getArtifactForm(java.lang.String aID)
          Returns artifact forms of some specific artifact.
 java.util.Vector getArtifactOfCompany()
          Returns all artifacts.
 java.util.Vector getArtifactOfProject(java.lang.String prjID)
          Returns all artifact of some specific project.
 PASEartInstance getArtInstance(java.lang.String iID)
          Returns a data object of artifact instance with current Task.
 PASEartInstance getArtInstance(java.lang.String iID, java.lang.String tID)
          Returns a data object of artifact instance with specific task.
 java.util.Vector getArtInstanceOfArtifact(java.lang.String aID)
          Returns all artifact instances instanciated by some specific artifact.
 java.lang.String getArtTskID(java.lang.String iID)
          Gets the latest associated TaskID with the Artifact Instance.
 java.util.HashMap getATaskNote(java.lang.String tskID)
           
 java.util.List<AuthLDAPConfig> getAuthLDAPConfigs()
          Retrieve the ldap configs
 BBS getBBS()
          Gets a BBS interface
 java.util.Vector getBBSBoard()
          Gets bbs boards, only active.
 BBSBoard getBBSBoard(java.lang.String bbsBoardID)
          Gets the bbs board with the specific ID.
 java.util.Vector getBBSBoardByRangeID(java.util.Vector rangeList)
          Gets bbs boards by member's role.
 BBSMessage getBBSMsg(java.lang.String msgID)
          Gets the bbs message with the specific ID.
 java.util.Vector getBBSMsgList(java.lang.String bbsBoardID)
          Gets all messages with a board ID.
 java.util.Vector getBBSSearchResult(java.lang.String bbsBoardID, java.lang.String keyword)
          Gets all messages with a keyword in some board.
 java.util.Vector getBoardAdminList()
           
 java.util.Vector getBoardPermList(java.lang.String messageId)
           
 java.util.Vector getCollectedTskIDListByGPro(java.lang.String gProID, java.lang.String frontTaskID)
           
 java.util.Vector getComIDListOfMember(java.lang.String memID)
          Get the company id list of a member
 java.lang.String getComIdOfDep(java.lang.String depID)
          Get the company id of a department
 java.lang.String getComIdOfRole(java.lang.String rolID)
          Get the company id of a role
 Company getCompany()
          Returns a data object of company.
 Company getCompany(java.lang.String comID)
          Returns a data object of company by a specified company id.
 java.util.Map getCompanyAnnouncementBoard()
          get the map of every company's announce board.
 java.util.Vector getCPTaskIDList(java.lang.String cProID, java.lang.String frontTaskID)
           
 java.util.HashMap getCSTaskNote(java.lang.String taskID)
          Gets CSTask Notes that are written before the given task.
 com.flowring.dashboard.Dashboard getDashboard(java.lang.String boardId)
          Returns a Dashboard object by a given Dashboard id.
 java.util.List getDashboardGroupList()
          Gets a list of group from Dashboard without duplicated.
 java.util.List getDashboardGroupList(java.lang.String proId)
          Gets a list of group from Dashboard by the given process id.
 java.util.List getDashboardGroupListOfUser(java.lang.String memId, boolean isMainRoleOnly)
          Gets a list of group of user's from Dashboard without duplicated.
 java.lang.String getDashboardId(java.lang.String prjId, java.lang.String proId, java.lang.String grpId)
          Gets a Dashboard id by the given value.
 java.util.List getDashboardList()
          Gets a dashboard list.
 java.util.List getDashboardListByConditionType(java.lang.String columnName, int relation, java.lang.String columnValue)
           Gets a dashboard list by condition type.
 java.util.List getDashboardListByGroup(java.lang.String grpId)
          Gets a dashboard list by the given group id, which contains each id's name.
 java.util.List getDashboardProcessList(java.lang.String prjId)
          Gets a list of process from Dashboard by the given project id.
 java.util.List getDashboardProjectList()
          Gets a list of project form Dashboard without duplicate.
 java.util.List getDashboardStyleIdList(java.lang.String boardId)
          Gets DashboardStyle id list of a dashboard by a given value.
 java.util.List getDashboardStyleList(java.lang.String boardId)
          Gets a DashboardStyle list by a given value.
 java.lang.String getDbConnectionCurrentState()
          Get the information about the system database connection : Max. connection size, Min. connection size, Current used connection size.
 int getDBNameUser()
          Return the number of NameUser
 DBProcess getDBProcess(java.lang.String pID)
          Returns a data object of process.
 Department getDepartment(java.lang.String dID)
          Returns a data object of department by 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.util.Vector getDepartmentListOfPASEGroup(java.lang.String gId)
           
 java.util.Vector getDeputiedOfMember(java.lang.String mID)
          Gets a member list that the given member is each one of the list member deputy.
 EmailTemplate getEmailTemplate(java.lang.String etID)
          getEmailTemplate by PROID or ETID.
 EnterpriseModel getEnterpriseDiagram()
          Gets the Enterprise Diagram data model.
 FileManager getFileManager()
          Gets a FileManager object.
 UnitType getFirstLevelUnitType()
          Get first unit's unit types
 java.lang.String getFlowServerHost()
          Gets the PASE server address.
 java.lang.String getFlowServerPort()
          Gets the PASE server port.
 java.util.Vector getFreqApItemList()
          Returns a FreqAp diagram item Vector.
 java.util.Vector getFreqApListOfMember(java.lang.String memID)
          Returns a PASEFreqAp List of the specific member.
 java.util.Vector getFreqApNodeList()
          Returns a PASEFreqApNode list that will be shown in the FreqAP diagram.
 java.util.Vector getFreqMessageByMbrId(java.lang.String mbrId)
           
 java.util.HashMap getGlobals(java.lang.String rootTaskID)
          Gets Globals data from previous setGlobals function.
 java.util.Vector getGroupSignTinyTaskList(java.lang.String mID)
          Returns all groupsign tasks of some specific member.
 java.util.Vector getHalfHolidays()
          get half holidays in system's default calendar.
 java.util.Vector getHalfHolidays(java.lang.String memID)
          get half holidays in member's calendar.
 AFTaskList getHistoryRootTaskOfJoinMember(java.lang.String mbrID)
          Returns a History Root Task List of the Member(mbrID).
 java.util.Vector getHolidays()
          get holidays in system's default calendar.
 java.util.Vector getHolidays(java.lang.String memID)
          get holidays in member's calendar.
 java.util.Vector getInvolvedExecutors(java.lang.String rootTaskID)
          Returns ID list of executors who involved in the root process.
 java.util.Vector getInvolvedMembers(java.lang.String rootTaskID)
          Returns ID list of members who involved in the root process.
 java.util.Vector getLatestBBSMsg(int count)
          Gets the latest BBS Message with the specific count number.
 java.util.Vector getLatestBBSMsg(int count, java.lang.String expBoardID)
          Gets the latest BBS Message with the specific count number.
 java.util.Vector getLatestBBSMsgByMemID(int count, java.util.Vector boardList)
           
 int getLicenseNameUser()
          Return the license of NameUser
 long getMailLoginTimeStamp(java.lang.String mailId)
          Gets the time value in milliseconds of TimeStamp.
 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)
          Gets manager role by the specified member, role or department ID.
 java.util.Vector getManagersOfDRM(java.lang.String id)
          Gets all manager id by member id, role id, or department id.
 java.util.Vector getMbrSignGroupList(java.lang.String mbrId)
           
 MemberRecord getMember(java.lang.String id)
          Returns a data object of member by ID, LoginID, or Chinese-Name.
 AccessMember getMemberAccess(java.lang.String mID)
          Gets the access config of Agenda for the specific member.
 AccessAdmin getMemberAdminAccess(java.lang.String mID)
          Gets the access config of Admin for the specific member.
 java.util.Vector getMemberArtifactAccess(java.lang.String mID)
          Gets the access config list of Agenda's function "artifact search" for the specific member.
 MemberRecord getMemberByCName(java.lang.String mName)
          Returns a data object of member by Chinese-Name.
 MemberRecord getMemberByID(java.lang.String mID)
          Returns a data object of member by ID.
 MemberRecord getMemberByName(java.lang.String mLoginID)
          Returns a data object of member by LoginID.
 java.util.Vector getMemberListOfPASEGroup(java.lang.String gId)
           
 AccessOnLineUser getMemberOnLineAccess(java.lang.String mID)
          Gets the access config of Agenda's function "on-line user" for the specific member.
 java.util.Vector getMemberTaskAccess(java.lang.String mID)
          Gets the access config list of Agenda's function "task search" for the specific member.
 java.util.List getMultiOrgPermList()
          Get all member ID of users who can use multiorg.
 java.util.List getMultiOrgPermLoginIDList()
          Get all login ID of users who can use multiorg.
 com.flowring.aeppServer.MultiServerACL getMultiServerACL(java.lang.String muoId, java.lang.String memId)
          Get Multi Server access control with specified multiorg ID and member ID.
 java.lang.String getNewAFGroupID()
           
 java.lang.String getNewArtInsID()
          Returns a new ArtIns ID.
 java.lang.String getNewBBSMsgID()
          Returns a new BBS Msg ID.
 java.lang.String getNewDayId()
          Generate a new Day ID.
 java.lang.String getNewFileID()
          Returns a new File ID.
 java.lang.String getNewGroupSignID()
          Generate a new GroupSign ID
 java.lang.String getNewMsgID()
          Returns a new Msg ID.
 java.lang.String getNewMultiAeppServerID()
          Retrieve the multi AEPP Server ID.
 java.lang.String getNewOfficeHourId()
          Generate a new OfficeHour ID.
 java.lang.String getNewProcessMapCategoryID()
          Get a ID of the ProcessMap Category.
 java.lang.String getNewTaskID()
          Returns a new Task ID.
 java.lang.String getNewWorkingDayId()
          Generate a new WorkingDay ID.
 java.lang.String getNewWorkingDayTemplateId()
          Generate a new WorkingDayTemplate ID.
 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)
          Gets department by the specified department name.
 Role getOneRoleByName(java.lang.String mName)
          Gets role by the specified role name.
 java.util.Vector getOnlineAdminUser()
          Gets the on-line admin user list.
 java.util.Vector getOnlineUser()
          Gets the on-line user list.
 java.util.List getOptionList(java.lang.String qstId)
          The implement method should get option list by the given question id.
 java.util.List getOptionTemplateIdList()
          The implement method should return option template id list.
 java.util.Vector getParentIDListOfMember(java.lang.String mID, boolean isMainRoleOnly)
          Gets All parent CompanyID, RolID, DepID, MemID of Member.
 PASEFreqAp getPASEFreqAp(java.lang.String freID)
          Returns a PASEFreqAp with the specific ID.
 PASEGroup getPASEGroup(java.lang.String id)
           
 java.util.Vector getPASEGroupList()
          Get all PASEGroup.
 java.util.List getPASEGroupListByIdList(java.util.Vector idList)
          get all PASEGroup id list by id list.
 java.util.Vector getPASEMessageOfMember(java.lang.String mID)
          Gets message of the member.
 AFProcessList getPASEProcessOfMember(java.lang.String mID)
          Returns the root processes of some specific member.
 PASESharedFile getPASESharedFile(java.lang.String fId)
           
 PASESharedFile getPASESharedFileByPath(java.lang.String fPath)
           
 java.util.Vector getPDiagramDetail(java.lang.String rootTID)
          Returns the detail of process diagram.
 java.util.HashMap getPDiagramState(java.lang.String rootTID)
          Returns the states of process diagram.
 PersonalConfig getPersonalConfig(java.lang.String mId)
           
 PersonalConfig getPersonalFavorite(java.lang.String memberId, java.lang.String variety)
           
 PersonalConfig getPersonalProShow(java.lang.String memberId, java.lang.String variety)
           
 java.util.HashMap getProcessDiagram(java.lang.String rootPID, java.lang.String rootTaskID)
          Returns a process diagram.
 java.util.HashMap getProcessDiagramAndState(java.lang.String rootPID, java.lang.String rootTaskID)
          Gets Monitor Diagram Data.
 Category getProcessMapCategory(java.lang.String id)
          Get the Category bean of ProcessMap with specified ID.
 java.util.List getProcessMapCategoryList()
          Get all ProcessMap Category in database.
 Link getProcessMapLink(Link link)
          Get the ProcessMap Link bean with specified ID and parent ID of the Link bean.
 java.util.List getProcessMapLinkList(java.lang.String parentId)
          Get all ProcessMap Link with specified parent ID.
 java.util.List getProcessMapParentIdListByProId(java.lang.String proId)
          Get all parent Id by process Id.
 ProcessVersion getProcessVersion(java.lang.String rootProcessId)
          Returns a data object of process version.
 java.util.HashMap getProcessView(java.lang.String rootPID)
           
 java.util.HashMap getProductInfo()
          Gets product version info.
 Project getProject(java.lang.String prjID)
          Returns a data object of project by ID.
 AFProjectList getProjectOfCompany()
          Returns all projects.
 AFProjectList getProjectOfDepartment(java.lang.String dID)
          Returns the projects of some specific department.
 AFProjectList getProjectOfManager(java.lang.String managerID)
          Returns the projects with some specific project manager.
 Project getProjectOfPASEProcess(java.lang.String proID)
          Returns the project of the PASEProcess.
 ProjectRole getProjectRole(java.lang.String rID)
          Returns a data object of project role by ID.
 java.util.List getPumpTaskList(java.lang.String rootID)
          get pump task list.
 com.flowring.questionnaire.entity.Questionnaire getQuestionnaire(java.lang.String qId)
          The implement method should return a Questionnaire object by the given questionnaire id.
 java.util.List getQuestionnaireAdminList()
          The implement method should get manager list of questionnaire module.
 java.util.List getQuestionnaireList()
          The implement method should get all questionnaire.
 java.util.List getQuestionnaireList(com.flowring.questionnaire.entity.QuestionnaireSearchCondition condition)
          The implement method should get questionnaire list by the given questionnaire search condition.
 java.util.List getQuestionnairePermList(java.lang.String qneId)
          The implement method should get questionnaire permission list by the given questionnaire id.
 com.flowring.questionnaire.entity.QuestionnaireResult getQuestionnaireResult(java.lang.String qneId, java.lang.String memId)
          The implement method should return a QuestionnaireResult object by the given parameters.
 java.util.List getQuestionnaireResultList(java.lang.String qneId)
          The implement method should get QuestionnaireResult list by the given questionnaire id.
 com.flowring.questionnaire.entity.QuestionnaireSummaryResult getQuestionnaireSummaryResult(com.flowring.questionnaire.entity.Questionnaire qne)
          Get a questionnaire summary result.
 java.util.Vector getRegAdminList()
           
 ReportService getReportService()
           
 AFTaskList getRequestHistoryRootTaskOfJoinMember(java.lang.String mbrID)
          Returns a Request History Root Task List of the Member(mbrID).
 Role getRole(java.lang.String rID)
          Returns a data object of role by ID.
 java.util.Vector getRoleListOfPASEGroup(java.lang.String gId)
           
 java.util.Map getRoleSearchResult(java.lang.String keyword, boolean depNameSearch, boolean rolNamesearch, boolean memNameSearch, boolean loginIdSearch)
          Get the role search result with the keyword.
 java.util.Vector getRootDBProcessOfProject(java.lang.String prjID)
          Returns a data object of process.
 AFTaskList getRootTaskOfJoinMember(java.lang.String mID)
          Returns root tasks with some specific member is involved in.
 AFTaskList getRootTaskOfJoinMember(java.lang.String mID, int state)
          Returns root tasks with the specific member is involved in and the specific state.
 AFTaskList getRootTaskOfJoinMember(java.lang.String mID, java.lang.String proID)
          Returns root tasks with the specific member is involved in and the specific state.
 AFTaskList getRootTaskOfMember(java.lang.String mID)
          Returns root tasks executed by some specific member.
 AFTaskList getRootTaskOfMember(java.lang.String mID, int state)
          Returns root tasks which in some state and executed by some specific member.
 java.util.Vector getRootTaskOfProcess(java.lang.String proID)
          Returns the task list of the Process.
 java.util.Vector getRootTaskOfProcess(java.lang.String proID, int state)
          Returns the task list of the Process with the specific state.
 ScheduleEvent getScheduleEvent(java.lang.String id)
          Gets schedule event.
 SerRuntimeEnv getServerEnv()
          Gets server runtime environment.
 double getServerGMT()
          get the GMT of server
 java.util.HashMap getServerStatus()
          Gets server status.
 long getServerTime()
          Gets server time.
 java.util.Vector getSubDepIDOfDR(java.lang.String id, boolean exp)
          Gets sub-department's id by 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)
          Gets sub-department's name by 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)
          Gets sub-member's name by 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)
          Gets sub-member's ID by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
 java.util.Vector getSubMemListOfMember(java.lang.String mID)
          Returns a MemberRecord ID list of sub-members of the member.
 java.util.Vector getSubRoleIDOfDR(java.lang.String id, boolean exp)
          Gets sub-role's id by 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)
          Gets sub-role's name by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.
 AFTaskList getSubTaskList(java.lang.String parentTID)
          Returns subtasks of some specific task.
 Task getTask(java.lang.String tID)
          Returns a data object of task.
 java.lang.String getTaskAttachedFileContent(java.lang.String fileID)
           
 java.util.Vector getTaskIDListOfMember(java.lang.String mID, int sc, int ec, java.lang.String order)
          Returns all task id of some specific member.
 AFTaskList getTaskList(java.lang.String mID)
          Returns all tasks of some specific member.
 TaskManager getTaskManager()
          Gets a TaskManager object.
 java.util.Vector getTaskOfCompany()
           
 java.util.Vector getTaskOfCompany(int state)
           
 java.util.Vector getTaskOfDepartment(java.lang.String dID)
           
 java.util.Vector getTaskOfDepartment(java.lang.String dID, int state)
           
 AFTaskList getTaskOfMember(java.lang.String mID)
          Returns tasks executed by some specific member.
 AFTaskList getTaskOfMember(java.lang.String mID, int state)
          Returns root tasks which in some state and executed by some specific member.
 AFTaskList getTaskOfProcess(java.lang.String proID)
          Returns the task list of the Process.
 AFTaskList getTaskOfProcess(java.lang.String proID, int state)
          Returns the task list of the Process with the specific state.
 java.util.Vector getTaskOfRole(java.lang.String rID)
           
 java.util.Vector getTaskOfRole(java.lang.String rID, int state)
           
 AFTaskList getTaskOfRootTask(java.lang.String rootTID)
          Returns tasks of some specific root task.
 java.util.Map getTicketList(java.lang.String votId)
           
 java.util.Vector getTinyPDiagramDetail(java.lang.String rootTID, java.lang.String mID)
          Returns the detail of process diagram.
 java.util.List getTinyQuestionnaireListByCond(com.flowring.questionnaire.entity.QuestionnaireSearchCondition qsc, java.lang.String memId)
          Get TinyQuestionnaireList by SQL WHERE condition.
 java.util.List getTinyRootTaskIdListOfJoinMember(java.lang.String mID, java.lang.String rootDate, java.lang.String rootName, java.lang.String rootState)
          Returns tasks with some specific member is involved in.
 java.util.Vector getTinyRootTaskOfJoinMember(java.lang.String mID)
          Returns root tasks with some specific member is involved in.
 java.util.Vector getTinyRootTaskOfJoinMember(java.lang.String mID, java.lang.String proID)
          Returns root tasks with some specific member is involved in.
 java.util.List getTinyTaskIdListTracked(java.lang.String mID, java.util.Vector idList, java.lang.String state)
          Returns all tasks of some specific member.
 java.util.Vector getTinyTaskList(java.lang.String mID)
          Returns all tasks of some specific member.
 java.util.Vector getTinyTaskList(java.lang.String mID, int sc, int ec, java.lang.String order)
          Returns all tasks of some specific member.
 java.util.Vector getTinyTaskList(java.lang.String mID, java.util.Vector idList)
          Returns all tasks of some specific member.
 java.util.HashMap getTreeTaskList(java.lang.String mID)
          Returns the project-tasks vector of some specific member.
 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.
 com.flowring.schedule.UserCalendar getUserCalendar(java.lang.String calendarID)
          get user calendar by specified calendar id
 com.flowring.schedule.UserCalendar getUserCalendarByUser(java.lang.String id)
          get user calendar by specified id, ex:MEMxxx(MainRole), ROLxxx, DEPxxx, COMxxx.
 java.util.HashMap getUserCalendarMap(java.lang.String memID)
          get member's all UserCalendars corresponding to every role;
 java.util.Vector getVariableList()
          Get All Variable
 java.util.List getVotAdminList()
           
 com.flowring.onlinevote.entity.Vote getVote(java.lang.String voteId)
           
 java.util.List getVoteList()
           
 java.util.List getVoteListByCond(java.lang.String cond, java.lang.String memId, java.lang.String votingStage)
           
 com.flowring.onlinevote.entity.VoteResult getVoteResult(java.lang.String votId)
           
 java.util.List getVotPermList(java.lang.String votId)
           
 int[] getWeek()
          get the work days of a week in member's calendar.
 int[] getWeek(java.lang.String memID)
          get the work days of a week in member's calendar.
 java.util.Vector getWorkdays()
          get work days in system's default calendar.
 java.util.Vector getWorkdays(java.lang.String memID)
          get work days in member's calendar.
 boolean goBackTo(java.lang.String fromTaskID, java.lang.String toProID, boolean artMode)
          Go back to a former task node in the same process.
 boolean goBackTo(java.lang.String fromTaskID, Task toTask, boolean artMode)
          Go back to a former task node in the same process.
 boolean goBackTo(java.lang.String fromTaskID, Task toTask, boolean artMode, boolean isEmailNotify)
          Go back to a former task node in the same process.
 boolean goBackTo(Task fromTask, java.lang.String toProID, boolean artMode)
          Go back to a former task node in the same process.
 java.util.HashMap goBackToWithDetailRet(Task fromTask, java.lang.String toProID, boolean artMode)
           
 boolean increaseQuestionnaireViews(java.lang.String qneId)
          The implement method should increase views count when user click or read a specified questionnaire.
 java.util.HashMap initAgenda(java.lang.String user)
          Initialize user's personal Agenda, return essential data.
 void initHoliday()
          Initialize holidays.
 java.util.HashMap initProcess(java.lang.String user, PASEProcess process)
          Initial the process.
 java.util.HashMap initProcess(java.lang.String user, java.lang.String roleID, java.lang.String depID, java.lang.String processID, java.lang.String processName, java.lang.String subject, int priority)
          Initial the process.
 boolean insertActivity(com.flowring.onlineregister.entity.Activity act)
           
 boolean insertActivityPerm(java.lang.String aId, java.lang.String memId)
           
 boolean insertAeppServerOfMultiOrg(com.flowring.aeppServer.AeppServer aeppServer)
          Insert a AEPP Server.
 boolean insertBoardAdmin(java.lang.String memId)
           
 boolean insertBoardPerm(java.lang.String messageId, java.lang.String memId)
           
 boolean insertDashboard(com.flowring.dashboard.Dashboard dboard)
           Adds a Dashboard only.
 boolean insertDashboardStyle(com.flowring.dashboard.DashboardStyle dstyle)
          Adds a DashboardStyle into table.
 boolean insertMbrSignGroup(java.lang.String mbrId, AFGroup group)
           
 boolean insertMultiOrgPerm(java.lang.String memId)
          Insert a user who is permitted to use multiorg with specified member ID.
 boolean insertOption(com.flowring.questionnaire.entity.Option opt)
          The implement method should insert datas into database by the given option object.
 void insertPASEGroup(PASEGroup group)
           
 void insertPASESharedFile(PASESharedFile sFile)
           
 boolean insertPersonalDboard(java.lang.String dboardId, PersonalConfig pConfig)
           
 boolean insertPersonalFavorite(java.util.Vector vec, PersonalConfig pConfig)
           
 boolean insertPersonalProShow(java.lang.String memberId, java.lang.String showType, java.lang.String variety)
           
 boolean insertProcessMapCategory(Category category)
          Insert a new ProcessMap Category.
 boolean insertProcessMapLink(Link link)
          Insert a new ProcessMap Link.
 boolean insertQuestionnaire(com.flowring.questionnaire.entity.Questionnaire q)
          The implement method should insert datas into database by the given questionnaire object.
 boolean insertQuestionnaireAdmin(java.lang.String memId)
          The implement method should insert datas into database by the given member id.
 boolean insertQuestionnairePerm(java.lang.String qneId, java.lang.String memId)
          The implement method should insert datas into database by the given parameters.
 boolean insertQuestionnaireResult(com.flowring.questionnaire.entity.QuestionnaireResult qneResult)
          The implement method should insert datas into database by the given QuestionnaireResult object.
 boolean insertRegAdmin(java.lang.String mbrId)
           
 void insertScheduleEvent(ScheduleEvent evt)
          Insert ScheduleEvent into table.
 boolean insertTaskAttachedFile(TaskAttachedFileInfo fileInfo)
           
 boolean insertTaskGroupSign(java.lang.String taskID, java.lang.String groupSignID, long signTime)
          This method is used for insert into Task_GroupSign.
 boolean insertVotAdmin(java.lang.String memId)
           
 boolean insertVote(com.flowring.onlinevote.entity.Vote vote)
           
 boolean insertVoteOpt(com.flowring.onlinevote.entity.VoteOpt voteOpt)
           
 boolean insertVotPerm(java.lang.String votId, java.lang.String memId)
           
 boolean isAlreadyVote(java.lang.String votId, java.lang.String memID)
           
 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 isContainedInPASEGroup(java.lang.String gId, java.lang.String mID)
           
 boolean isDashboardExist(java.lang.String prjId, java.lang.String proId, java.lang.String grpId)
          Test dashboard exist or not by the given value.
 boolean isDashboardStyleSiblingOrderExist(java.lang.String boardId, int siblingOrder)
          Tests whether the dashboard style's SiblingOrder exist or not.
 boolean isEnabledModule(java.lang.String moduleName)
          Returnss the flag indicates whether a module is enabled.
 boolean isHalfHoliday(java.lang.String date)
          Check specified date whether it's a half of holiday or not.
 boolean isHalfHoliday(java.lang.String date, java.lang.String memID)
          Check if the date is half-holiday in user's calendar.
 boolean isHoliday(java.lang.String date)
          Check specified date whether it's a holiday or not.
 boolean isHoliday(java.lang.String date, java.lang.String memID)
          Check if the date is holiday.
 boolean isLockedTask(java.lang.String tskID)
          Check the task locking state.
 boolean isLogined(java.lang.String loginID)
          Check specified user is logined or not.
 boolean isMemberAllowReadCensus(java.lang.String memId, java.lang.String qneId)
          The implement method should test the given member has the authorization to read or view the specified questionniare census.
 boolean isQuestionnaireAdmin(java.lang.String memId)
          The implement method should test the given member is a manager in Questionnaire module.
 boolean isRegAdmin(java.lang.String mbrId)
           
 boolean isRegisterActivity(com.flowring.onlineregister.entity.Activity act, java.lang.String mbrId)
           
 boolean isRestSat(java.lang.String date)
          Check specified date whether it's a rest Saturday or not.
 boolean isServerConnecting()
          Check if wfci is connecting with the server.
 boolean isServiceAlive()
          check the services in wfci are are available, if you clear the cache of AEPP, the new wfci will be constructed, and old one will be invalid, so the services are unavailable.
 boolean isSupervisor(java.lang.String memID)
          To check the member is Supervisor or not.
 boolean isUnitExistUserWorkingDay(java.lang.String id, java.lang.String calendarID)
          check the unit has been set calendar or not
 boolean isVotAdmin(java.lang.String memId)
           
 boolean isWorkday(java.lang.String date, java.lang.String memID)
          Check if the date is workday in user's calendar.
 java.util.Vector loadValueWithAFDBConnection(java.lang.String session, java.lang.String sqlcmd)
          Invoke the connection to load value.
 void lockTask(java.lang.String tskID)
          Lock the root task of the task.
 java.util.HashMap login(java.lang.String user, java.lang.String pass)
          User login the PASE server.
 java.util.Map login(java.lang.String loginID, java.lang.String pass, boolean toCheckDup)
          To authenticate users (it doesn't register).
 void logout(java.lang.String loginID)
          User logout the PASE server.
 boolean mustReassignDeputiedTask(java.lang.String memID)
           
 com.flowring.onlineregister.entity.Activity newActivity()
           
 boolean newBBSBoard(BBSBoard bbsBoard)
          New a bbs board in db with a new board object.
 com.flowring.dashboard.Dashboard newDashboard()
          Create a new Dashboard with a new system id which get from System.
 com.flowring.dashboard.DashboardStyle newDashboardStyle(java.lang.String boardId)
          Create a new DashboardStyle with a new system id which get from System.
 com.flowring.questionnaire.entity.Option newOption()
          The implement method must provide a new Option object.
 com.flowring.questionnaire.entity.Option newOptionTemplate()
          The implement method should create a Option Template.
 com.flowring.questionnaire.entity.Question newQuestion()
          The implement method must provide a new Question object.
 com.flowring.questionnaire.entity.Questionnaire newQuestionnaire()
          The implement method must provide a new Questionnaire object.
 com.flowring.questionnaire.entity.QuestionnaireResult newQuestionnaireResult()
          The implement method must provide a new QuestionnaireResult object.
 com.flowring.onlinevote.entity.Vote newVote()
           
 com.flowring.onlinevote.entity.VoteOpt newVoteOpt()
           
 java.util.HashMap notifyTask(java.lang.String tskID)
          Remove be state of waiting of the task.
 boolean pickQueueTask(Task t)
          Pick the queue of the task.
 boolean postBBSMsg(BBSMessage msg)
          Post a bbs message in db with a new message object.
 void reassignDeputyTask(java.lang.String loginID)
           
 boolean reflushProcessManager()
           
 boolean registerActivity(com.flowring.onlineregister.entity.Activity act, java.lang.String mbrId)
           
 boolean registerClient(java.lang.String loginID)
          Register a Client.
 void registerClient(java.lang.String loginID, ClientRMI client)
          Register user's client in the PASE server.
 void removeScheduleEvent(java.lang.String id)
          remove ScheduleEvent by event id.
 boolean removeTaskByAdm(java.lang.String p_TaskID)
          Force to remove task.
 boolean removeTaskByUser(java.lang.String p_RootTaskID, java.lang.String p_MemID)
          Force to remove task by the specific member.
 void reScheduleTask(Task task)
           
 boolean resetDeputyAndDeputyState(java.lang.String p_MyMemID, java.lang.String p_DeputyMemID, boolean p_DeputyState)
          Refresh deputy data in cache.
 boolean resetMemberDelegation(MemberRecord mRecord)
           
 void rollbackAFDBConnection(java.lang.String session)
          Make rollback in the connection.
 void saveSchedule(java.util.Vector hdays, java.util.Vector h_days, java.util.Vector wdays, int[] w)
          Save server's schedule.
 java.util.Vector searchData(SearchCondition cond)
          Gets searched result by using given conditions.
 int searchDataCount(SearchCondition cond)
          Gets searched number by using given conditions.
 java.util.Vector searchScheduleEvent(ScheduleSearchCondition cond)
          search ScheduleEvent by condition search.
 void sendHTMLMail(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String text)
           
 void sendHTMLMail(java.lang.String from, java.lang.String to, java.lang.String cc, java.lang.String subject, java.lang.String text)
           
 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)
           
 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.
 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)
           
 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)
           
 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)
           
 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)
           
 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 sendShortMessageToAdminAll(java.lang.String msg, java.lang.String fromMemID)
          Sends a message from a specific member to all on-line members on Admin.
 void sendShortMessageToAdminUser(java.lang.String msg, java.lang.String fromMemID, java.lang.String toMemID)
          Send a message from a specific member to another specific member on Admin.
 void sendShortMessageToAll(java.lang.String msg, java.lang.String fromMemID)
          Send a message from a specific member to all on-line members on Agenda.
 void sendShortMessageToUser(java.lang.String msg, java.lang.String fromMemID, java.lang.String toMemID)
          Send a message from a specific member to another specific member on Agenda.
 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.
 void setAFConnection(AFConnection afConn)
          Sets AFConnection, store the connection between wfci and server.
 boolean setArtInsState(PASEartInstance artInstance, java.lang.String stateID)
          Returns true for success, else false.
 boolean setCompanyAnnouncementBoard(java.util.Map companyAnnouncementBoardMap)
          set the map of every company's announce board
 void setGlobals(java.lang.String rootTaskID, java.util.HashMap args)
          Keep data into database and then reuse.
 boolean setMemberAccess(java.lang.String mID, AccessMember access)
          Sets the access config of Agenda for the specific member.
 boolean setMemberAdminAccess(java.lang.String mID, AccessAdmin access)
          Sets the access config of Admin for the specific member.
 boolean setMemberArtifactAccess(java.lang.String mID, java.util.Vector artifactAccessList)
          Sets the access config list of Agenda's function "artifact search" for the specific member.
 boolean setMemberOnLineAccess(java.lang.String mID, AccessOnLineUser access)
          Sets the access config of Agenda's function "on-line user" for the specific member.
 boolean setMemberTaskAccess(java.lang.String mID, java.util.Vector taskAccessList)
          Sets the access config list of Agenda's function "task search" for the specific member.
 boolean setMonitorRelation(java.lang.String sourceTaskID, java.lang.String createdRootTaskID)
           
 boolean setMonitorRelation(java.lang.String sourceTaskID, java.util.Vector createdRootTaskIDs)
           
 void setPersonalConfig(PersonalConfig config)
           
 boolean shutdownServer()
          Stop server.
 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.Vector 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).
 boolean startServer()
          Start server.
 java.util.HashMap startTask(Task t)
          Start the task.
 void stopRootTask(java.lang.String rootTaskID)
          Stop the root task.
 boolean suspendBBSBoard(java.lang.String bbsBoardID)
          Suspends a bbs board in db with a board ID.
 java.util.HashMap suspendTask(Task t)
          Suspend the task.
 boolean swapAeppServer(com.flowring.aeppServer.AeppServer aeppServer1, com.flowring.aeppServer.AeppServer aeppServer2)
          Exchange the order between one AEPP Server and another one.
 boolean swapPersonalFavoriteOrder(java.lang.String memId, java.lang.String id1, java.lang.String id2)
           
 boolean swapProcessMapCategory(Category category1, Category category2)
          Exchange the order between one ProcessMap Category and another one.
 boolean swapProcessMapLink(Link link1, Link link2)
          Exchange the order between one ProcessMap Link and another one.
 boolean testAFDBConnection(int seq)
          Test an AFDBConnection object with database configuration, by the specific sequence.
 boolean testAFDBConnection(java.lang.String name)
          Test an AFDBConnection object with database configuration, by the specific name.
 void unlockTask(java.lang.String tskID)
          UnLock the root task of the task.
 boolean unRegisterActivity(com.flowring.onlineregister.entity.Activity act, java.lang.String mbrId)
           
 boolean updateActivity(com.flowring.onlineregister.entity.Activity act)
           
 boolean updateAeppServerOfMultiOrg(com.flowring.aeppServer.AeppServer aeppServer)
          Update all properties of AEPP Server in database.
 boolean updateArtInstance(PASEartInstance instance)
          Update artifact instance Notice: Artifact instance is carrying artifact state information.
 boolean updateArtInstance(java.lang.String tID, PASEartInstance instance)
          Update artifact instance.
 boolean updateArtInstanceLog(java.lang.String tID, PASEartInstance instance)
          Update artifact instance log.
 boolean updateBBSBoard(BBSBoard bbsBoard)
          Updates a bbs board in db with a board object.
 boolean updateBBSMessage(BBSMessage msg)
           
 boolean updateDashboard(com.flowring.dashboard.Dashboard dboard)
           Updates a Dashboard only.
 boolean updateDashboardStyle(com.flowring.dashboard.DashboardStyle dstyle)
          Updates a DashboardStyle from table.
 boolean updateMbrSignGroup(java.lang.String mbrId, AFGroup group)
           
 boolean updateMemberRecord(MemberRecord mbr)
          Update the MemberRecord in database.
 boolean updateMultiServerACL(com.flowring.aeppServer.MultiServerACL multiServerACL)
          Update the access control properties of the multi server.
 void updatePASEGroup(PASEGroup group)
           
 void updatePASESharedFile(PASESharedFile sFile)
           
 boolean updatePersonalProShow(java.lang.String memberId, java.lang.String showType, java.lang.String variety)
           
 boolean updateProcessMapCategory(Category category)
          Update the Category bean of ProcessMap in database.
 boolean updateQuestionnaire(com.flowring.questionnaire.entity.Questionnaire q)
          The implement method should update datas from database by the given questionnaire object.
 void updateScheduleEvent(ScheduleEvent evt)
          Update ScheduleEvent.
 boolean updateTask(Task t)
          Updates the data object of task.
 boolean updateTaskState(Task t)
          Update the task state.
 boolean updateUnitType(UnitType unit)
          Update the specified unit type
 boolean updateValueWithAFDBConnection(java.lang.String session, java.lang.String sqlcmd)
          Invoke the connection to update value.
 boolean updateVote(com.flowring.onlinevote.entity.Vote vote)
           
 boolean updateVoteOpt(com.flowring.onlinevote.entity.VoteOpt voteOpt)
           
 java.util.HashMap userVerify(java.lang.String loginID, java.lang.String pass, boolean autoLogin)
           
 void waitTask(java.lang.String tskID)
          Sets the task to be state of waiting.
 void waitTask(java.lang.String tskID, java.lang.String timeString)
          Sets the task to be state of waiting, and the waiting duration.
 

Method Detail

activeBBSBoard

boolean activeBBSBoard(java.lang.String bbsBoardID)
                       throws WFCIException
Active a bbs board in db with a board ID.

Parameters:
bbsBoardID - a BBSBoardID.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

addAFDBConnectionURL

void addAFDBConnectionURL(int seq,
                          int type,
                          java.lang.String dburl,
                          java.lang.String username,
                          java.lang.String password)
                          throws WFCIException
Sets 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. The database type:

Examples: 

 WFCI.addAFDBConnectionURL(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.
Throws:
WFCIException

addAFDBConnectionURL

void addAFDBConnectionURL(int seq,
                          int type,
                          java.lang.String name,
                          java.lang.String dburl,
                          java.lang.String username,
                          java.lang.String password)
                          throws WFCIException
Sets a db URL to db configuration. It would replace another configuration by given the sequence number. The database type:

Examples: 

 WFCI.addAFDBConnectionURL(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.
Throws:
WFCIException

addDebugLog

void addDebugLog(java.lang.String msg)
                 throws WFCIException
Throws:
WFCIException

addErrLog

void addErrLog(java.lang.String msg)
               throws WFCIException
Parameters:
msg -
Throws:
WFCIException

addExeLog

void addExeLog(java.lang.String msg)
               throws WFCIException
Parameters:
msg -
Throws:
WFCIException

addFreqApRole

boolean addFreqApRole(java.lang.String freID,
                      java.lang.String rolID)
                      throws WFCIException
Throws:
WFCIException

addInfoLog

void addInfoLog(java.lang.String msg)
                throws WFCIException
Parameters:
msg -
Throws:
WFCIException

addMonitorRelation

boolean addMonitorRelation(java.lang.String sourceTaskID,
                           java.lang.String createdRootTaskID)
                           throws WFCIException
Parameters:
sourceTaskID -
createdRootTaskID -
Returns:
Throws:
WFCIException

addMonitorRelation

boolean addMonitorRelation(java.lang.String sourceTaskID,
                           java.util.Vector createdRootTaskIDs)
                           throws WFCIException
Parameters:
sourceTaskID -
createdRootTaskIDs -
Returns:
Throws:
WFCIException

addNewAFDBConnectionURL

int addNewAFDBConnectionURL(int type,
                            java.lang.String name,
                            java.lang.String dburl,
                            java.lang.String username,
                            java.lang.String password)
                            throws WFCIException
Add a new db URL at the end of the db configuration list. The database type:

Examples: 

 WFCI.addNewAFDBConnectionURL(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.
Throws:
WFCIException

addWarningLog

void addWarningLog(java.lang.String msg)
                   throws WFCIException
Parameters:
msg -
Throws:
WFCIException

ArtSQLloadValue

java.util.Vector ArtSQLloadValue(java.lang.String sql)
                                 throws WFCIException
The method is used to load value from database by nickname (the RTRepository).

Parameters:
sql - the input SQL data string in nickname.
Returns:
the value mapping to the SQL syntax.
Throws:
WFCIException
Since:
version 1.1.5

batchProcess

java.util.Vector batchProcess(java.util.Vector completeTask,
                              java.util.Vector removeRootTask,
                              java.util.Vector createPro)
                              throws WFCIException
Batch create, remove and complete process.

Examples: 

 // CompleteTask
 var completeVector = new java.util.Vector();
 var stateID = "AST0371992486182500";
 var taskID = "Tsk000000226232";
 var tsk = WFCI.getTask(taskID);
 var artInstance = tsk.getArtInstance();
 var Result = WFCI.setArtInsState(artInstance, stateID);
 completeVector.add(tsk);
 java.lang.System.out.println("Complete");

 // RemoveRootTask
 var removeVector = new java.util.Vector();
 removeVector.add("Tsk000000835835");
 java.lang.System.out.println("Remove");

 // CreateProcess
 var createVector = new java.util.Vector();
 var cv = new java.util.Vector();
 var userID = "jdwa";
 var proID = "PRO0570993694941810";
 var hm = new java.util.HashMap();
 var popUp = new java.lang.Boolean("true");
 cv.add(userID);
 cv.add(proID);
 cv.add(hm);
 cv.add(popUp);
 createVector.add(cv);
 java.lang.System.out.println("Create");

 // Call bachProcess
 var ret = WFCI.batchProcess(completeVector, removeVector, createVector);
 java.lang.System.out.println(ret);

Parameters:
completeTask - the Vector of task object.
removeRootTask - the Vector of Root Task ID.
createPro - Vector of createprocess parameters.
Throws:
WFCIException
Since:
version 1.1.6

bypassTask

boolean bypassTask(Task p_Task,
                   java.lang.String p_AstID)
                   throws WFCIException
Bypass the task.

Examples: 

 var taskID = "Tsk000000226229";

 var task = WFCI.getTask(taskID);

 var astID = "AST0000000334532";

 var ret = WFCI.bypassTask(task, astID);

Parameters:
p_Task - a Task.
p_AstID - a PASEartStateID.
Throws:
WFCIException
Since:
version 1.0.1

canPrintPASESharedFile

boolean canPrintPASESharedFile(java.lang.String fId,
                               java.lang.String mId)
                               throws WFCIException
Parameters:
fId -
mId -
Returns:
Throws:
WFCIException

canReadPASESharedFile

boolean canReadPASESharedFile(java.lang.String fId,
                              java.lang.String mId)
                              throws WFCIException
Parameters:
fId -
mId -
Returns:
Throws:
WFCIException

canWritePASESharedFile

boolean canWritePASESharedFile(java.lang.String fId,
                               java.lang.String mId)
                               throws WFCIException
Parameters:
fId -
mId -
Returns:
Throws:
WFCIException

changePassword

boolean changePassword(java.lang.String loginID,
                       java.lang.String newPwd)
                       throws WFCIException
The method is used to change the password of some member without checking old password.

This is not supported in the AD/LDAP Authentication situation.

Parameters:
loginID - a LoginID
newPwd - new password
Returns:
true if succeeded
Throws:
WFCIException
Since:
version 1.0.0

changePassword

boolean changePassword(java.lang.String memID,
                       java.lang.String oldPwd,
                       java.lang.String newPwd)
                       throws WFCIException
The method is used to change the password of some member. The changing is performed only while the original password is correct.

This is not supported in the AD/LDAP Authentication situation.

Parameters:
memID - a memID
oldPwd - an original password
newPwd - a new password
Returns:
true if succeeded
Throws:
WFCIException
Since:
version 1.0.0

checkValidNameUser

boolean checkValidNameUser()
                           throws WFCIException
check if the license of Name User is bigger than the number in DB

Returns:
true if the license is bigger than the number in DB
Throws:
WFCIException

clearCache

void clearCache()
                throws WFCIException
Clear the cache of the PASE server.

Throws:
WFCIException

clearCache

void clearCache(java.lang.String type)
                throws WFCIException
Clear this type cache of the PASE server.

Parameters:
type: - "ALL", "ARTIFACT", "PROCESS", "ORG" or "TASK".
Throws:
WFCIException
Since:
V2.4

clearQuestionnaireViews

boolean clearQuestionnaireViews(java.lang.String qneId)
                                throws WFCIException
The implement method should clear views count when updated a specified questionnaire result.

Parameters:
qneId - a questionnaire id.
Returns:
true if clear success; false otherwise.
Throws:
WFCIException
Since:
version 3.0

closeAFDBConnection

void closeAFDBConnection(java.lang.String session)
                         throws WFCIException
Close a SessionConnection object.

Parameters:
session - the session connection key.
Throws:
WFCIException

commitAFDBConnection

void commitAFDBConnection(java.lang.String session)
                          throws WFCIException
Make commit in the session connection.

Parameters:
session - the session connection key.
Throws:
WFCIException

completeTask

java.util.HashMap completeTask(Task t)
                               throws WFCIException
Complete the task.

Examples: 

    var taskID = "Tsk000000226229";
    var task = WFCI.getTask(taskID);
    var hashmap = WFCI.completeTask(task);
    var retValue = hashmap.get("retValue");
        returns <dfn>true if it starts successfully;false otherwise</dfn>

Parameters:
t - a Task.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true)] ).
Throws:
WFCIException
Since:
version 1.0.1

completeTask

java.util.HashMap completeTask(Task t,
                               java.lang.String stateID)
                               throws WFCIException
Complete the task.

Examples: 

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

Parameters:
t - a Task.
stateID - a art exit state id.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true)] ).
Throws:
WFCIException
Since:
version 1.0.1

connectServer

int connectServer(java.lang.String host,
                  java.lang.String port)
Connect to the PASE server by the given host address and host port.

Parameters:
host - a host address.
port - a host port.
Returns:
0 if succeeded.
Since:
version 1.0.0

createAFDBConnection

AFDBConnection createAFDBConnection(int seq)
                                    throws WFCIException
Create an AFDBConnection object with database configuration, by the specific sequence.

Parameters:
seq - the sequence which the data is store in configuration, from 1.
Returns:
the AFDBConnection object which have connected to database.
Throws:
WFCIException
See Also:
AFDBConnection

createAFDBConnection

AFDBConnection createAFDBConnection(java.lang.String name)
                                    throws WFCIException
Create an AFDBConnection object with database configuration, by the specific name.

Parameters:
name - the name to recognize the db configuration.
Returns:
the AFDBConnection object which have connected to database.
Throws:
WFCIException
See Also:
AFDBConnection

createArtInstance

PASEartInstance createArtInstance(java.lang.String aID)
                                  throws WFCIException
Create artifact instance.

Examples: 

 var aID = "ART0099992486182440";

 var PASEartInstance = WFCI.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:
aID - an artifact id.
Returns:
the artifact instance.
Throws:
WFCIException
Since:
version 1.2
See Also:
PASEartInstance

createFreqArtInstance

PASEartInstance createFreqArtInstance(java.lang.String aID)
                                      throws WFCIException
Create artifact instance, for FreqAp use.

Parameters:
aID - a ArtifactID.
Returns:
the artifact instance.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
PASEartInstance

createPASEGroup

PASEGroup createPASEGroup()
                          throws WFCIException
Returns:
Throws:
WFCIException

createPASESharedFile

PASESharedFile createPASESharedFile()
                                    throws WFCIException
Returns:
Throws:
WFCIException

createProcess

java.lang.String createProcess(java.lang.String userID,
                               java.lang.String proID,
                               java.util.HashMap args,
                               boolean isPopUp)
                               throws WFCIException
Create a Process. Note:JSP WebForm does not implement this method.

Parameters:
userID - a UserID.
proID - a ProcessID.
args - a HashMap contains the relative data.
isPopUp, - useless now.
Returns:
the rootTask ID.
Throws:
WFCIException

createProcess

java.lang.String createProcess(java.lang.String userID,
                               java.lang.String proID,
                               java.util.HashMap args,
                               boolean isPopUp,
                               boolean isDelible)
                               throws WFCIException
Create a Process. Note:JSP WebForm does not implement this method.

Parameters:
userID - a UserID.
proID - a ProcessID.
args - a HashMap contains the relative data.
isPopUp - useless now.
isDelible - if the root task is delible.
Returns:
the rootTask ID.
Throws:
WFCIException

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)
                               throws WFCIException
Create a Process. Note:JSP WebForm does not implement this method.

Parameters:
userID - a UserID.
roleID - a RoleID.
proID - a ProcessID.
args - a HashMap contains the relative data.
isPopUp - useless now.
isDelible - if the root task is delible.
taskID - the specified task id which execute this API.
dtTemplateID - the specified DataTransferTemplate id.
isShowMonitorRelation - if the specified task will show monitor relation in monitor.
Returns:
the rootTask ID.
Throws:
WFCIException

createScheduleEvent

ScheduleEvent createScheduleEvent()
                                  throws WFCIException
Creates new ScheduleEvent. 
  Examples: create a new event, and put it to schedule.

    Calendar startTime = Calendar.getInstance();
    Calendar endTime = Calendar.getInstance();
    endTime.add(Calendar.HOUR_OF_DAY, 1);
    ScheduleEvent evt = wfci.createScheduleEvent();
    evt.setDescription("AAAA");
    evt.setEventName("NNNN");
    evt.setStartTime(startTime.getTime().getTime());
    evt.setEndTime(endTime.getTime().getTime());
    wfci.insertScheduleEvent(evt);

Returns:
new ScheduleEvent.
Throws:
WFCIException

delBBSMsg

boolean delBBSMsg(java.lang.String bbsBoardID,
                  java.lang.String msgID)
                  throws WFCIException
Delete a bbs message in db with a borad ID and a message ID.

Parameters:
bbsBoardID - a BBSBoardID.
msgID - a BBSMessageID.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

deleteActivity

boolean deleteActivity(com.flowring.onlineregister.entity.Activity act)
                       throws WFCIException
Parameters:
act -
Returns:
Throws:
WFCIException

deleteActivityPerm

boolean deleteActivityPerm(java.lang.String aId,
                           java.lang.String memId)
                           throws WFCIException
Parameters:
aId -
memId -
Returns:
Throws:
WFCIException

deleteAeppServerOfMultiOrg

boolean deleteAeppServerOfMultiOrg(java.lang.String ID)
                                   throws WFCIException
Delete a AEPP Server with specified AEPP Server ID.

Parameters:
AEPP - Server ID.
Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

deleteAFDBConnectionURL

java.util.HashMap deleteAFDBConnectionURL(java.lang.String name)
                                          throws WFCIException
Delete a db URL from db configuration. It may influence other configuration's sequence number.

Parameters:
name - the name to recognize the db configuration.
Returns:
the HashMap object which shows the cleared configuration.
Throws:
WFCIException

deleteBBSBoard

boolean deleteBBSBoard(java.lang.String bbsBoardID)
                       throws WFCIException
Deletes a bbs board in db with a board ID.

Parameters:
bbsBoardID - a BBSBoardID.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

deleteBoardAdmin

boolean deleteBoardAdmin(java.lang.String memId)
                         throws WFCIException
Throws:
WFCIException

deleteBoardPerm

boolean deleteBoardPerm(java.lang.String messageId,
                        java.lang.String memId)
                        throws WFCIException
Throws:
WFCIException

deleteDashboard

boolean deleteDashboard(java.lang.String boardId)
                        throws WFCIException

Deletes a Dashboard and its style list.

NOTE: It will delete its style list.

Parameters:
boardId - a dashboard id.
Returns:
true if delete success; false otherwise.
Throws:
WFCIException

deleteDashboardStyle

boolean deleteDashboardStyle(java.lang.String styleId)
                             throws WFCIException
Deletes a DashboardStyle from table.

Parameters:
styleId - a DashboardStyle id.
Returns:
true if delete success; false otherwise.
Throws:
WFCIException

deleteGlobals

boolean deleteGlobals(java.lang.String rootTaskID)
                      throws WFCIException
Delete Globals data from database.

Examples: 

    var rootTaskID = "Tsk0003459343453";
    var Result = WFCI.deleteGlobals(rootTaskID);
        returns <dfn>true if it deletes successfully; false otherwise</dfn>

Parameters:
rootTaskID - a root TaskID.
Returns:
true if it deletes successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5

deleteMailLoginTimeStamp

boolean deleteMailLoginTimeStamp(java.lang.String mailId)
To delete the data from database by the mail id .

Parameters:
mailId -
Returns:
boolean

deleteMailLoginTimeStampByTaskId

boolean deleteMailLoginTimeStampByTaskId(java.lang.String taskId)
To delete the data from database by the task id .

Parameters:
taskId -
Returns:
boolean

deleteMbrSignGroup

boolean deleteMbrSignGroup(java.lang.String mbrId,
                           AFGroup group)
                           throws WFCIException
Parameters:
mbrId -
group -
Returns:
Throws:
WFCIException

deleteMultiOrgPerm

boolean deleteMultiOrgPerm(java.lang.String memId)
                           throws WFCIException
Delete the user's multiorg permission with specified member ID.

Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

deleteOption

boolean deleteOption(com.flowring.questionnaire.entity.Option opt)
                     throws WFCIException
The implement method should remove a option datas from database by the given option object.

Parameters:
opt - a Option object.
Returns:
true if delete success; false otherwise.
Throws:
WFCIException

deleteOption

boolean deleteOption(java.lang.String optId)
                     throws WFCIException
The implement method should remove a option datas from database by the given option id.

Parameters:
optId - a option id.
Returns:
true if delete success; false otherwise.
Throws:
WFCIException

deletePASEGroup

void deletePASEGroup(java.lang.String id)
                     throws WFCIException
Parameters:
id -
Throws:
WFCIException

deletePASEMessage

boolean deletePASEMessage(PASEMessage msg)
                          throws WFCIException
Delete message from database.

Examples: 

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

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

deletePASEMessageByID

boolean deletePASEMessageByID(java.lang.String msgID)
                              throws WFCIException
Delete message from database with message ID.

Examples: 

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

Parameters:
msgID - a messageID.
Returns:
true if the delete is successful; false otherwise.
Throws:
WFCIException
Since:
version 1.0.0

deletePASESharedFile

void deletePASESharedFile(java.lang.String fId)
                          throws WFCIException
Parameters:
fId -
Throws:
WFCIException

deletePersonalDboard

boolean deletePersonalDboard(java.lang.String dboardId,
                             PersonalConfig pConfig)
                             throws WFCIException
Throws:
WFCIException

deletePersonalFavorite

boolean deletePersonalFavorite(java.util.Vector vec,
                               PersonalConfig pConfig)
                               throws WFCIException
Throws:
WFCIException

deleteProcessMapCategory

boolean deleteProcessMapCategory(java.lang.String id)
                                 throws WFCIException
Delete a ProcessMap Categoty with specified ID.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

deleteProcessMapLink

boolean deleteProcessMapLink(Link link)
                             throws WFCIException
Delete one ProcessMap Link with specified ID and parent ID of the Link bean.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

deleteQuestionnaire

boolean deleteQuestionnaire(com.flowring.questionnaire.entity.Questionnaire q)
                            throws WFCIException
The implement method should remove a questionnaire and its related datas from database by the given questionnaire object.

Parameters:
qne - a Questionnaire object.
Returns:
true if remove success; false otherwise.
Throws:
WFCIException

deleteQuestionnaire

boolean deleteQuestionnaire(java.lang.String qId)
The implement method should remove a questionnaire and its related datas from database by the questionnaire id.

Parameters:
qneId - a questionnaire id.
Returns:
true if remove success; false otherwise.
Throws:
WFCIException
Since:
Agentflow 3.0

deleteQuestionnaireAdmin

boolean deleteQuestionnaireAdmin(java.lang.String memId)
                                 throws WFCIException
The implement method should remove a manager from questionnaire manager list by the given member id.

Parameters:
memId - a member id who is a manager of questionnaire module.
Returns:
true if delete success; false otherwise.
Throws:
WFCIException

deleteQuestionnairePerm

boolean deleteQuestionnairePerm(java.lang.String qneId,
                                java.lang.String memId)
                                throws WFCIException
The implement method should remove a questionnaire permission from database by the given parameters.

Parameters:
qneId - a questionnaire id.
memId - a member id.
Returns:
true if delete success; false otherwise.
Throws:
WFCIException

deleteRegAdmin

boolean deleteRegAdmin(java.lang.String mbrId)
                       throws WFCIException
Parameters:
mbrId -
Returns:
Throws:
WFCIException

deleteTaskAttachedFile

boolean deleteTaskAttachedFile(java.lang.String fileID)
                               throws WFCIException
Parameters:
fileID -
Returns:
Throws:
WFCIException

deleteUserCalendar

void deleteUserCalendar(java.lang.String calendarID)
                        throws WFCIException
delete user calendar with specified calendar id

Parameters:
calendarID -
Throws:
WFCIException
Since:
V3.1

deleteVotAdmin

boolean deleteVotAdmin(java.lang.String memId)
                       throws WFCIException
Parameters:
memId -
Returns:
Throws:
WFCIException

deleteVote

boolean deleteVote(com.flowring.onlinevote.entity.Vote vote)
                   throws WFCIException
Parameters:
vote -
Returns:
Throws:
WFCIException

deleteVoteOpt

boolean deleteVoteOpt(com.flowring.onlinevote.entity.VoteOpt voteOpt)
                      throws WFCIException
Throws:
WFCIException

deleteVotPerm

boolean deleteVotPerm(java.lang.String votId,
                      java.lang.String memId)
                      throws WFCIException
Parameters:
votId -
memId -
Returns:
Throws:
WFCIException

disconnectServer

int disconnectServer()
Disconnect to the PASE server.

Returns:
0 if succeeded.
Since:
version 1.0.0

doVote

boolean doVote(java.util.List ticketList)
               throws WFCIException
Parameters:
ticketList -
Returns:
Throws:
WFCIException

forceReassignTask

boolean forceReassignTask(java.lang.String p_TaskID,
                          java.lang.String p_MemID)
                          throws WFCIException
Force to reassign the task.

Examples: 

    var taskID = "Tsk000000226229";
    var memID = "MEM0000000334532";
    var Result = WFCI.forceReassignTask(p_TaskID, p_MemID);
        returns <dfn>true if it sets successfully; false otherwise</dfn>

Parameters:
p_TaskID - a TaskID.
p_MemID - a MemberRecordID.
Returns:
true if succeeded.
Throws:
WFCIException
Since:
version 1.0.1

forceReassignTask

boolean forceReassignTask(Task p_Task,
                          MemberRecord p_MR)
                          throws WFCIException
Force to reassign the task.

Examples: 

    var taskID = "Tsk000000226229";
    var task = WFCI.getTask(taskID);
    var memID = "MEM0000000334532";
    var member = WFCI.getMember(memID);
    var Result = WFCI.forceReassignTask(task, member);
        returns <dfn>true if it sets successfully; false otherwise</dfn>

Parameters:
p_Task - a Task.
p_MR - a MemberRecord.
Returns:
true if succeeded.
Throws:
WFCIException
Since:
version 1.0.1

genQuestionnaire

boolean genQuestionnaire(java.lang.String qneId)
                         throws WFCIException
The implement method should generate empty Questionnaires result when add a new questionnaire or update a questionnaire.

Parameters:
qneId - a questionnaire id.
Returns:
true if execute success; false otherwise.
Throws:
WFCIException
Since:
version 3.0

genTicket

boolean genTicket(java.lang.String votId,
                  java.util.List memIdList)
                  throws WFCIException
²£¥Í¿ï²¼

Parameters:
votId -
memIdList -
reserve -
Returns:
Throws:
WFCIException

getActivity

com.flowring.onlineregister.entity.Activity getActivity(java.lang.String actId)
                                                        throws WFCIException
Throws:
WFCIException

getActivityList

java.util.Vector getActivityList()
                                 throws WFCIException
Returns:
Throws:
WFCIException

getActivityList

java.util.Vector getActivityList(java.lang.String memId)
                                 throws WFCIException
Parameters:
memId -
Returns:
Throws:
WFCIException

getActivityListByMbrId

java.util.Vector getActivityListByMbrId(java.lang.String id)
                                        throws WFCIException
Parameters:
id -
Returns:
Throws:
WFCIException

getActivityListByMbrIdAndActDate

java.util.Vector getActivityListByMbrIdAndActDate(java.lang.String id)
                                                  throws WFCIException
Parameters:
id -
Returns:
Throws:
WFCIException

getActivityListByRegDate

java.util.Vector getActivityListByRegDate()
                                          throws WFCIException
Throws:
WFCIException

getActivityListByVersionId

java.util.Vector getActivityListByVersionId(java.lang.String versionId)
                                            throws WFCIException
Parameters:
versionId -
Returns:
Throws:
WFCIException

getActivityPermList

java.util.Vector getActivityPermList(java.lang.String aId)
                                     throws WFCIException
Throws:
WFCIException

getAddSignTaskList

java.util.Vector getAddSignTaskList(java.lang.String signTaskId)
                                    throws WFCIException
Parameters:
signTaskId -
Returns:
Throws:
WFCIException

getAeppServerListOfMultiOrg

java.util.List getAeppServerListOfMultiOrg()
                                           throws WFCIException
Get all AEPP Server in database.

Returns:
all AeppServer bean object.(each element in Vector are instance of AeppServer).
Throws:
WFCIException
Since:
V3.0

getAeppServerOfMultiOrg

com.flowring.aeppServer.AeppServer getAeppServerOfMultiOrg(java.lang.String ID)
                                                           throws WFCIException
Get the AeppServer bean with specified AEPP Server ID.

Parameters:
AEPP - Server ID.
Returns:
AeppServer bean object.
Throws:
WFCIException
Since:
V3.0

getAFConnection

AFConnection getAFConnection()
Gets AFConnection, retrieve the connection between wfci and server.

getAFDBConnectionURL

java.util.HashMap getAFDBConnectionURL(int seq)
                                       throws WFCIException
Gets a db configuration by given sequence number.

Parameters:
seq - the sequence which the data is store in configuration, from 1.
Returns:
the HashMap shows the SessionConnection configuration.
Throws:
WFCIException

getAFDBConnectionURL

java.util.HashMap getAFDBConnectionURL(java.lang.String name)
                                       throws WFCIException
Gets a db configuration by given name.

Parameters:
name - the name to recognize the db configuration.
Returns:
the HashMap shows the SessionConnection configuration.
Throws:
WFCIException

getAFDBConnectionURLList

java.util.Vector getAFDBConnectionURLList()
                                          throws WFCIException
Gets all db configurations.

Returns:
all SessionConnection configurations(each element in Vector are instance of HashMap).
Throws:
WFCIException

getAFTask

AFTask getAFTask(java.lang.String tID)
                 throws WFCIException
Returns a data object of AFTask.

Examples: 

    var taskID = "Tsk000000226229";
    var Task = WFCI.getAFTask(taskID);
        returns <dfn>an AFTask Object</dfn>

Parameters:
tID - a TaskID.
Returns:
the AFTask.
Throws:
WFCIException
Since:
version 1.1.6

getAllAddASResult

java.util.Collection getAllAddASResult(java.lang.String taskID)
                                       throws WFCIException
Returns all add AS result that were written before the given task.

Parameters:
taskID - a task id.
Returns:
the AddCSResultData objects collection.
Throws:
java.lang.Exception
WFCIException

getAllBBSBoard

java.util.Vector getAllBBSBoard()
                                throws WFCIException
Gets all bbs boards, including active and suspended.

Returns:
the BBS board list(each element in Vector are instance of BBSBoard).
Throws:
WFCIException

getAllBBSBoardByComID

java.util.Vector getAllBBSBoardByComID(java.lang.String comID)
Gets all bbs boards(include the announcement board) by company id.

Parameters:
company - id
Returns:
the BBS board list(each element in Vector are instance of BBSBoard).

getAllComIDOfMember

java.util.Vector getAllComIDOfMember(java.lang.String memID)
                                     throws WFCIException
Throws:
WFCIException

getAllCSTaskNote

java.util.Collection getAllCSTaskNote(java.lang.String taskID)
                                      throws WFCIException
Returns all CS Tasks' note that were written before the given task.

Parameters:
taskID - a task id.
Returns:
the CSResultData objects collection.
Throws:
WFCIException

getAllDepartmentByName

java.util.Vector getAllDepartmentByName(java.lang.String mName)
                                        throws WFCIException
Gets all departments by the same name.

Parameters:
mName - a department name.
Returns:
all departments (each element in Vector are instance of Department).
Throws:
WFCIException
Since:
version 1.2
See Also:
Department

getAllDepIDOfCompany

java.util.Vector getAllDepIDOfCompany()
                                      throws WFCIException
Gets all departments' id in the company.

Returns:
all departments' id (each element in Vector are department id).
Throws:
WFCIException
Since:
version 1.2
See Also:
Department

getAllDepIDOfMember

java.util.Vector getAllDepIDOfMember(java.lang.String memID)
                                     throws WFCIException
Throws:
WFCIException

getAllDepNameOfCompany

java.util.Vector getAllDepNameOfCompany()
                                        throws WFCIException
Gets all departments' name in the company.

Returns:
all departments' name (each element in Vector are department name).
Throws:
WFCIException
Since:
version 1.2
See Also:
Department.

getAllIapSignResult

java.util.Collection getAllIapSignResult(java.lang.String taskID)
                                         throws WFCIException
Returns all add AS result that were written before the given task.

Parameters:
taskID - a task id.
Returns:
the IapSignResultData objects collection.
Throws:
java.lang.Exception
WFCIException

getAllManager

java.util.List getAllManager(MemberRecord mbr,
                             boolean mainRoleOnly)
                             throws WFCIException
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)
Throws:
WFCIException
Since:
version 2.2.5

getAllManagerByID

java.util.List getAllManagerByID(java.lang.String memId)
                                 throws WFCIException
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)
Throws:
WFCIException
Since:
version 2.2.5

getAllManagerByLoginID

java.util.List getAllManagerByLoginID(java.lang.String loginId)
                                      throws WFCIException
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)
Throws:
WFCIException
Since:
version 2.2.5

getAllManagerByNo

java.util.List getAllManagerByNo(java.lang.String memNo)
                                 throws WFCIException
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)
Throws:
WFCIException
Since:
version 2.2.5

getAllMember

java.util.Vector getAllMember()
                              throws WFCIException
Returns all member of system.

Throws:
WFCIException
Since:
version 1.0.0
See Also:
MemberRecord

getAllMemberByCName

java.util.Vector getAllMemberByCName(java.lang.String mName)
                                     throws WFCIException
Gets all members by the same name.

Parameters:
mName - a member name.
Returns:
all member records (each element in Vector are instance of MemberRecord).
Throws:
WFCIException
Since:
version 1.2
See Also:
MemberRecord

getAllMessageOfMem

java.util.Vector getAllMessageOfMem(java.lang.String boardID,
                                    java.lang.String memID)
                                    throws WFCIException
Throws:
WFCIException

getAllPASEGroupByName

java.util.List getAllPASEGroupByName(java.lang.String name)
                                     throws WFCIException
Parameters:
name -
Returns:
Throws:
WFCIException

getAllProjectRoleByName

java.util.Vector getAllProjectRoleByName(java.lang.String mName)
                                         throws WFCIException
Parameters:
mName -
Returns:
Throws:
WFCIException

getAllRoleByName

java.util.Vector getAllRoleByName(java.lang.String mName)
                                  throws WFCIException
Gets all roles by the same name.

Parameters:
mName - a role name.
Returns:
all roless (each element in Vector are instance of Role).
Throws:
WFCIException
Since:
version 1.2
See Also:
Role

getAllRoleIDOfCompany

java.util.Vector getAllRoleIDOfCompany()
                                       throws WFCIException
Gets all role id in the company.

Returns:
all role id (each element in Vector are role id).
Throws:
WFCIException
Since:
version 1.2
See Also:
Role

getAllRoleNameOfCompany

java.util.Vector getAllRoleNameOfCompany()
                                         throws WFCIException
Gets all role name in the company.

Returns:
all role name (each element in Vector are role name).
Throws:
WFCIException
Since:
version 1.2
See Also:
Role

getAllTimeZones

java.util.List getAllTimeZones()
                               throws WFCIException
get all timezones in database

Returns:
List timezonesList. Each element in the list is pe.pase.AFTimeZone.
Throws:
WFCIException
Since:
V3.1

getAllTskIDListByGPro

java.util.Vector getAllTskIDListByGPro(java.lang.String gProID,
                                       java.lang.String frontTaskID)
                                       throws WFCIException
Parameters:
gProID -
frontTaskID -
Returns:
Throws:
WFCIException

getAllUnitType

java.util.Vector getAllUnitType()
                                throws WFCIException
Get All Unit Types

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

getAllUnitType

java.util.Vector getAllUnitType(int levelNumber,
                                int relation,
                                java.lang.String orderBy)
                                throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5
See Also:
UnitType

getAllUserCalendar

java.util.List getAllUserCalendar()
                                  throws WFCIException
get all user calendar

Returns:
List
Throws:
WFCIException
Since:
V3.1

getAnnouncementCompanyName

java.lang.String getAnnouncementCompanyName(java.lang.String boardID)
                                            throws WFCIException
get the name of company by announcement board id

Parameters:
StringboardID -
Returns:
String companyName
Throws:
WFCIException
Since:
V3.1

getApprovalHistoryRootTaskOfJoinMember

AFTaskList getApprovalHistoryRootTaskOfJoinMember(java.lang.String mbrID)
                                                  throws WFCIException
Returns a Approval History Root Task List of the Member(mbrID).

Returns:
the correspondence Tasks(each element in Vector are instance of Task).
Throws:
WFCIException
Since:
version 1.1.5p2

getArtifact

Artifact getArtifact(java.lang.String aID)
                     throws WFCIException
Returns a data object of artifact.

Examples: 

    var aID = "ART0101993090926140";
    var Artifact = WFCI.getArtifact(aID);
        returns <dfn>a Artifact Object</dfn>

Parameters:
aID - a ArtifactID.
Returns:
the artifact.
Throws:
WFCIException
Since:
version 1.0.0

getArtifactForm

java.util.Vector getArtifactForm(java.lang.String aID)
                                 throws WFCIException
Returns artifact forms of some specific artifact.

Examples: 

    var aID = "ART0101993090926140";
    var ArtFormList = WFCI.getArtifactForm(aID);
    for (var i=0;i<ArtFormList.size();i++) {
        var ArtFormItem=ArtFormList.get(i);
            returns <dfn>a ArtFormItem Object</dfn>
    }

Parameters:
aID - a ArtifactID.
Returns:
the correspondence artifact forms(each element in Vector are instance of ArtFormItem).
Throws:
WFCIException
Since:
version 1.0.0
See Also:
ArtFormItem

getArtifactOfCompany

java.util.Vector getArtifactOfCompany()
                                      throws WFCIException
Returns all artifacts.

Examples: 

    var ArtifactList = WFCI.getArtifactOfCompany();
    if(ArtifactList != null) {
        for(var i=0;i<ArtifactList.size();i++){
            var Artifact =ArtifactList.get(i);
                returns <dfn>a Artifact Object</dfn>
        }
    }

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

getArtifactOfProject

java.util.Vector getArtifactOfProject(java.lang.String prjID)
                                      throws WFCIException
Returns all artifact of some specific project.

Examples: 

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

Parameters:
prjID - a ProjectID.
Returns:
the correspondence artifacts(each element in Vector are instance of Artifact).
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Artifact

getArtInstance

PASEartInstance getArtInstance(java.lang.String iID)
                               throws WFCIException
Returns a data object of artifact instance with current Task.

Examples: 

    var iID = "ART0099992486182440";
    var PASEartInstance = WFCI.getArtInstance(iID);
        returns <dfn>PASEartInstance Object</dfn>

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

    var ArtifactName = PASEartInstance.getName();
        returns <dfn>ArtifactName</dfn> is like "ApplyForm"

    var ArtifactID  = PASEartInstance.getArtifactID();
        returns <dfn>ArtifactID</dfn> is like "ART0099992486182440"

Parameters:
iID - an ArtifactInstanceID.
Returns:
the artifact instance.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
PASEartInstance

getArtInstance

PASEartInstance getArtInstance(java.lang.String iID,
                               java.lang.String tID)
                               throws WFCIException
Returns a data object of artifact instance with specific task.

Examples: 

    var iID = "ART0099992486182440";
    var tID = "Tsk0003459343453";
    var PASEartInstance = WFCI.getArtInstance(iID, tID);
        returns <dfn>PASEartInstance Object</dfn>

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

    var ArtifactName = PASEartInstance.getName();
        returns <dfn>ArtifactName</dfn> is like "ApplyForm"

    var ArtifactID  = PASEartInstance.getArtifactID();
        returns <dfn>ArtifactID</dfn> is like "ART0099992486182440"

Parameters:
iID - an ArtifactInstanceID.
tID - a TaskID.
Returns:
the artifact instance.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
PASEartInstance

getArtInstanceOfArtifact

java.util.Vector getArtInstanceOfArtifact(java.lang.String aID)
                                          throws WFCIException
Returns all artifact instances instanciated by some specific artifact.

Examples: 

    var aID = "ART0099992486182440";
    var PASEartInstanceList = WFCI.getArtInstanceOfArtifact(aID);
    if(PASEartInstanceList != null) {
        for(var i=0;i<PASEartInstanceList.size();i++){
            var PASEartInstance =PASEartInstanceList.get(i);
                     returns <dfn>a PASEartInstance Object</dfn>
            }
        }
    }

Parameters:
aID - an ArtifactID.
Returns:
the correspodence artifact instances(each element in Vector are instance of PASEartInstance).
Throws:
WFCIException
Since:
version 1.1.5
See Also:
PASEartInstance

getArtTskID

java.lang.String getArtTskID(java.lang.String iID)
                             throws WFCIException
Gets the latest associated TaskID with the Artifact Instance.

Parameters:
iID - a artifact instance id.
Returns:
the latest TaskID.
Throws:
WFCIException
Since:
version 1.2

getATaskNote

java.util.HashMap getATaskNote(java.lang.String tskID)
                               throws WFCIException
Throws:
WFCIException

getAuthLDAPConfigs

java.util.List<AuthLDAPConfig> getAuthLDAPConfigs()
                                                  throws WFCIException
Retrieve the ldap configs

Returns:
List each element is AuthLDAPConfig
Throws:
WFCIException
Since:
V3.1

getBBS

BBS getBBS()
Gets a BBS interface

Returns:
the BBS

getBBSBoard

java.util.Vector getBBSBoard()
                             throws WFCIException
Gets bbs boards, only active.

Returns:
the BBS board list(each element in Vector are instance of BBSBoard).
Throws:
WFCIException

getBBSBoard

BBSBoard getBBSBoard(java.lang.String bbsBoardID)
                     throws WFCIException
Gets the bbs board with the specific ID.

Parameters:
bbsBoardID - a BBSBoardID.
Returns:
the BBSBoard instance.
Throws:
WFCIException

getBBSBoardByRangeID

java.util.Vector getBBSBoardByRangeID(java.util.Vector rangeList)
                                      throws WFCIException
Gets bbs boards by member's role.

Parameters:
member's - rangeList (each element in Vector are instance of BBSBoardAccess)
Returns:
the BBS board list(each element in Vector are instance of BBSBoard).
Throws:
WFCIException

getBBSMsg

BBSMessage getBBSMsg(java.lang.String msgID)
                     throws WFCIException
Gets the bbs message with the specific ID.

Parameters:
msgID - a BBSMessageID.
Returns:
the BBSMessage instance.
Throws:
WFCIException

getBBSMsgList

java.util.Vector getBBSMsgList(java.lang.String bbsBoardID)
                               throws WFCIException
Gets all messages with a board ID.

Parameters:
bbsBoardID - a BBSBoardID.
Returns:
the BBS message list(each element in Vector are instance of BBSMessage).
Throws:
WFCIException

getBBSSearchResult

java.util.Vector getBBSSearchResult(java.lang.String bbsBoardID,
                                    java.lang.String keyword)
                                    throws WFCIException
Gets all messages with a keyword in some board.

Parameters:
bbsBoardID - a BBSBoardID.
keyword - a keyword.
Returns:
the BBS message list(each element in Vector are instance of BBSMessage).
Throws:
WFCIException

getBoardAdminList

java.util.Vector getBoardAdminList()
                                   throws WFCIException
Throws:
WFCIException

getBoardPermList

java.util.Vector getBoardPermList(java.lang.String messageId)
                                  throws WFCIException
Throws:
WFCIException

getCollectedTskIDListByGPro

java.util.Vector getCollectedTskIDListByGPro(java.lang.String gProID,
                                             java.lang.String frontTaskID)
                                             throws WFCIException
Parameters:
gProID -
frontTaskID -
Returns:
Throws:
WFCIException

getComIDListOfMember

java.util.Vector getComIDListOfMember(java.lang.String memID)
                                      throws WFCIException
Get the company id list of a member

Parameters:
memID -
Returns:
Vector company id list, each element in the Vector is String as a company id
Throws:
WFCIException
Since:
V3.1

getComIdOfDep

java.lang.String getComIdOfDep(java.lang.String depID)
                               throws WFCIException
Get the company id of a department

Parameters:
depID -
Returns:
String company id
Throws:
WFCIException
Since:
V3.1

getComIdOfRole

java.lang.String getComIdOfRole(java.lang.String rolID)
                                throws WFCIException
Get the company id of a role

Parameters:
rolID -
Returns:
String company id
Throws:
WFCIException
Since:
V3.1

getCompany

Company getCompany()
                   throws WFCIException
Returns a data object of company.

Examples: 

    var Company = WFCI.getCompany();
        returns <dfn>a Company Object</dfn>

Returns:
the company.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Company

getCompany

Company getCompany(java.lang.String comID)
                   throws WFCIException
Returns a data object of company by a specified company id.

Examples: 

    var Company = WFCI.getCompany();
        returns <dfn>a Company Object</dfn>

Returns:
the company.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Company

getCompanyAnnouncementBoard

java.util.Map getCompanyAnnouncementBoard()
                                          throws WFCIException
get the map of every company's announce board.

Returns:
Map companyAnnounceBoardMap[Key:String company id, Value:pe.pase.BBSBoard board]
Throws:
WFCIException
Since:
V3.1

getCPTaskIDList

java.util.Vector getCPTaskIDList(java.lang.String cProID,
                                 java.lang.String frontTaskID)
                                 throws WFCIException
Throws:
WFCIException

getCSTaskNote

java.util.HashMap getCSTaskNote(java.lang.String taskID)
                                throws WFCIException
Gets CSTask Notes that are written before the given task.

Parameters:
taskID - a taskID.
Returns:
the result ( [Key:Value] = [data:AllCSTaskNote(String)] ; [retValue:Boolean(true/false)])
Throws:
WFCIException

getDashboard

com.flowring.dashboard.Dashboard getDashboard(java.lang.String boardId)
                                              throws WFCIException
Returns a Dashboard object by a given Dashboard id.

Parameters:
boardId - a Dashboard id.
Returns:
a Dashboard object.
Throws:
WFCIException

getDashboardGroupList

java.util.List getDashboardGroupList()
                                     throws WFCIException
Gets a list of group from Dashboard without duplicated.

Returns:
each element is a PASEGroup object.
Throws:
WFCIException
See Also:
PASEGroup

getDashboardGroupList

java.util.List getDashboardGroupList(java.lang.String proId)
                                     throws WFCIException
Gets a list of group from Dashboard by the given process id.

Parameters:
proId - a process id.
Returns:
each element is a PASEGroup object.
Throws:
WFCIException
See Also:
PASEGroup

getDashboardGroupListOfUser

java.util.List getDashboardGroupListOfUser(java.lang.String memId,
                                           boolean isMainRoleOnly)
                                           throws WFCIException
Gets a list of group of user's from Dashboard without duplicated.

Parameters:
memId - a member id.
isMainRoleOnly - if true, only the MainRole will be retrived; if false ,all role will be retrived.
Returns:
each element is a PASEGroup object.
Throws:
WFCIException
See Also:
PASEGroup

getDashboardId

java.lang.String getDashboardId(java.lang.String prjId,
                                java.lang.String proId,
                                java.lang.String grpId)
                                throws WFCIException
Gets a Dashboard id by the given value.

Parameters:
prjId - a project id.
proId - a process id.
grpId - a group id.
Returns:
a dashboard id, or null if not found.
Throws:
WFCIException
See Also:
Project, DBProcess, PASEGroup

getDashboardList

java.util.List getDashboardList()
                                throws WFCIException
Gets a dashboard list.

Returns:
each element is a Dashboard object.
Throws:
WFCIException
See Also:
Dashboard

getDashboardListByConditionType

java.util.List getDashboardListByConditionType(java.lang.String columnName,
                                               int relation,
                                               java.lang.String columnValue)

Gets a dashboard list by condition type. For a example: 

 String columnName = "GID"; //MUST be a AF_Dashboard column name
 int relation = "LIKE";
 String columnValue = "value";

 List dboards = wfci.getDashboardListByConditionType(columnName, relation, columnValue);

Returns:
each element is a Dashboard object.

getDashboardListByGroup

java.util.List getDashboardListByGroup(java.lang.String grpId)
                                       throws WFCIException
Gets a dashboard list by the given group id, which contains each id's name.

Parameters:
grpId - a group id, see PASEGroup.
Returns:
each element is a Dashboard object.
Throws:
WFCIException
See Also:
PASEGroup, Dashboard

getDashboardProcessList

java.util.List getDashboardProcessList(java.lang.String prjId)
                                       throws WFCIException
Gets a list of process from Dashboard by the given project id.

Parameters:
prjId - a project id.
Returns:
each element is a DBProcess object, and each process is a root process.
Throws:
WFCIException
See Also:
DBProcess

getDashboardProjectList

java.util.List getDashboardProjectList()
                                       throws WFCIException
Gets a list of project form Dashboard without duplicate.

Returns:
each element is a Project object.
Throws:
WFCIException
See Also:
Project

getDashboardStyleIdList

java.util.List getDashboardStyleIdList(java.lang.String boardId)
                                       throws WFCIException
Gets DashboardStyle id list of a dashboard by a given value.

Parameters:
boardId - a dashboard id.
Returns:
each element is a dashboard id.
Throws:
WFCIException

getDashboardStyleList

java.util.List getDashboardStyleList(java.lang.String boardId)
                                     throws WFCIException
Gets a DashboardStyle list by a given value.

Parameters:
boardId - a Dashboard id.
Returns:
each element is a DashboardStyle object.
Throws:
WFCIException
See Also:
DashboardStyle

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

getDBNameUser

int getDBNameUser()
                  throws WFCIException
Return the number of NameUser

Parameters:
-
Returns:
the number of NameUser
Throws:
WFCIException
See Also:

getDBProcess

DBProcess getDBProcess(java.lang.String pID)
                       throws WFCIException
Returns a data object of process.

Examples: 

    var pID = "PRO0552992937964020";
    var DBProcess = WFCI.getDBProcess(pID);
        returns <dfn>a DBProcess Object</dfn>

Parameters:
pID - a ProcessID.
Returns:
the process.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
DBProcess

getDepartment

Department getDepartment(java.lang.String dID)
                         throws WFCIException
Returns a data object of department by ID.

Examples: 

    var dID = MyTask.getDepartmentID();
    var Department = WFCI.getDepartment(dID);
        returns <dfn>a Department Object</dfn>

Parameters:
dID - a DepartmentID.
Returns:
the department.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Department

getDepartmentHead

MemberRecord getDepartmentHead(MemberRecord mbr,
                               boolean mainRoleOnly)
                               throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getDepartmentHeadByID

MemberRecord getDepartmentHeadByID(java.lang.String memId)
                                   throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getDepartmentHeadByLoginID

MemberRecord getDepartmentHeadByLoginID(java.lang.String loginId)
                                        throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getDepartmentHeadByNo

MemberRecord getDepartmentHeadByNo(java.lang.String memNo)
                                   throws WFCIException
Get the manager of first unit department with the specified member No.

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

getDepartmentListOfPASEGroup

java.util.Vector getDepartmentListOfPASEGroup(java.lang.String gId)
                                              throws WFCIException
Parameters:
gId -
Returns:
Throws:
WFCIException

getDeputiedOfMember

java.util.Vector getDeputiedOfMember(java.lang.String mID)
                                     throws WFCIException
Gets a member list that the given member is each one of the list member deputy. For a example: 
    Supposing member B, C, D has deputed their personal tasks to member A.
    And if member C deputy state is closed, the others are activated. Now
    you want to know whose deputy is member A and whom deputy state is
    activated.

    Here you can know the answer by using this method with a given member
    id of member A. It will return the
 
 MemberRecord
 
  of each member B, D in
    a
 
 Vector
 
  whose deputy state is activated.

Parameters:
mID - a member id who is a deputy.
Returns:
each one element of the Vector is a MemberRecord. Returns a Vector with zero size if there didn't have any member.
Throws:
WFCIException

getEmailTemplate

EmailTemplate getEmailTemplate(java.lang.String etID)
                               throws WFCIException
getEmailTemplate by PROID or ETID.

Examples: 

 var etID = "ETXXXXXXXXXXXXX";

 var emailTemp = WFCI.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.
Throws:
WFCIException
Since:
version 2.2.0

getEnterpriseDiagram

EnterpriseModel getEnterpriseDiagram()
                                     throws WFCIException
Gets the Enterprise Diagram data model.

Throws:
WFCIException

getFileManager

FileManager getFileManager()
Gets a FileManager object.

Returns:
a FileManager object.
Since:
version 1.0.3

getFirstLevelUnitType

UnitType getFirstLevelUnitType()
                               throws WFCIException
Get first unit's unit types

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

getFlowServerHost

java.lang.String getFlowServerHost()
Gets the PASE server address.

Returns:
a host address.
Since:
version 1.0.0

getFlowServerPort

java.lang.String getFlowServerPort()
Gets the PASE server port.

Returns:
a host port.
Since:
version 1.0.0

getFreqApItemList

java.util.Vector getFreqApItemList()
                                   throws WFCIException
Returns a FreqAp diagram item Vector.

Returns:
the correspondence data(each element in Vector are instance of ProcessData).
Throws:
WFCIException
Since:
version 1.1.5

getFreqApListOfMember

java.util.Vector getFreqApListOfMember(java.lang.String memID)
                                       throws WFCIException
Returns a PASEFreqAp List of the specific member.

Returns:
the correspondence data(each element in Vector are instance of PASEFreqAp).
Throws:
WFCIException
Since:
version 1.1.5

getFreqApNodeList

java.util.Vector getFreqApNodeList()
                                   throws WFCIException
Returns a PASEFreqApNode list that will be shown in the FreqAP diagram.

Returns:
the correspondence data(each element in Vector are instance of PASEFreqApNode).
Throws:
WFCIException
Since:
version 1.1.5

getFreqMessageByMbrId

java.util.Vector getFreqMessageByMbrId(java.lang.String mbrId)
                                       throws WFCIException
Parameters:
mbrId -
Returns:
Throws:
WFCIException

getGlobals

java.util.HashMap getGlobals(java.lang.String rootTaskID)
                             throws WFCIException
Gets Globals data from previous setGlobals function.

Examples: 

    var rootTaskID = "Tsk0003459343453";
    var ht = WFCI.getGlobals(rootTaskID);
    var value = ht.get("ItemName");
        returns <dfn>Key Value</dfn> is like "Good"

Parameters:
rootTaskID - a root TaskID.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)]).
Throws:
WFCIException
Since:
version 1.1.5

getGroupSignTinyTaskList

java.util.Vector getGroupSignTinyTaskList(java.lang.String mID)
                                          throws WFCIException
Returns all groupsign tasks of some specific member.

Parameters:
mID - a MemberID.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 1.2
See Also:
TinyTask

getHalfHolidays

java.util.Vector getHalfHolidays()
                                 throws WFCIException
get half holidays in system's default calendar.

Parameters:
memID -
Returns:
Vector halfHolidayLists. Each element is the Vector is a Date half holiday.
Throws:
WFCIException
Since:
version 1.0

getHalfHolidays

java.util.Vector getHalfHolidays(java.lang.String memID)
                                 throws WFCIException
get half holidays in member's calendar.

Parameters:
memID -
Returns:
Vector halfHolidayLists. Each element is the Vector is a Date half holiday.
Throws:
WFCIException
Since:
V3.1

getHistoryRootTaskOfJoinMember

AFTaskList getHistoryRootTaskOfJoinMember(java.lang.String mbrID)
                                          throws WFCIException
Returns a History Root Task List of the Member(mbrID).

Returns:
the correspondence Tasks(each element in Vector are instance of Task).
Throws:
WFCIException
Since:
version 1.1.5p2

getHolidays

java.util.Vector getHolidays()
                             throws WFCIException
get holidays in system's default calendar.

Parameters:
memID -
Returns:
Vector holidayLists. Each element is the Vector is a Date holiday.
Throws:
WFCIException
Since:
version 1.0

getHolidays

java.util.Vector getHolidays(java.lang.String memID)
                             throws WFCIException
get holidays in member's calendar.

Parameters:
memID -
Returns:
Vector holidayLists. Each element is the Vector is a Date holiday.
Throws:
WFCIException
Since:
V3.1

getInvolvedExecutors

java.util.Vector getInvolvedExecutors(java.lang.String rootTaskID)
                                      throws WFCIException
Returns ID list of executors who involved in the root process.

Examples: 

 var v = WFCI.getInvolvedExecutors("Tsk000000835835");

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

getInvolvedMembers

java.util.Vector getInvolvedMembers(java.lang.String rootTaskID)
                                    throws WFCIException
Returns ID list of members who involved in the root process.

Examples: 

 var v = WFCI.getInvolvedMembers("Tsk000000835835");

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

getLatestBBSMsg

java.util.Vector getLatestBBSMsg(int count)
                                 throws WFCIException
Gets the latest BBS Message with the specific count number.

Parameters:
count - a count.
Returns:
result list(each element in Vector are BBSMessage).
Throws:
WFCIException
See Also:
BBSMessage

getLatestBBSMsg

java.util.Vector getLatestBBSMsg(int count,
                                 java.lang.String expBoardID)
                                 throws WFCIException
Gets the latest BBS Message with the specific count number.

Parameters:
count - a count.
expBoardID - the excepted boardID.
Returns:
result list(each element in Vector are BBSMessage).
Throws:
WFCIException
See Also:
BBSMessage

getLatestBBSMsgByMemID

java.util.Vector getLatestBBSMsgByMemID(int count,
                                        java.util.Vector boardList)
                                        throws WFCIException
Throws:
WFCIException

getLicenseNameUser

int getLicenseNameUser()
                       throws WFCIException
Return the license of NameUser

Parameters:
-
Returns:
the license of NameUser
Throws:
WFCIException
See Also:

getMailLoginTimeStamp

long getMailLoginTimeStamp(java.lang.String mailId)
Gets the time value in milliseconds of TimeStamp.

Examples: 

 String mailId = "Mal000000000001";
 long timeStamp = WFCI.getMialLoginTimeStamp(mailId);

Parameters:
mailId -
Returns:
time value in milliseconds

getManager

java.lang.String[] getManager(java.lang.String id)
                              throws WFCIException
Get manager id by member id, role id, or department id.

Examples: 

 var mID = "MEM00041091074401237";
 var rID = "ROL00021091073923770";
 var dID = "DEP00051091073824187";
 var strAryOfMemId = wfci.getManager(mID);
 var strAryOfRolId = wfci.getManager(rID);
 var strAryOfDepId = wfci.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
Throws:
WFCIException
Since:
version 2.2.3

getManagerRole

Role getManagerRole(java.lang.String id)
                    throws WFCIException
Gets 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 mID = "MEM000003495111";

 var rID = "ROL0003931331112";

 var dID = "DEP0000045599112";

 var Result_company = WFCI.getManagerRole("company");
 //returns a
 
 Role
 
 Objectt.var Result_mID = WFCI.getManagerRole(mID);
 //returns a
 
 Role
 
 Object.var Result_rID = WFCI.getManagerRole(rID);
 //returns a
 
 Role
 
 Object.var Result_dID = WFCI.getManagerRole(dID);
 //returns a
 
 Role
 
  Object.

Parameters:
id - a member id, role id, department id, "company".
Returns:
the Role object.
Throws:
WFCIException
Since:
version 1.2
See Also:
MemberRecord, Role, Department

getManagersOfDRM

java.util.Vector getManagersOfDRM(java.lang.String id)
                                  throws WFCIException
Gets 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 <dfn>a Vector Object</dfn>
    var Result_rID = Server.getManagersOfDRM(rID);
        //returns <dfn>a Vector Object</dfn>
    var Result_dID = Server.getManagersOfDRM(dID);
        //returns <dfn>a Vector Object</dfn>
    if(Reslut_mID != null){
                for(var i=0; i<Result_mID.size(); i++){
             var str = Result_mID.get(i);
              for(var j=0; j<str.length; j++)
       var ManagerID = str[j];
        }

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

getMbrSignGroupList

java.util.Vector getMbrSignGroupList(java.lang.String mbrId)
                                     throws WFCIException
Parameters:
mbrId -
Returns:
Throws:
WFCIException

getMember

MemberRecord getMember(java.lang.String id)
                       throws WFCIException
Returns a data object of member by ID, LoginID, or Chinese-Name. The method is used while the content of parameter has not been known. Otherwise, methods getMemberByID(), getMemberByName(), getMemberByCName() is more applied.

Examples: 

    var mID = "MEM00300455304127";
    var mLoginID = "square";
    var mName= "JackLin";
    var MemberBymID = WFCI.getMember(mID);
        returns <dfn>a MemberRecord Object</dfn>
    var MemberBymLoginID = WFCI.getMember(mLoginID);
        returns <dfn>a MemberRecord Object</dfn>
    var MemberBycName = WFCI.getMember(mName);
        returns <dfn>a MemberRecord Object</dfn>

Parameters:
id - a MemberID, MemberLoginID, or MemberCName.
Returns:
the member.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
MemberRecord, getMemberByID(String), getMemberByName(String), getMemberByCName(String)

getMemberAccess

AccessMember getMemberAccess(java.lang.String mID)
                             throws WFCIException
Gets the access config of Agenda for the specific member.

Parameters:
mID - a MemberRecordID.
Returns:
the AccessMember instance.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessMember

getMemberAdminAccess

AccessAdmin getMemberAdminAccess(java.lang.String mID)
                                 throws WFCIException
Gets the access config of Admin for the specific member.

Parameters:
mID - a MemberRecordID.
Returns:
the AccessAdmin instance.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessAdmin

getMemberArtifactAccess

java.util.Vector getMemberArtifactAccess(java.lang.String mID)
                                         throws WFCIException
Gets the access config list of Agenda's function "artifact search" for the specific member.

Parameters:
mID - a MemberRecordID.
Returns:
the correspondence data(each element in Vector are instance of AccessArtifact).
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessArtifact

getMemberByCName

MemberRecord getMemberByCName(java.lang.String mName)
                              throws WFCIException
Returns a data object of member by Chinese-Name.

Examples: 

    var mName = "JackLin";
    var MemberRecord = WFCI.getMemberByCName(mName);
        returns <dfn>a MemberRecord Object</dfn>

Parameters:
mName - a MemberCName.
Returns:
the member.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
MemberRecord

getMemberByID

MemberRecord getMemberByID(java.lang.String mID)
                           throws WFCIException
Returns a data object of member by ID.

Examples: 

    var mID = "MEM00300455304127";
    var MemberRecord = WFCI.getMemberByID(mID);
        returns <dfn>a MemberRecord Object</dfn>

Parameters:
mID - a MemberID.
Returns:
the member.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
MemberRecord

getMemberByName

MemberRecord getMemberByName(java.lang.String mLoginID)
                             throws WFCIException
Returns a data object of member by LoginID.

Examples: 

    var mLoginID = "square";
    var MemberRecord = WFCI.getMemberByName(mLoginID);
        returns <dfn>a MemberRecord Object</dfn>

Parameters:
mID - a MemberLoginID.
Returns:
the member.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
MemberRecord

getMemberListOfPASEGroup

java.util.Vector getMemberListOfPASEGroup(java.lang.String gId)
                                          throws WFCIException
Parameters:
gId -
Returns:
Throws:
WFCIException

getMemberOnLineAccess

AccessOnLineUser getMemberOnLineAccess(java.lang.String mID)
                                       throws WFCIException
Gets the access config of Agenda's function "on-line user" for the specific member.

Parameters:
mID - a MemberRecordID.
Returns:
the AccessOnLineUser instance.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessOnLineUser

getMemberTaskAccess

java.util.Vector getMemberTaskAccess(java.lang.String mID)
                                     throws WFCIException
Gets the access config list of Agenda's function "task search" for the specific member.

Parameters:
mID - a MemberRecordID.
Returns:
the correspondence data(each element in Vector are instance of AccessTask).
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessTask

getMultiOrgPermList

java.util.List getMultiOrgPermList()
                                   throws WFCIException
Get all member ID of users who can use multiorg.

Returns:
all member ID.(each element in Vector are member ID).
Throws:
WFCIException
Since:
V3.0

getMultiOrgPermLoginIDList

java.util.List getMultiOrgPermLoginIDList()
                                          throws WFCIException
Get all login ID of users who can use multiorg.

Returns:
all login ID.(each element in Vector are login ID).
Throws:
WFCIException
Since:
V3.0

getMultiServerACL

com.flowring.aeppServer.MultiServerACL getMultiServerACL(java.lang.String muoId,
                                                         java.lang.String memId)
                                                         throws WFCIException
Get Multi Server access control with specified multiorg ID and member ID.

Parameters:
String - multiorg ID (It means a AEPP Server ID).
Stirng - member ID.
Returns:
MultiServerACL bean object.
Throws:
WFCIException
Since:
V3.0

getNewAFGroupID

java.lang.String getNewAFGroupID()
                                 throws WFCIException
Returns:
Throws:
WFCIException

getNewArtInsID

java.lang.String getNewArtInsID()
                                throws WFCIException
Returns a new ArtIns ID.

Returns:
ArtIns ID
Throws:
WFCIException
Since:
version 1.2

getNewBBSMsgID

java.lang.String getNewBBSMsgID()
                                throws WFCIException
Returns a new BBS Msg ID.

Returns:
BBS Msg ID
Throws:
WFCIException
Since:
version 1.2

getNewDayId

java.lang.String getNewDayId()
                             throws WFCIException
Generate a new Day ID.

Returns:
true ID string.
Throws:
WFCIException
Since:
version V3.1

getNewFileID

java.lang.String getNewFileID()
                              throws WFCIException
Returns a new File ID.

Returns:
File ID
Throws:
WFCIException
Since:
version 1.2

getNewGroupSignID

java.lang.String getNewGroupSignID()
                                   throws WFCIException
Generate a new GroupSign ID

Returns:
StringGroupSign ID
Throws:
WFCIException

getNewMsgID

java.lang.String getNewMsgID()
                             throws WFCIException
Returns a new Msg ID.

Returns:
Msg ID
Throws:
WFCIException
Since:
version 1.2

getNewMultiAeppServerID

java.lang.String getNewMultiAeppServerID()
                                         throws WFCIException
Retrieve the multi AEPP Server ID. This ID is defined in the AEPP system config panel.

Returns:
the AEPP Server ID.
Throws:
WFCIException
Since:
V3.0

getNewOfficeHourId

java.lang.String getNewOfficeHourId()
                                    throws WFCIException
Generate a new OfficeHour ID.

Returns:
true ID string.
Throws:
WFCIException
Since:
version V3.1

getNewProcessMapCategoryID

java.lang.String getNewProcessMapCategoryID()
                                            throws WFCIException
Get a ID of the ProcessMap Category.

Returns:
Category ID.
Throws:
WFCIException
Since:
V3.1

getNewTaskID

java.lang.String getNewTaskID()
                              throws WFCIException
Returns a new Task ID.

Returns:
Task ID
Throws:
WFCIException
Since:
version 1.2

getNewWorkingDayId

java.lang.String getNewWorkingDayId()
                                    throws WFCIException
Generate a new WorkingDay ID.

Returns:
true ID string.
Throws:
WFCIException
Since:
version V3.1

getNewWorkingDayTemplateId

java.lang.String getNewWorkingDayTemplateId()
                                            throws WFCIException
Generate a new WorkingDayTemplate ID.

Returns:
true ID string.
Throws:
WFCIException
Since:
version V3.1

getNextManager

MemberRecord getNextManager(MemberRecord mbr)
                            throws WFCIException
Get Next manger with the specified MemberRecord

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

getNextManager

MemberRecord getNextManager(MemberRecord mbr,
                            int levelNumber)
                            throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getNextManagerByID

MemberRecord getNextManagerByID(java.lang.String memId)
                                throws WFCIException
Get Next manger with the specified member id

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

getNextManagerByID

MemberRecord getNextManagerByID(java.lang.String memId,
                                int levelNumber)
                                throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getNextManagerByLoginID

MemberRecord getNextManagerByLoginID(java.lang.String loginId)
                                     throws WFCIException
Get Next manger with the specified member's login id

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

getNextManagerByLoginID

MemberRecord getNextManagerByLoginID(java.lang.String loginId,
                                     int levelNumber)
                                     throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getNextManagerByNo

MemberRecord getNextManagerByNo(java.lang.String memNo)
                                throws WFCIException
Get Next manger with the specified member No.

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

getNextManagerByNo

MemberRecord getNextManagerByNo(java.lang.String memNo,
                                int levelNumber)
                                throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getOneDepartmentByName

Department getOneDepartmentByName(java.lang.String mName)
                                  throws WFCIException
Gets department by the specified department name.

Parameters:
mName - a department name.
Returns:
the Department object.
Throws:
WFCIException
Since:
version 1.2
See Also:
Department

getOneRoleByName

Role getOneRoleByName(java.lang.String mName)
                      throws WFCIException
Gets role by the specified role name.

Parameters:
mName - a role name.
Returns:
the Role object.
Throws:
WFCIException
Since:
version 1.2
See Also:
Role

getOnlineAdminUser

java.util.Vector getOnlineAdminUser()
                                    throws WFCIException
Gets the on-line admin user list.

Returns:
the MemberRecord list(each element in Vector are instance of MemberRecord).
Throws:
WFCIException
See Also:
MemberRecord.

getOnlineUser

java.util.Vector getOnlineUser()
                               throws WFCIException
Gets the on-line user list.

Returns:
the MemberRecord list(each element in Vector are instance of MemberRecord).
Throws:
WFCIException
See Also:
MemberRecord

getOptionList

java.util.List getOptionList(java.lang.String qstId)
                             throws WFCIException
The implement method should get option list by the given question id.

Parameters:
qstId - a question id.
Returns:
each element is a Option object.
Throws:
WFCIException

getOptionTemplateIdList

java.util.List getOptionTemplateIdList()
                                       throws WFCIException
The implement method should return option template id list.

Returns:
each element is a option template id.
Throws:
WFCIException
Since:
version 3.0

getParentIDListOfMember

java.util.Vector getParentIDListOfMember(java.lang.String mID,
                                         boolean isMainRoleOnly)
                                         throws WFCIException
Gets All parent CompanyID, RolID, DepID, MemID of Member.

Examples: 

 var mID = "MEM000003495111";

 var parentIDList = WFCI.getParentIDListOfMember(mID, true);

Parameters:
mID - a 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).
Throws:
WFCIException

getPASEFreqAp

PASEFreqAp getPASEFreqAp(java.lang.String freID)
                         throws WFCIException
Returns a PASEFreqAp with the specific ID.

Returns:
the PASEFreqAp instance.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
PASEFreqAp

getPASEGroup

PASEGroup getPASEGroup(java.lang.String id)
                       throws WFCIException
Parameters:
id -
Returns:
Throws:
WFCIException

getPASEGroupList

java.util.Vector getPASEGroupList()
                                  throws WFCIException
Get all PASEGroup.

Returns:
all PASEGroup(each element in Vector is a instance of PASEGroup)
Throws:
WFCIException
Since:
version 2.0.0
See Also:
PASEGroup

getPASEGroupListByIdList

java.util.List getPASEGroupListByIdList(java.util.Vector idList)
                                        throws WFCIException
get all PASEGroup id list by id list.

Parameters:
idList. - Each element in the Vector is String id, ex: MEMxxx, ROLxxx, DEPxxx, COMxxx.
Returns:
List group id list. Each element in the List> is String group id.
Throws:
WFCIExceptiont
WFCIException
Since:
V3.1

getPASEMessageOfMember

java.util.Vector getPASEMessageOfMember(java.lang.String mID)
                                        throws WFCIException
Gets message of the member.

Parameters:
mID - the member ID.
Returns:
the PASEMessage list of the member(each element in Vector are instance of PASEMessage).
Throws:
WFCIException
See Also:
PASEMessage

getPASEProcessOfMember

AFProcessList getPASEProcessOfMember(java.lang.String mID)
                                     throws WFCIException
Returns the root processes of some specific member.

Examples: 

    var mID = "MEM0002993177798390";
    var PASEProcessList = WFCI.getPASEProcessOfMember(mID);
    if(PASEProcessList != null) {
        for(var i=0;i<PASEProcessList.size();i++){
            var process =PASEProcessList.get(i);
                returns <dfn>an AFProcess Object</dfn>
        }
    }

Parameters:
mID - a MemberID.
Returns:
the correspondence AFProcessList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFProcessList

getPASESharedFile

PASESharedFile getPASESharedFile(java.lang.String fId)
                                 throws WFCIException
Throws:
WFCIException

getPASESharedFileByPath

PASESharedFile getPASESharedFileByPath(java.lang.String fPath)
                                       throws WFCIException
Parameters:
fPath -
Returns:
Throws:
WFCIException

getPDiagramDetail

java.util.Vector getPDiagramDetail(java.lang.String rootTID)
                                   throws WFCIException
Returns the detail of process diagram.

Examples: 

    var tID = "Tsk0003459343453";
    var task = WFCI.getTask(tID);
    var rootTID = currTask.getRootID();
    var Result  = WFCI.getPDiagramDetail(rootTID);
    for(var i=0;i<Result.size();j++) {
        var taskInfo = Result.get(i);
            returns <dfn>TaskInfo object</dfn>
    }

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


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

    var taskName = taskInfo.getTaskName();
        returns <dfn>Task Name</dfn> is like "Process1"

    var RealExecutorName = taskInfo.getRealExecutorName();
        returns <dfn>Real Executor Name</dfn> is like "JackLin"

    var RealExecutorID = taskInfo.getRealExecutorID();
        returns <dfn>Real Executor MemID</dfn> is like "MEM0000992492169920"

    var DefaultExecutorName = taskInfo.getDefaultExecutorName();
        returns <dfn>Default Executor Name</dfn> is like "Jean"

    var DefaultExecutorID = taskInfo.getDefaultExecutorID();
        returns <dfn>Default Executor MemID</dfn> is like "MEM0000212392162210"

    var ArtiName = taskInfo.getArtiName();
        returns <dfn>Artifact Name</dfn> is like "Artifact1"

    var ArtiKeyWord = taskInfo.getArtiKW();
        returns <dfn>Artifact Keyword by User Input</dfn>

    var ArriTime = taskInfo.getArriTime();
        returns <dfn>Task Arrivate Time</dfn> is like 993524946300

    var ArriTimeStr = getFormatedTime(ArriTime);
        returns <dfn>the Time Formate of ArriTime</dfn> is like "2001/06/26 11:09"

    var DuraTime = taskInfo.getDuraTime();
        returns <dfn>Duration Time</dfn> is like -993524946300

    var DuraTimeStr = getFormatedTime(DuraTime);
        returns <dfn>the Time Formate of DuraTime</dfn> is like "1938/07/09 04:50"

    var TaskID = taskInfo.getTaskID();
        returns <dfn>TaskID</dfn> is like "Tsk000000258259"

    var ArtiID = taskInfo.getArtiID();
        returns <dfn>Artifact InstanceID</dfn> is like "Ans000000248248"

    var TaskState = taskInfo.getTaskState();
        returns <dfn>Task State</dfn> is like "running"

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

Parameters:
rootTID - a root TaskID.
Returns:
the detail information in process diagram.
Throws:
WFCIException
Since:
version 1.0.0

getPDiagramState

java.util.HashMap getPDiagramState(java.lang.String rootTID)
                                   throws WFCIException
Returns the states of process diagram.

Examples: 

    var tID = "Tsk0003459343453";
    var task = WFCI.getTask(tID);
    var rootTID = task.getRootID();
    var Result = WFCI.getPDiagramState(rootTID);
    for(var i = Result.entrySet().iterator();i.hasNext(); ){
        var entry = i.next();
            returns "PRO0549992486182610Root_POPUP_DELIBLE=running"
    }

Parameters:
rootPID - a ProcessID.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)]).
Throws:
WFCIException
Since:
version 1.0.0

getPersonalConfig

PersonalConfig getPersonalConfig(java.lang.String mId)
                                 throws WFCIException
Throws:
WFCIException

getPersonalFavorite

PersonalConfig getPersonalFavorite(java.lang.String memberId,
                                   java.lang.String variety)
                                   throws WFCIException
Throws:
WFCIException

getPersonalProShow

PersonalConfig getPersonalProShow(java.lang.String memberId,
                                  java.lang.String variety)
                                  throws WFCIException
Throws:
WFCIException

getProcessDiagram

java.util.HashMap getProcessDiagram(java.lang.String rootPID,
                                    java.lang.String rootTaskID)
                                    throws WFCIException
Returns a process diagram.

Parameters:
rootPID - a ProcessID.
rootTaskID - a TaksID.
Returns:
the process diagram.
Throws:
WFCIException

getProcessDiagramAndState

java.util.HashMap getProcessDiagramAndState(java.lang.String rootPID,
                                            java.lang.String rootTaskID)
                                            throws WFCIException
Gets Monitor Diagram Data.

Parameters:
rootPID - root process id.
rootTaskID - root task id.
Throws:
WFCIException

getProcessMapCategory

Category getProcessMapCategory(java.lang.String id)
                               throws WFCIException
Get the Category bean of ProcessMap with specified ID.

Returns:
Category bean object.
Throws:
WFCIException
Since:
V3.1

getProcessMapCategoryList

java.util.List getProcessMapCategoryList()
                                         throws WFCIException
Get all ProcessMap Category in database.

Returns:
List Category. Each element in the list is pe.pase.Category.
Throws:
WFCIException
Since:
V3.1

getProcessMapLink

Link getProcessMapLink(Link link)
                       throws WFCIException
Get the ProcessMap Link bean with specified ID and parent ID of the Link bean.

Returns:
Link bean object.
Throws:
WFCIException
Since:
V3.1

getProcessMapLinkList

java.util.List getProcessMapLinkList(java.lang.String parentId)
                                     throws WFCIException
Get all ProcessMap Link with specified parent ID.

Returns:
Link bean object.
Throws:
WFCIException
Since:
V3.1

getProcessMapParentIdListByProId

java.util.List getProcessMapParentIdListByProId(java.lang.String proId)
                                                throws WFCIException
Get all parent Id by process Id.

Parameters:
proId -
Returns:
ParentIds
Throws:
WFCIException
Since:
V3.1

getProcessVersion

ProcessVersion getProcessVersion(java.lang.String rootProcessId)
                                 throws WFCIException
Returns a data object of process version.

Examples: 

   var rootProcessId = "PRO0552992937964020";
   var ProcessVersion = WFCI.getProcessVersion(rootProcessId);
       returns a ProcessVersion Object

Parameters:
rootProcessId - a rootProcessID.
Returns:
the process version.
Throws:
WFCIException
Since:
version 2.4.0
See Also:
ProcessVersion

getProcessView

java.util.HashMap getProcessView(java.lang.String rootPID)
                                 throws WFCIException
Throws:
WFCIException

getProductInfo

java.util.HashMap getProductInfo()
                                 throws WFCIException
Gets product version info. 
 HashMap proInfo = wfci.getProductInfo();

 String serial = (String) productInfo.get("SerialNo"); // The product version

 String product = (String) productInfo.get("AuthoredName"); // The license number

 String corp = (String) productInfo.get("Corp"); // The user name

Returns:
product info.
Throws:
WFCIException
Since:
version 1.1.5

getProject

Project getProject(java.lang.String prjID)
                   throws WFCIException
Returns a data object of project by ID.

Examples: 

    var prjID = "PRJ0044036520459";
    var Project = WFCI.getProject(prjID);
        returns <dfn>a Project Object</dfn>

Parameters:
prjID - a ProjectID.
Returns:
the project.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Project

getProjectOfCompany

AFProjectList getProjectOfCompany()
                                  throws WFCIException
Returns all projects.

Examples: 

    var ProjectList = WFCI.getProjectOfCompany();
    if(ProjectList != null) {
        for(var i=0;i>ProjectList.size();i++){
            var Project = ProjectList.get(i);
                returns <dfn>an AFProject Object</dfn>
        }
    }

Returns:
the correspondence AFProjectList.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFProjectList

getProjectOfDepartment

AFProjectList getProjectOfDepartment(java.lang.String dID)
                                     throws WFCIException
Returns the projects of some specific department.

Examples: 

    var dID = "DEP0000972876387719";
    var ProjectList = WFCI.getProjectOfDepartment(dID);
    if(ProjectList != null) {
        for(var i=0;i>ProjectList.size();i++){
            var Project =ProjectList.get(i);
                returns <dfn>an AFProject Object</dfn>
        }
    }

Parameters:
dID - a DepartmentID.
Returns:
the correspondence AFProjectList.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFProjectList

getProjectOfManager

AFProjectList getProjectOfManager(java.lang.String managerID)
                                  throws WFCIException
Returns the projects with some specific project manager.

Examples: 

    var managerID = "MEM953256027740";
    var ProjectList = WFCI.getProjectOfManager(managerID);
    if(ProjectList != null) {
        for(var i=0;i>ProjectList.size();i++){
            var Project =ProjectList.get(i);
                returns <dfn>an AFProject Object</dfn>
        }
    }

Parameters:
managerID - a MemberID.
Returns:
the correspondence AFProjectList.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFProjectList

getProjectOfPASEProcess

Project getProjectOfPASEProcess(java.lang.String proID)
                                throws WFCIException
Returns the project of the PASEProcess.

Examples: 

    var proID = "PRO00440363552012";
    var Project = WFCI.getProjectOfPASEProcess(proID);
        returns <dfn>a Project Object</dfn>

Parameters:
proID - a PASEProcessID.
Returns:
the project.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
Project

getProjectRole

ProjectRole getProjectRole(java.lang.String rID)
                           throws WFCIException
Returns a data object of project role by ID.

Examples: 

    var rID = MyTask.getRoleID();
    var ProjectRole = WFCI.getProjectRole(rID);
        returns <dfn>a ProjectRole Object</dfn>

Parameters:
rID - a ProjectRoleID.
Returns:
the project role.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
ProjectRole

getPumpTaskList

java.util.List getPumpTaskList(java.lang.String rootID)
                               throws WFCIException
get pump task list. Each element in List can be retrieved by user.

Parameters:
rootID -
Returns:
List pumpTaskList. Each element in the list is a task id(String).
Throws:
WFCIException
Since:
V2.4

getQuestionnaire

com.flowring.questionnaire.entity.Questionnaire getQuestionnaire(java.lang.String qId)
                                                                 throws WFCIException
The implement method should return a Questionnaire object by the given questionnaire id.

Parameters:
qneId - a questionnaire id.
Returns:
a questionnaire object, each questionnaire consist of one or more question. null if not found the questionnaire.
Throws:
WFCIException

getQuestionnaireAdminList

java.util.List getQuestionnaireAdminList()
                                         throws WFCIException
The implement method should get manager list of questionnaire module.

Returns:
each value is a member id.
Throws:
WFCIException

getQuestionnaireList

java.util.List getQuestionnaireList()
                                    throws WFCIException
The implement method should get all questionnaire.

Returns:
each element is a Questionnaire object.
Throws:
WFCIException

getQuestionnaireList

java.util.List getQuestionnaireList(com.flowring.questionnaire.entity.QuestionnaireSearchCondition condition)
The implement method should get questionnaire list by the given questionnaire search condition. If the parameter is null, it must get all questionnaire.

Parameters:
condition - questionnaire search condition.
Returns:
each element is a Questionnaire object.
Throws:
WFCIException
Since:
Agentflow 3.0

getQuestionnairePermList

java.util.List getQuestionnairePermList(java.lang.String qneId)
                                        throws WFCIException
The implement method should get questionnaire permission list by the given questionnaire id.

Parameters:
qneId - a questionnaire id.
Returns:
each element is a member id or a rule id or a department id.
Throws:
WFCIException

getQuestionnaireResult

com.flowring.questionnaire.entity.QuestionnaireResult getQuestionnaireResult(java.lang.String qneId,
                                                                             java.lang.String memId)
                                                                             throws WFCIException
The implement method should return a QuestionnaireResult object by the given parameters.

Parameters:
qneId - a questionnaire id.
memId - a member id.
Returns:
a QuestionnaireResult object. null if not found the questionnaire result.
Throws:
WFCIException

getQuestionnaireResultList

java.util.List getQuestionnaireResultList(java.lang.String qneId)
                                          throws WFCIException
The implement method should get QuestionnaireResult list by the given questionnaire id.

Parameters:
qneId - a questionnaire id.
Returns:
each element is a QuestionnaireResult object.
Throws:
WFCIException

getQuestionnaireSummaryResult

com.flowring.questionnaire.entity.QuestionnaireSummaryResult getQuestionnaireSummaryResult(com.flowring.questionnaire.entity.Questionnaire qne)
                                                                                           throws WFCIException
Get a questionnaire summary result.

Parameters:
qne - a Questionnaire object.
Returns:
QuestionnaireSummaryResult
Throws:
WFCIException

getRegAdminList

java.util.Vector getRegAdminList()
                                 throws WFCIException
Returns:
Throws:
WFCIException

getReportService

ReportService getReportService()
                               throws WFCIException
Throws:
WFCIException

getRequestHistoryRootTaskOfJoinMember

AFTaskList getRequestHistoryRootTaskOfJoinMember(java.lang.String mbrID)
                                                 throws WFCIException
Returns a Request History Root Task List of the Member(mbrID).

Returns:
the correspondence Tasks(each element in Vector are instance of Task).
Throws:
WFCIException
Since:
version 1.1.5p2

getRole

Role getRole(java.lang.String rID)
             throws WFCIException
Returns a data object of role by ID.

Examples: 

    var rID = MyTask.getRoleID();
    var role = WFCI.getRole(rID);
        returns <dfn>a Role Object</dfn>

Parameters:
rID - a RoleID.
Returns:
the role.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Role

getRoleListOfPASEGroup

java.util.Vector getRoleListOfPASEGroup(java.lang.String gId)
                                        throws WFCIException
Parameters:
gId -
Returns:
Throws:
WFCIException

getRoleSearchResult

java.util.Map getRoleSearchResult(java.lang.String keyword,
                                  boolean depNameSearch,
                                  boolean rolNamesearch,
                                  boolean memNameSearch,
                                  boolean loginIdSearch)
Get the role search result with the keyword.

Returns:
String the search result string.
Since:
V3.0

getRootDBProcessOfProject

java.util.Vector getRootDBProcessOfProject(java.lang.String prjID)
                                           throws WFCIException
Returns a data object of process.

Examples:

Parameters:
prjID - a ProjectID.
Returns:
the correspondence root process(each elemen in Vector are instance of DBProcess)
Throws:
WFCIException
Since:
version 3.0.1 (hotfix)
See Also:
DBProcess

getRootTaskOfJoinMember

AFTaskList getRootTaskOfJoinMember(java.lang.String mID)
                                   throws WFCIException
Returns root tasks with some specific member is involved in. The root tasks' state are not complete or dead.

Parameters:
mID - a MemberID.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getRootTaskOfJoinMember

AFTaskList getRootTaskOfJoinMember(java.lang.String mID,
                                   int state)
                                   throws WFCIException
Returns root tasks with the specific member is involved in and the specific state.

Parameters:
mID - a MemberID.
state - a TaskState,see attributes TASK_STATE_XXX in pe.pase.Task.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getRootTaskOfJoinMember

AFTaskList getRootTaskOfJoinMember(java.lang.String mID,
                                   java.lang.String proID)
                                   throws WFCIException
Returns root tasks with the specific member is involved in and the specific state.

Parameters:
mID - a MemberID.
proID - a ProcessID
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getRootTaskOfMember

AFTaskList getRootTaskOfMember(java.lang.String mID)
                               throws WFCIException
Returns root tasks executed by some specific member.

Examples: 

    var mID = "MEM953256027740";
    var TaskList = WFCI.getRootTaskOfMember(mID);
    for (var i=0;i<TaskList.size();i++) {
        var Task=TaskList.get(i);
            returns <dfn>an AFTask Object</dfn>
    }

Parameters:
mID - a MemberID.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getRootTaskOfMember

AFTaskList getRootTaskOfMember(java.lang.String mID,
                               int state)
                               throws WFCIException
Returns root tasks which in some state and executed by some specific member.

Examples: 

    var mID = "MEM953256027740";
    var state = pe.pase.Task.TASK_STATE_RUNNING;
    var TaskList = WFCI.getRootTaskOfMember(mID,state);
    for (var i=0;i<TaskList.size();i++) {
        var Task=TaskList.get(i);
            returns <dfn>an AFTask Object</dfn>
    }

Parameters:
mID - a MemberID.
state - a TaskState,see attributes TASK_STATE_XXX in pe.pase.Task.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getRootTaskOfProcess

java.util.Vector getRootTaskOfProcess(java.lang.String proID)
                                      throws WFCIException
Returns the task list of the Process.

Examples: 

 var proID = "PRO00440363552012";
 var state = 2 + 4;
 var taskList = WFCI.getRootTaskOfProcess(proID);
 if (taskList != null) {
        for (var i = 0; i > taskList.size(); i++) {
                var task = taskList.get(i);
        }
 }

Parameters:
proID - a DBProcess ID.
Returns:
Vector each element is TinyTask.
Throws:
WFCIException
Since:
version 2.2.3

getRootTaskOfProcess

java.util.Vector getRootTaskOfProcess(java.lang.String proID,
                                      int state)
                                      throws WFCIException
Returns the task list of the Process with the specific state.

Examples: 

 var proID = "PRO00440363552012";
 var state = 2 + 4;
 var taskList = WFCI.getRootTaskOfProcess(proID, state);
 if (taskList != null) {
        for (var i = 0; i < taskList.size(); i++) {
                var task = taskList.get(i);
        }
 }

Parameters:
proID - a DBProcessID.
state - the task state:
  • Ready = 1
  • Running = 2
  • Complete = 4
  • Suspended = 8
  • DEAD = 16
  • QUEUE = 32
  • Server Waiting = 64
  • Client Waiting = 128
  • Lock = 256
  • All = 1 & 2 & 4 & 8 & 16 & 32 & 64 & 128 & 256
Returns:
Vector each element is TinyTask.
Throws:
WFCIException
Since:
version 2.2.3

getScheduleEvent

ScheduleEvent getScheduleEvent(java.lang.String id)
                               throws WFCIException
Gets schedule event.

Parameters:
id - Event id of ScheduleEvent.
Returns:
event of specified id.
Throws:
WFCIException

getServerEnv

SerRuntimeEnv getServerEnv()
                           throws WFCIException
Gets server runtime environment. 
   SerRuntimeEnv serEnv = wfci.getServerEnv();

Returns:
SerRuntimeEnv the server runtime environment.
Throws:
WFCIException
Since:
version 2.3.1

getServerGMT

double getServerGMT()
get the GMT of server

Returns:
GMT
Since:
V3.1

getServerStatus

java.util.HashMap getServerStatus()
                                  throws WFCIException
Gets server status. 
 HashMap status = wfci.getServerStatus();

 boolean runing = ((Boolean) status.get("run")).booleanValue(); // Check if the server is running

 String dbtype = (String) status.get("dbType"); // The Database type

Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4

getServerTime

long getServerTime()
                   throws WFCIException
Gets server time. 
 String time = new Time(wfci.getServerTime()).toString();

Returns:
long the server time.
Throws:
WFCIException
Since:
version 1.1.6

getSubDepIDOfDR

java.util.Vector getSubDepIDOfDR(java.lang.String id,
                                 boolean exp)
                                 throws WFCIException
Gets sub-department's id by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.

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

getSubDepNameOfDR

java.util.Vector getSubDepNameOfDR(java.lang.String id,
                                   boolean exp)
                                   throws WFCIException
Gets sub-department's name by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.

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

getSubMemberCNameOfDR

java.util.Vector getSubMemberCNameOfDR(java.lang.String id,
                                       boolean exp)
                                       throws WFCIException
Gets sub-member's name by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.

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

getSubMemberIDOfDR

java.util.Vector getSubMemberIDOfDR(java.lang.String id,
                                    boolean exp)
                                    throws WFCIException
Gets sub-member's ID by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.

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

getSubMemListOfMember

java.util.Vector getSubMemListOfMember(java.lang.String mID)
                                       throws WFCIException
Returns a MemberRecord ID list of sub-members of the member.

Parameters:
mID - a MemberRecordID.
Returns:
the MemberRecord ID list.
Throws:
WFCIException
Since:
version 1.1

getSubRoleIDOfDR

java.util.Vector getSubRoleIDOfDR(java.lang.String id,
                                  boolean exp)
                                  throws WFCIException
Gets sub-role's id by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.

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

getSubRoleNameOfDR

java.util.Vector getSubRoleNameOfDR(java.lang.String id,
                                    boolean exp)
                                    throws WFCIException
Gets sub-role's name by specified department id or role id, and that search directly down the organizer according to the 'exp' argument.

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

getSubTaskList

AFTaskList getSubTaskList(java.lang.String parentTID)
                          throws WFCIException
Returns subtasks of some specific task.

Examples: 

    var parentID = "Tsk000000254284";
    var TaskList = WFCI.getSubTaskList(parentID);
    for (var i=0;i<TaskList.size();i++) {
        var Task=TaskList.get(i);
            returns <dfn>an AFTask Object</dfn>
    }

Parameters:
parentTID - a TaskID.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getTask

Task getTask(java.lang.String tID)
             throws WFCIException
Returns a data object of task.

Examples: 

    var taskID = "Tsk000000226229";
    var Task = WFCI.getTask(taskID);
        returns <dfn>a Task Object</dfn>

Parameters:
tID - a TaskID.
Returns:
the task.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Task

getTaskAttachedFileContent

java.lang.String getTaskAttachedFileContent(java.lang.String fileID)
                                            throws WFCIException
Throws:
WFCIException

getTaskIDListOfMember

java.util.Vector getTaskIDListOfMember(java.lang.String mID,
                                       int sc,
                                       int ec,
                                       java.lang.String order)
                                       throws WFCIException
Returns all task id of some specific member.

parameter 'order' should be one of the followring :

  • TASK_SORT_PROID
  • TASK_SORT_STATE
  • TASK_SORT_MEMID
  • TASK_SORT_EXEID
  • TASK_SORT_DEPID
  • TASK_SORT_ROLID
  • TASK_SORT_STARTTIME
  • TASK_SORT_ENDTIME
  • TASK_SORT_TYPE
  • TASK_SORT_KEYWORD
  • TASK_SORT_PRIORITY

Parameters:
mID - a MemberID.
sc - start index.
ec - end index.
order - for sorting.
Returns:
the task ID list.
Throws:
WFCIException
Since:
version 1.1.6
See Also:
Task

getTaskList

AFTaskList getTaskList(java.lang.String mID)
                       throws WFCIException
Returns all tasks of some specific member.

Parameters:
mID - a MemberID.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getTaskManager

TaskManager getTaskManager()
Gets a TaskManager object.

Returns:
a TaskManager object.
Since:
version 1.1

getTaskOfCompany

java.util.Vector getTaskOfCompany()
                                  throws WFCIException
Throws:
WFCIException

getTaskOfCompany

java.util.Vector getTaskOfCompany(int state)
                                  throws WFCIException
Parameters:
state -
Returns:
Throws:
WFCIException

getTaskOfDepartment

java.util.Vector getTaskOfDepartment(java.lang.String dID)
                                     throws WFCIException
Parameters:
dID -
Returns:
Throws:
WFCIException

getTaskOfDepartment

java.util.Vector getTaskOfDepartment(java.lang.String dID,
                                     int state)
                                     throws WFCIException
Parameters:
dID -
state -
Returns:
Throws:
WFCIException

getTaskOfMember

AFTaskList getTaskOfMember(java.lang.String mID)
                           throws WFCIException
Returns tasks executed by some specific member.

Examples: 

    var mID = "MEM953256027740";
    var TaskList = WFCI.getTaskOfMember(mID);
    for (var i=0;i<TaskList.size();i++) {
        var Task=TaskList.get(i);
            returns <dfn>an AFTask Object</dfn>
    }

Parameters:
mID - a MemberID.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getTaskOfMember

AFTaskList getTaskOfMember(java.lang.String mID,
                           int state)
                           throws WFCIException
Returns root tasks which in some state and executed by some specific member.

Examples: 

    var mID = "MEM953256027740";
    var state = pe.pase.Task.TASK_STATE_RUNNING;
    var TaskList = WFCI.getTaskOfMember(mID,state);
    for (var i=0;i<TaskList.size();i++) {
        var Task=TaskList.get(i);
            returns <dfn>an AFTask Object</dfn>
    }

Parameters:
mID - a MemberID.
state - a TaskState, see attributes TASK_STATE_XXX in pe.pase.Task.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getTaskOfProcess

AFTaskList getTaskOfProcess(java.lang.String proID)
                            throws WFCIException
Returns the task list of the Process.

Examples: 

 var proID = "PRO00440363552012";
 var state = 2 + 4;
 var taskList = WFCI.getTaskOfProcess(proID);
 if (taskList != null) {
        for (var i = 0; i > taskList.size(); i++) {
                var task = taskList.get(i);
        }
 }

Parameters:
proID - a PASEProcessID.
Returns:
the correspondence AFTaskList(each element is an AFTask object).
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFTaskList

getTaskOfProcess

AFTaskList getTaskOfProcess(java.lang.String proID,
                            int state)
                            throws WFCIException
Returns the task list of the Process with the specific state.

Examples: 

 var proID = "PRO00440363552012";
 var state = 2 + 4;
 var taskList = WFCI.getTaskOfProcess(proID, state);
 if (taskList != null) {
        for (var i = 0; i < taskList.size(); i++) {
                var task = taskList.get(i);
        }
 }

Parameters:
proID - a PASEProcessID
state - the task state:
  • Ready = 1
  • Running = 2
  • Complete = 4
  • Suspended = 8
  • DEAD = 16
  • QUEUE = 32
  • Server Waiting = 64
  • Client Waiting = 128
  • Lock = 256
  • All = 1 & 2 & 4 & 8 & 16 & 32 & 64 & 128 & 256
Returns:
the correspondence AFTaskList(each element is an AFTask object).
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFTaskList

getTaskOfRole

java.util.Vector getTaskOfRole(java.lang.String rID)
                               throws WFCIException
Parameters:
rID -
Returns:
Throws:
WFCIException

getTaskOfRole

java.util.Vector getTaskOfRole(java.lang.String rID,
                               int state)
                               throws WFCIException
Parameters:
rID -
state -
Returns:
Throws:
WFCIException

getTaskOfRootTask

AFTaskList getTaskOfRootTask(java.lang.String rootTID)
                             throws WFCIException
Returns tasks of some specific root task.

Examples: 

    var rootTID = "Tsk000000254284";
    var TaskList = WFCI.getTaskOfRootTask(rootTID);
    for (var i=0;i<TaskList.size();i++) {
        var Task=TaskList.get(i);
            returns <dfn>an AFTask Object</dfn>
    }

Parameters:
rootTID - a TaskID.
Returns:
the correspondence AFTaskList.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
AFTaskList

getTicketList

java.util.Map getTicketList(java.lang.String votId)
                            throws WFCIException
Throws:
WFCIException

getTinyPDiagramDetail

java.util.Vector getTinyPDiagramDetail(java.lang.String rootTID,
                                       java.lang.String mID)
                                       throws WFCIException
Returns the detail of process diagram.

Examples: 

    var tID = "Tsk0003459343453";
    var task = WFCI.getTask(tID);
    var rootTID = currTask.getRootID();
    var Result  = WFCI.getPDiagramDetail(rootTID);
    for(var i=0;i<Result.size();j++) {
        var TinyTask = Result.get(i);
            returns <dfn>TinyTask object</dfn>
    }

Parameters:
rootTID - a root TaskID.
mID - a member ID for permission check.
Returns:
the detail information in process diagram.
Throws:
WFCIException
Since:
version 1.2

getTinyQuestionnaireListByCond

java.util.List getTinyQuestionnaireListByCond(com.flowring.questionnaire.entity.QuestionnaireSearchCondition qsc,
                                              java.lang.String memId)
                                              throws WFCIException
Get TinyQuestionnaireList by SQL WHERE condition.

Parameters:
qsc - QuestionnaireSearchCondition(SQL WHERE condition)
memId - a member id.
Returns:
each element is a TinyQuestionnaire object.
Throws:
WFCIException
Since:
version 3.0

getTinyRootTaskIdListOfJoinMember

java.util.List getTinyRootTaskIdListOfJoinMember(java.lang.String mID,
                                                 java.lang.String rootDate,
                                                 java.lang.String rootName,
                                                 java.lang.String rootState)
                                                 throws WFCIException
Returns tasks with some specific member is involved in. The root

Parameters:
mID - a MemberID.
rootDate - a Date.
rootName - a Method.
rootState - a State.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 3.5 AF-2248
See Also:
TinyTask

getTinyRootTaskOfJoinMember

java.util.Vector getTinyRootTaskOfJoinMember(java.lang.String mID)
                                             throws WFCIException
Returns root tasks with some specific member is involved in. The root tasks' state are not complete or dead.

Parameters:
mID - a MemberID.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 1.2
See Also:
TinyTask

getTinyRootTaskOfJoinMember

java.util.Vector getTinyRootTaskOfJoinMember(java.lang.String mID,
                                             java.lang.String proID)
                                             throws WFCIException
Returns root tasks with some specific member is involved in. The root tasks' state are not complete or dead.

Parameters:
mID - a MemberID.
proID - a ProcessID.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 1.2
See Also:
TinyTask

getTinyTaskIdListTracked

java.util.List getTinyTaskIdListTracked(java.lang.String mID,
                                        java.util.Vector idList,
                                        java.lang.String state)
                                        throws WFCIException
Returns all tasks of some specific member.

Parameters:
mID - a MemberID.
idList - a Task-ID list.
state - a State.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 3.5 AF-2248
See Also:
TinyTask

getTinyTaskList

java.util.Vector getTinyTaskList(java.lang.String mID)
                                 throws WFCIException
Returns all tasks of some specific member.

Parameters:
mID - a MemberID.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 1.2
See Also:
TinyTask

getTinyTaskList

java.util.Vector getTinyTaskList(java.lang.String mID,
                                 int sc,
                                 int ec,
                                 java.lang.String order)
                                 throws WFCIException
Returns all tasks of some specific member.

parameter 'order' should be one of the followring :

  • TASK_SORT_PROID
  • TASK_SORT_STATE
  • TASK_SORT_MEMID
  • TASK_SORT_EXEID
  • TASK_SORT_DEPID
  • TASK_SORT_ROLID
  • TASK_SORT_STARTTIME
  • TASK_SORT_ENDTIME
  • TASK_SORT_TYPE
  • TASK_SORT_KEYWORD
  • TASK_SORT_PRIORITY

Parameters:
mID - a MemberID.
sc - start index.
ec - end index.
order - for sorting.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 1.2
See Also:
TinyTask

getTinyTaskList

java.util.Vector getTinyTaskList(java.lang.String mID,
                                 java.util.Vector idList)
                                 throws WFCIException
Returns all tasks of some specific member.

Parameters:
mID - a MemberID.
idList - a Task-ID list.
Returns:
the correspondence vector of TinyTask.
Throws:
WFCIException
Since:
version 1.2
See Also:
TinyTask

getTreeTaskList

java.util.HashMap getTreeTaskList(java.lang.String mID)
                                  throws WFCIException
Returns the project-tasks vector of some specific member.

Parameters:
mID - a MemberID.
Returns:
the result ( [Key:Value] = [PojectID:ProjectTask ).
Throws:
WFCIException
Since:
version 1.1.5
See Also:
ProjectTask

getUnitType

UnitType getUnitType(java.lang.String uid)
                     throws WFCIException
Get the Unit Type with the specified unit id

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

getUnitTypeByLoginID

UnitType getUnitTypeByLoginID(java.lang.String loginId)
                              throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

getUnitTypeByMember

UnitType getUnitTypeByMember(MemberRecord mbr)
                             throws WFCIException
Get the Unit Type with the specified MemberRecord

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

getUnitTypeByMemID

UnitType getUnitTypeByMemID(java.lang.String memId)
                            throws WFCIException
Get the Unit Type with the specified member id

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

getUnitTypeByNo

UnitType getUnitTypeByNo(java.lang.String memNo)
                         throws WFCIException
Get the Unit Type with the specified member No.

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

getUserCalendar

com.flowring.schedule.UserCalendar getUserCalendar(java.lang.String calendarID)
                                                   throws WFCIException
get user calendar by specified calendar id

Parameters:
calendarID -
Returns:
UserCalendar
Throws:
WFCIException
Since:
V3.1

getUserCalendarByUser

com.flowring.schedule.UserCalendar getUserCalendarByUser(java.lang.String id)
                                                         throws WFCIException
get user calendar by specified id, ex:MEMxxx(MainRole), ROLxxx, DEPxxx, COMxxx.

Parameters:
id -
Returns:
UserCalendar
Throws:
WFCIException
Since:
V3.1

getUserCalendarMap

java.util.HashMap getUserCalendarMap(java.lang.String memID)
                                     throws WFCIException
get member's all UserCalendars corresponding to every role;

Parameters:
memID -
Returns:
HashMap calendarMap
Throws:
WFCIException
Since:
V3.1

getVariableList

java.util.Vector getVariableList()
                                 throws WFCIException
Get All Variable

Returns:
Throws:
WFCIException
Since:
version 2.2.5

getVotAdminList

java.util.List getVotAdminList()
                               throws WFCIException
Returns:
Throws:
WFCIException

getVote

com.flowring.onlinevote.entity.Vote getVote(java.lang.String voteId)
                                            throws WFCIException
Parameters:
voteId -
Returns:
Throws:
WFCIException

getVoteList

java.util.List getVoteList()
                           throws WFCIException
Returns:
Throws:
WFCIException

getVoteListByCond

java.util.List getVoteListByCond(java.lang.String cond,
                                 java.lang.String memId,
                                 java.lang.String votingStage)
                                 throws WFCIException
Parameters:
cond -
memId -
votingStage -
Returns:
Throws:
WFCIException

getVoteResult

com.flowring.onlinevote.entity.VoteResult getVoteResult(java.lang.String votId)
                                                        throws WFCIException
Throws:
WFCIException

getVotPermList

java.util.List getVotPermList(java.lang.String votId)
                              throws WFCIException
Parameters:
votId -
Returns:
Throws:
WFCIException

getWeek

int[] getWeek()
              throws WFCIException
get the work days of a week in member's calendar.

Parameters:
memID -
Returns:
int[] weekDays. Each element in the array is integer: 0 is rest day, 1 is half work day and 2 is work day.
Throws:
WFCIException
Since:
version 1.0

getWeek

int[] getWeek(java.lang.String memID)
              throws WFCIException
get the work days of a week in member's calendar.

Parameters:
memID -
Returns:
int[] weekDays. Each element in the array is integer: 0 is rest day, 1 is half work day and 2 is work day.
Throws:
WFCIException
Since:
V3.1

getWorkdays

java.util.Vector getWorkdays()
                             throws WFCIException
get work days in system's default calendar.

Parameters:
String - member id
Returns:
Vector workDayList. Each element is the Vector is Date work day.
Throws:
WFCIException
Since:
version 1.0

getWorkdays

java.util.Vector getWorkdays(java.lang.String memID)
                             throws WFCIException
get work days in member's calendar.

Parameters:
String - member id
Returns:
Vector workDayList. Each element is the Vector is Date work day.
Throws:
WFCIException
Since:
V3.1

goBackTo

boolean goBackTo(java.lang.String fromTaskID,
                 java.lang.String toProID,
                 boolean artMode)
                 throws WFCIException
Go back to a former task node in the same process.

Examples: 

 var fromTaskID = "Tsk000000226229";

 var toProID = "PRO00440363552012";

 var Result = WFCI.goBackTo(fromTaskID, toProID, true);

Parameters:
fromTaskID - a Task ID.
toProID - a ProcessID.
artMode - true if a new artifact is used.
Returns:
true if succeeded; false otherwise.
Throws:
WFCIException

goBackTo

boolean goBackTo(java.lang.String fromTaskID,
                 Task toTask,
                 boolean artMode)
                 throws WFCIException
Go back to a former task node in the same process.

Examples: 

 var fromTaskID = "Tsk000000226229";

 var toTask = WFCI.getTask("Tsk0001134355209");

 var Result = WFCI.goBackTo(fromTaskID, toTask, true);

Parameters:
fromTaskID - a TaskID.
toTask - a previous Task.
artMode - true if a new artifact is used.
Returns:
true if succeeded; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5

goBackTo

boolean goBackTo(java.lang.String fromTaskID,
                 Task toTask,
                 boolean artMode,
                 boolean isEmailNotify)
                 throws WFCIException
Go back to a former task node in the same process.

Examples: 

   var fromTaskID = "Tsk000000226229";
   var toTask = WFCI.getTask("Tsk0001134355209");
   var Result = WFCI.goBackTo(fromTaskID, toTask, true);

Parameters:
fromTaskID - a TaskID.
toTask - a previous Task.
artMode - true if a new artifact is used.
isEmailNotify - true if asking to sand email notification.
Returns:
true if succeeded; false otherwise.
Throws:
WFCIException
Since:
version 2.4.0 hotfix webagenda_54.32

goBackTo

boolean goBackTo(Task fromTask,
                 java.lang.String toProID,
                 boolean artMode)
                 throws WFCIException
Go back to a former task node in the same process.

Examples: 

 var fromTask = WFCI.getTask("Tsk000000226229");

 var toProID = "PRO00440363552012";

 var Result = WFCI.goBackTo(fromTask, toProID, true);

Parameters:
fromTask - a Task.
toProID - a ProcessID.
artMode - true if a new artifact is used.
Returns:
true if succeeded; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5

goBackToWithDetailRet

java.util.HashMap goBackToWithDetailRet(Task fromTask,
                                        java.lang.String toProID,
                                        boolean artMode)
                                        throws WFCIException
Parameters:
fromTask - a Task.
toProID - a ProcessID.
artMode - true if a new artifact is used.
Returns:
true if succeeded.
Throws:
WFCIException

increaseQuestionnaireViews

boolean increaseQuestionnaireViews(java.lang.String qneId)
                                   throws WFCIException
The implement method should increase views count when user click or read a specified questionnaire.

Parameters:
qneId - a questionnaire id.
Returns:
true if update success; false otherwise.
Throws:
WFCIException
Since:
version 3.0

initAgenda

java.util.HashMap initAgenda(java.lang.String user)
                             throws WFCIException
Initialize user's personal Agenda, return essential data. 
    HashMap ret = wfci.initAgenda("MEM21054352116633"); // Use Member ID to retrieve Agenda data
    Vector processList = (Vector)ret.get("processlist")  // Get the process list that can be initialized by the member
    Vector msgList = (Vector)ret.get("msglist"); // Get the message list that the member have received
    Vector boardList = (Vector)ret.get("boardlist"); // Get all boards
    Vector stafflist = (Vector)ret.get("stafflist"); // Get sub-member list for the member
    HashMap proInfo = (HashMap)ret.get("productInfo"); // Get the product information

Parameters:
user - a username
Returns:
the user's the content of Agenda
Throws:
WFCIException
Since:
version 1.0.0

initHoliday

void initHoliday()
                 throws WFCIException
Initialize holidays.

Throws:
WFCIException
Since:
version 1.0

initProcess

java.util.HashMap initProcess(java.lang.String user,
                              PASEProcess process)
                              throws WFCIException
Initial the process.

Examples: 

    var loginID = john;
    var pID = "PRO0549992486182610";
    var paseProcess = new pe.pase.PASEProcess(pID);
    var hashmap = WFCI.initProcess(loginID, paseProcess);
    var rootTaskID = hashmap.get("rootTaskID");
        returns <dfn>root TaskID</dfn> is like "Tsk000000263264"
    var retValue = hashmap.get("retValue");
        returns <dfn>true if it gets successfully;false otherwise</dfn>

Parameters:
user - a Username.
process - a Process.
Returns:
the result ( [Key:Value] = [rootTaskID:rootTaskID] ; [retValue:Boolean(true/false)]).
Throws:
WFCIException
Since:
version 1.0.0

initProcess

java.util.HashMap initProcess(java.lang.String user,
                              java.lang.String roleID,
                              java.lang.String depID,
                              java.lang.String processID,
                              java.lang.String processName,
                              java.lang.String subject,
                              int priority)
                              throws WFCIException
Initial the process.

Examples: 

    var loginID = john
    var rID = "ROL0033004134576";
    var dID = "DEP00231111007865";
    var pID = "PRO0549992486182610";
    var pName = "New Process";
    var subject = "testing initProcess";
    var priority = pe.pase.Task.PRIORITY_HIGHEST;
    var hashmap = WFCI.initProcess(loginID, rID, dID, pID, pName, subject, priority);
    var rootTaskID = hashmap.get("rootTaskID");
        returns <dfn>root TaskID</dfn> is like "Tsk000000263264"
    var retValue = hashmap.get("retValue");
        returns <dfn>true if it gets successfully;false otherwise</dfn>

Parameters:
user - a Username.
roleID - a RoleID.
depID - a DepartmentID.
processID - a ProcessID.
processName - a PoleName.
subject - a Subject.
priority - a Priority,
    priority value:
  • PRIORITY_HIGHEST = 0;
  • PRIORITY_HIGH = 1;
  • PRIORITY_NORMAL = 2;
Returns:
the result ( [Key:Value] = [rootTaskID:rootTaskID] ; [retValue:Boolean(true/false)]).
Throws:
WFCIException
Since:
version 1.0.0

insertActivity

boolean insertActivity(com.flowring.onlineregister.entity.Activity act)
                       throws WFCIException
Parameters:
act -
Returns:
Throws:
WFCIException

insertActivityPerm

boolean insertActivityPerm(java.lang.String aId,
                           java.lang.String memId)
                           throws WFCIException
Parameters:
aId -
memId -
Returns:
Throws:
WFCIException

insertAeppServerOfMultiOrg

boolean insertAeppServerOfMultiOrg(com.flowring.aeppServer.AeppServer aeppServer)
                                   throws WFCIException
Insert a AEPP Server.

Parameters:
AeppServer - bean object.
Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

insertBoardAdmin

boolean insertBoardAdmin(java.lang.String memId)
                         throws WFCIException
Throws:
WFCIException

insertBoardPerm

boolean insertBoardPerm(java.lang.String messageId,
                        java.lang.String memId)
                        throws WFCIException
Throws:
WFCIException

insertDashboard

boolean insertDashboard(com.flowring.dashboard.Dashboard dboard)
                        throws WFCIException

Adds a Dashboard only.

NOTE: It will not insert its style list, using insertDashboardStyle(DashboardStyle) to insert its style.

Parameters:
dboard - a Dashboard object.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException
See Also:
Dashboard

insertDashboardStyle

boolean insertDashboardStyle(com.flowring.dashboard.DashboardStyle dstyle)
                             throws WFCIException
Adds a DashboardStyle into table.

Parameters:
dstyle - a DashboardStyle object.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException
See Also:
DashboardStyle

insertMbrSignGroup

boolean insertMbrSignGroup(java.lang.String mbrId,
                           AFGroup group)
                           throws WFCIException
Parameters:
mbrId -
group -
Returns:
Throws:
WFCIException

insertMultiOrgPerm

boolean insertMultiOrgPerm(java.lang.String memId)
                           throws WFCIException
Insert a user who is permitted to use multiorg with specified member ID.

Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

insertOption

boolean insertOption(com.flowring.questionnaire.entity.Option opt)
                     throws WFCIException
The implement method should insert datas into database by the given option object.

Parameters:
opt - a Option object.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException

insertPASEGroup

void insertPASEGroup(PASEGroup group)
                     throws WFCIException
Parameters:
group -
Throws:
WFCIException

insertPASESharedFile

void insertPASESharedFile(PASESharedFile sFile)
                          throws WFCIException
Parameters:
sFile -
Throws:
WFCIException

insertPersonalDboard

boolean insertPersonalDboard(java.lang.String dboardId,
                             PersonalConfig pConfig)
                             throws WFCIException
Throws:
WFCIException

insertPersonalFavorite

boolean insertPersonalFavorite(java.util.Vector vec,
                               PersonalConfig pConfig)
                               throws WFCIException
Throws:
WFCIException

insertPersonalProShow

boolean insertPersonalProShow(java.lang.String memberId,
                              java.lang.String showType,
                              java.lang.String variety)
                              throws WFCIException
Throws:
WFCIException

insertProcessMapCategory

boolean insertProcessMapCategory(Category category)
                                 throws WFCIException
Insert a new ProcessMap Category.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

insertProcessMapLink

boolean insertProcessMapLink(Link link)
                             throws WFCIException
Insert a new ProcessMap Link.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

insertQuestionnaire

boolean insertQuestionnaire(com.flowring.questionnaire.entity.Questionnaire q)
                            throws WFCIException
The implement method should insert datas into database by the given questionnaire object.

Parameters:
qne - a Questionnaire object.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException

insertQuestionnaireAdmin

boolean insertQuestionnaireAdmin(java.lang.String memId)
                                 throws WFCIException
The implement method should insert datas into database by the given member id.

Parameters:
memId - a member id.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException

insertQuestionnairePerm

boolean insertQuestionnairePerm(java.lang.String qneId,
                                java.lang.String memId)
                                throws WFCIException
The implement method should insert datas into database by the given parameters.

Parameters:
qneId - a questionnaire id.
memId - a member id.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException

insertQuestionnaireResult

boolean insertQuestionnaireResult(com.flowring.questionnaire.entity.QuestionnaireResult qneResult)
                                  throws WFCIException
The implement method should insert datas into database by the given QuestionnaireResult object.

Parameters:
qneResult - a QuestionnaireResult object.
Returns:
true if insert success; false otherwise.
Throws:
WFCIException

insertRegAdmin

boolean insertRegAdmin(java.lang.String mbrId)
                       throws WFCIException
Parameters:
mbrId -
Returns:
Throws:
WFCIException

insertScheduleEvent

void insertScheduleEvent(ScheduleEvent evt)
                         throws WFCIException
Insert ScheduleEvent into table.

Parameters:
evt - insert event into table.
Throws:
WFCIException

insertTaskAttachedFile

boolean insertTaskAttachedFile(TaskAttachedFileInfo fileInfo)
                               throws WFCIException
Parameters:
fileInfo -
Returns:
Throws:
WFCIException

insertTaskGroupSign

boolean insertTaskGroupSign(java.lang.String taskID,
                            java.lang.String groupSignID,
                            long signTime)
                            throws WFCIException
This method is used for insert into Task_GroupSign. The tasks completed by GroupSign will be set the same id which means these tasks are completed by the same user and at the same time.

Parameters:
taskID - String the task ID
groupSignID - String the group sign ID generated by system
signTime - long the complete time
Throws:
WFCIException
Since:
V2.4

insertVotAdmin

boolean insertVotAdmin(java.lang.String memId)
                       throws WFCIException
Parameters:
memId -
Returns:
Throws:
WFCIException

insertVote

boolean insertVote(com.flowring.onlinevote.entity.Vote vote)
                   throws WFCIException
Parameters:
vote -
Returns:
Throws:
WFCIException

insertVoteOpt

boolean insertVoteOpt(com.flowring.onlinevote.entity.VoteOpt voteOpt)
                      throws WFCIException
Parameters:
voteOpt -
Returns:
Throws:
WFCIException

insertVotPerm

boolean insertVotPerm(java.lang.String votId,
                      java.lang.String memId)
                      throws WFCIException
Parameters:
votId -
memId -
Returns:
Throws:
WFCIException

isAlreadyVote

boolean isAlreadyVote(java.lang.String votId,
                      java.lang.String memID)
                      throws WFCIException
Parameters:
votId -
memID -
Returns:
Throws:
WFCIException

isCompanyManager

boolean isCompanyManager(MemberRecord mbr)
                         throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

isCompanyManagerByID

boolean isCompanyManagerByID(java.lang.String memId)
                             throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

isCompanyManagerByLoginID

boolean isCompanyManagerByLoginID(java.lang.String loginId)
                                  throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

isCompanyManagerByNo

boolean isCompanyManagerByNo(java.lang.String memNo)
                             throws WFCIException
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
Throws:
WFCIException
Since:
version 2.2.5

isContainedInPASEGroup

boolean isContainedInPASEGroup(java.lang.String gId,
                               java.lang.String mID)
                               throws WFCIException
Parameters:
gId -
mID -
Returns:
Throws:
WFCIException

isDashboardExist

boolean isDashboardExist(java.lang.String prjId,
                         java.lang.String proId,
                         java.lang.String grpId)
                         throws WFCIException
Test dashboard exist or not by the given value.

Parameters:
prjId - a project id.
proId - a process id.
grpId - a group id.
Returns:
true if dashboard is exist; false otherwise.
Throws:
WFCIException
See Also:
Project, DBProcess, PASEGroup

isDashboardStyleSiblingOrderExist

boolean isDashboardStyleSiblingOrderExist(java.lang.String boardId,
                                          int siblingOrder)
                                          throws WFCIException
Tests whether the dashboard style's SiblingOrder exist or not.

Parameters:
boardId - a dashboard id.
siblingOrder - a dashboard style's sibling order for view.
Returns:
true if exist; false otherwise.
Throws:
WFCIException

isEnabledModule

boolean isEnabledModule(java.lang.String moduleName)
                        throws WFCIException
Returnss the flag indicates whether a module is enabled. The module name is defined in ModuleNameConstant class.

Parameters:
modueName - the module name to be checked.
Throws:
WFCIException

isHalfHoliday

boolean isHalfHoliday(java.lang.String date)
                      throws WFCIException
Check specified date whether it's a half of holiday or not.

Examples: 

    var sDate = "2001/06/17";
    var Result = WFCI.isHalfHoliday(sDate);
        returns <dfn>true if it's a half of holiday;false otherwise</dfn>

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

isHalfHoliday

boolean isHalfHoliday(java.lang.String date,
                      java.lang.String memID)
                      throws WFCIException
Check if the date is half-holiday in user's calendar.

Parameters:
date - the given date string
memID - the given member id string
Returns:
true if confirmed.
Throws:
WFCIException
Since:
V3.1

isHoliday

boolean isHoliday(java.lang.String date)
                  throws WFCIException
Check specified date whether it's a holiday or not.

Examples: 

    var sDate = "2001/06/17";
    var Result = WFCI.isHoliday(sDate);
        returns <dfn>true if it's a holiday;false otherwise</dfn>

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

isHoliday

boolean isHoliday(java.lang.String date,
                  java.lang.String memID)
                  throws WFCIException
Check if the date is holiday.

Parameters:
date - the given date string
memID - the given member id string
Returns:
true if confirmed.
Throws:
WFCIException
Since:
V3.1

isLockedTask

boolean isLockedTask(java.lang.String tskID)
                     throws WFCIException
Check the task locking state.

Parameters:
tskID - a TaskID.
Returns:
true for locked.
Throws:
WFCIException
Since:
version 1.1.5

isLogined

boolean isLogined(java.lang.String loginID)
                  throws WFCIException
Check specified user is logined or not.

Examples: 

    wfci.isLogined("loginname");
        returns <dfn>true if user is logined;false otherwise</dfn>

Parameters:
loginID -
Returns:
true if user is logined; false otherwise.
Throws:
WFCIException
Since:
version 2.2.3.4

isMemberAllowReadCensus

boolean isMemberAllowReadCensus(java.lang.String memId,
                                java.lang.String qneId)
The implement method should test the given member has the authorization to read or view the specified questionniare census.

Parameters:
memId - a member id.
qneId - a questionnaire id.
Returns:
true if the given member can read the census; false otherwise.
Since:
Agentflow 3.0

isQuestionnaireAdmin

boolean isQuestionnaireAdmin(java.lang.String memId)
                             throws WFCIException
The implement method should test the given member is a manager in Questionnaire module.

Parameters:
memId - a member id.
Returns:
true if the member is a manager in Questionnaire module; false otherwise.
Throws:
WFCIException

isRegAdmin

boolean isRegAdmin(java.lang.String mbrId)
                   throws WFCIException
Parameters:
mbrId -
Returns:
Throws:
WFCIException

isRegisterActivity

boolean isRegisterActivity(com.flowring.onlineregister.entity.Activity act,
                           java.lang.String mbrId)
                           throws WFCIException
Parameters:
act -
mbrId -
Returns:
Throws:
WFCIException

isRestSat

boolean isRestSat(java.lang.String date)
                  throws WFCIException
Check specified date whether it's a rest Saturday or not.

Examples: 

    var sDate = "2001/06/17";
    var Result = WFCI.isRestSat(sDate);
        returns <dfn>true if it's rest Saturday;false otherwise</dfn>

Parameters:
date - a Date format String.
Returns:
true if the date is rest Saturday; false otherwise.
Throws:
WFCIException
Since:
version 1.0.0

isServerConnecting

boolean isServerConnecting()
Check if wfci is connecting with the server.

Returns:
true if connecting; false otherwise.
Since:
version 1.1.6

isServiceAlive

boolean isServiceAlive()
                       throws WFCIException
check the services in wfci are are available, if you clear the cache of AEPP, the new wfci will be constructed, and old one will be invalid, so the services are unavailable.

Returns:
true if services are alive; false otherwise.
Throws:
WFCIException

isSupervisor

boolean isSupervisor(java.lang.String memID)
                     throws WFCIException
To check the member is Supervisor or not.

Parameters:
memID -
Returns:
true if the member is supervisor; false otherwise.
Throws:
WFCIException
Since:
V3.1

isUnitExistUserWorkingDay

boolean isUnitExistUserWorkingDay(java.lang.String id,
                                  java.lang.String calendarID)
check the unit has been set calendar or not

Parameters:
id -
calendarID -
Returns:
true if the unit has been set calendar; else false.

isVotAdmin

boolean isVotAdmin(java.lang.String memId)
                   throws WFCIException
Parameters:
memId -
Returns:
Throws:
WFCIException

isWorkday

boolean isWorkday(java.lang.String date,
                  java.lang.String memID)
                  throws WFCIException
Check if the date is workday in user's calendar.

Parameters:
date - the given date string
memID - the given member id string
Returns:
true if confirmed.
Throws:
WFCIException
Since:
V3.1

loadValueWithAFDBConnection

java.util.Vector loadValueWithAFDBConnection(java.lang.String session,
                                             java.lang.String sqlcmd)
                                             throws WFCIException
Invoke the connection to load value.

Parameters:
session - the session connection key
sqlcmd - the SQL statement to load data
Returns:
the correspondence data(each element in Vector are instance of ResultTable).
Throws:
WFCIException
See Also:
ResultTable

lockTask

void lockTask(java.lang.String tskID)
              throws WFCIException
Lock the root task of the task.

Examples: 

 var taskID = "Tsk000000226229";
 WFCI.lockTask(taskID);

Parameters:
tskID - a TaskID.
Throws:
WFCIException
Since:
version 1.1.5

login

java.util.HashMap login(java.lang.String user,
                        java.lang.String pass)
                        throws WFCIException
User login the PASE server. 
 HashMap ret = wfci.login("loginname", "password");

 boolean accepted = ((Boolean) ret.get("retValue")).booleanValue(); // Check if the login is accepted

 String reason = (String) ret.get("reason"); // If login rejected, get the reason

 MemberRecord member = (String) ret.get("MemberRecord"); // If login accepted, get the member

Parameters:
user - a username.
pass - a password.
Returns:
a user info.
Throws:
WFCIException
Since:
version 1.0.0

login

java.util.Map login(java.lang.String loginID,
                    java.lang.String pass,
                    boolean toCheckDup)
                    throws WFCIException
To authenticate users (it doesn't register).

Parameters:
loginID -
pass - client user password; it should be MD5-encrypted if AFDB authentication is used; otherwise it should be clear-text.
toCheckDup - whether this funtion should deny duplicate login (already registered users)
Returns:
a Map. key/value are described as follows (key-name:value-type, description) "retValue":Boolean, true if the task start successfully, false otherwise. "reason":String, µn¤J¥¢±Ñªº­ì¦]. multi:Boolean(), true multi-login
Throws:
WFCIException

logout

void logout(java.lang.String loginID)
            throws WFCIException
User logout the PASE server. 
 wfci.logout("loginname");

Parameters:
loginID -
Throws:
WFCIException
Since:
version 1.0.0

mustReassignDeputiedTask

boolean mustReassignDeputiedTask(java.lang.String memID)
                                 throws WFCIException
Parameters:
memID -
Returns:
Throws:
WFCIException

newActivity

com.flowring.onlineregister.entity.Activity newActivity()
                                                        throws WFCIException
Throws:
WFCIException

newBBSBoard

boolean newBBSBoard(BBSBoard bbsBoard)
                    throws WFCIException
New a bbs board in db with a new board object.

Parameters:
bbsBoard - a BBSBoard.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

newDashboard

com.flowring.dashboard.Dashboard newDashboard()
                                              throws WFCIException
Create a new Dashboard with a new system id which get from System.

Returns:
a new Dashboard object.
Throws:
WFCIException

newDashboardStyle

com.flowring.dashboard.DashboardStyle newDashboardStyle(java.lang.String boardId)
                                                        throws WFCIException
Create a new DashboardStyle with a new system id which get from System.

Parameters:
boardId - a Dashboard id.
Returns:
a new DashboardsStyle object.
Throws:
WFCIException

newOption

com.flowring.questionnaire.entity.Option newOption()
                                                   throws WFCIException
The implement method must provide a new Option object.

Returns:
a new Option object.
Throws:
WFCIException

newOptionTemplate

com.flowring.questionnaire.entity.Option newOptionTemplate()
                                                           throws WFCIException
The implement method should create a Option Template.

Returns:
a Option object.
Throws:
WFCIException
Since:
version 3.0

newQuestion

com.flowring.questionnaire.entity.Question newQuestion()
                                                       throws WFCIException
The implement method must provide a new Question object.

Returns:
a new Question object.
Throws:
WFCIException

newQuestionnaire

com.flowring.questionnaire.entity.Questionnaire newQuestionnaire()
                                                                 throws WFCIException
The implement method must provide a new Questionnaire object.

Returns:
a new Questionnaire object.
Throws:
WFCIException

newQuestionnaireResult

com.flowring.questionnaire.entity.QuestionnaireResult newQuestionnaireResult()
                                                                             throws WFCIException
The implement method must provide a new QuestionnaireResult object.

Returns:
a new QuestionnaireResult object.
Throws:
WFCIException

newVote

com.flowring.onlinevote.entity.Vote newVote()
                                            throws WFCIException
Returns:
Throws:
WFCIException

newVoteOpt

com.flowring.onlinevote.entity.VoteOpt newVoteOpt()
                                                  throws WFCIException
Returns:
Throws:
WFCIException

notifyTask

java.util.HashMap notifyTask(java.lang.String tskID)
                             throws WFCIException
Remove be state of waiting of the task.

Examples: 

    var taskID = "Tsk000000226229";
    var hashmap = WFCI.notifyTask(task);
    var retValue = hashmap.get("retValue");
        returns <dfn>true if it starts successfully;false otherwise</dfn>

Parameters:
tskID - a TaskID.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true)] ).
Throws:
WFCIException
Since:
version 1.1.5

pickQueueTask

boolean pickQueueTask(Task t)
                      throws WFCIException
Pick the queue of the task.

Examples: 

 var taskID = "Tsk000000226229";
 var task = WFCI.getTask(taskID);
 WFCI.pcikQueueTask(task);

Parameters:
t - a Task.
Throws:
WFCIException
Since:
version 1.0.1

postBBSMsg

boolean postBBSMsg(BBSMessage msg)
                   throws WFCIException
Post a bbs message in db with a new message object.

Parameters:
msg - a BBSMessage.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

reassignDeputyTask

void reassignDeputyTask(java.lang.String loginID)
                        throws WFCIException
Throws:
WFCIException

reflushProcessManager

boolean reflushProcessManager()
                              throws WFCIException
Throws:
WFCIException

registerActivity

boolean registerActivity(com.flowring.onlineregister.entity.Activity act,
                         java.lang.String mbrId)
                         throws WFCIException
Parameters:
act -
mbrId -
Returns:
Throws:
WFCIException

registerClient

boolean registerClient(java.lang.String loginID)
                       throws WFCIException
Register a Client.

Parameters:
loginID -
Returns:
true if succeeded.
Throws:
WFCIException
Since:
version 1.1.0

registerClient

void registerClient(java.lang.String loginID,
                    ClientRMI client)
                    throws WFCIException
Register user's client in the PASE server.

Parameters:
loginID -
client - a ClientRMI.
Throws:
WFCIException
Since:
version 1.0.0

removeScheduleEvent

void removeScheduleEvent(java.lang.String id)
                         throws WFCIException
remove ScheduleEvent by event id.

Parameters:
id - event id.
Throws:
WFCIException

removeTaskByAdm

boolean removeTaskByAdm(java.lang.String p_TaskID)
                        throws WFCIException
Force to remove task.

Examples: 

    var taskID = "Tsk000000226229";
    var Result = WFCI.removeTaskByAdm(taskID);
        returns <dfn>true if it sets successfully; false otherwise</dfn>

Parameters:
p_TaskID - a RootTaskID.
Returns:
true if succeeded.
Throws:
WFCIException
Since:
version 1.0.1

removeTaskByUser

boolean removeTaskByUser(java.lang.String p_RootTaskID,
                         java.lang.String p_MemID)
                         throws WFCIException
Force to remove task by the specific member.

Examples: 

    var taskID = "Tsk000000226229";
    var memID = "MEM0000000334532";
    var Result = WFCI.removeTaskByAdm(taskID, memID);
        returns <dfn>true if it sets successfully; false otherwise</dfn>

Parameters:
p_RootTaskID - a RootTaskID.
p_MemID - a MemberRecordID.
Returns:
true if succeeded.
Throws:
WFCIException
Since:
version 1.0.1

reScheduleTask

void reScheduleTask(Task task)
                    throws WFCIException
Throws:
WFCIException

resetDeputyAndDeputyState

boolean resetDeputyAndDeputyState(java.lang.String p_MyMemID,
                                  java.lang.String p_DeputyMemID,
                                  boolean p_DeputyState)
                                  throws WFCIException
Refresh deputy data in cache.

Parameters:
p_MyMemID - a MemberRecord ID.
p_DeputyMemID - a Deputy MemberRecord ID.
p_DeputyState - check if deputy state is activated.
Returns:
true if successful; false otherwise.
Throws:
WFCIException

resetMemberDelegation

boolean resetMemberDelegation(MemberRecord mRecord)
                              throws WFCIException
Parameters:
mRecord -
Returns:
Throws:
WFCIException

rollbackAFDBConnection

void rollbackAFDBConnection(java.lang.String session)
                            throws WFCIException
Make rollback in the connection.

Parameters:
session - the session connection key.
Throws:
WFCIException

saveSchedule

void saveSchedule(java.util.Vector hdays,
                  java.util.Vector h_days,
                  java.util.Vector wdays,
                  int[] w)
                  throws WFCIException
Save server's schedule.

Parameters:
hdays - the Vector of holidays date.
h_days - the Vector of half-holidays date.
wdays - the Vector of workdays date.
w - the array of weeks integer.
Throws:
WFCIException
Since:
version 1.0

searchData

java.util.Vector searchData(SearchCondition cond)
                            throws WFCIException
Gets searched result by using given conditions. The pairs of condition and Returnsed entity:
  • ArtifactSearchCondition - String(ArtifactInstanceID)
  • TaskSearchCondition - Task
  • RoughTaskSearchCondition - TaskSearchEntity
  • ComputeSearchCondition - SearchComputeItem(specified item, calculated number)

Parameters:
cond - a SearchCondition.
Returns:
a vector which entities depend on given condition type.
Throws:
WFCIException
Since:
version 1.1

searchDataCount

int searchDataCount(SearchCondition cond)
                    throws WFCIException
Gets searched number by using given conditions. The condition choices are:
  • TaskSearchCondition
  • RoughTaskSearchCondition
  • ComputeSearchCondition

Parameters:
cond - a SearchCondition.
Returns:
the number have found.
Throws:
WFCIException
Since:
version 1.1

searchScheduleEvent

java.util.Vector searchScheduleEvent(ScheduleSearchCondition cond)
                                     throws WFCIException
search ScheduleEvent by condition search.

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

sendHTMLMail

void sendHTMLMail(java.lang.String from,
                  java.lang.String to,
                  java.lang.String subject,
                  java.lang.String text)
                  throws WFCIException
Parameters:
from -
to -
subject -
text -
Throws:
WFCIException

sendHTMLMail

void sendHTMLMail(java.lang.String from,
                  java.lang.String to,
                  java.lang.String cc,
                  java.lang.String subject,
                  java.lang.String text)
                  throws WFCIException
Parameters:
from -
to -
cc -
subject -
text -
Throws:
WFCIException

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)
                  throws WFCIException
Parameters:
from -
to -
cc -
subject -
text -
fileList -
Throws:
WFCIException

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)
                     throws WFCIException
Send E-Mail through internet.

Examples: 

 var CurrMember = WFCI.getMember(MyTask.getMemberID());
 var FrontMember = WFCI.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. $taskID"; // Mail Content
 var fileList = new java.util.Vector();
 fileList.add("c:\test.jpg");
 WFCI.sendHTMLMailExt(from, to, cc, subject, text, fileList, MyTask.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.
task - the designated task to execute.
Throws:
WFCIException
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)
                     throws WFCIException
Send E-Mail through internet, using HTML format.

Parameters:
from -
to -
cc -
subject -
text -
fileList -
task -
Throws:
WFCIException

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)
                     throws WFCIException
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.
Throws:
WFCIException
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)
              throws WFCIException
Send E-Mail through internet.

Examples: 

 var mID = "MEM0000992492169920";
 var CurrMember = WFCI.getMember(mID);
 var FrontMember = WFCI.getMember(MyTask.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
 WFCI.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.
Throws:
WFCIException
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)
              throws WFCIException
Parameters:
from -
to -
cc -
subject -
text -
Throws:
WFCIException

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)
              throws WFCIException
Throws:
WFCIException

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)
                 throws WFCIException
Parameters:
from -
to -
cc -
subject -
text -
fileList -
tskID -
Throws:
WFCIException

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)
                 throws WFCIException
Parameters:
from -
to -
cc -
subject -
text -
fileList -
task -
Throws:
WFCIException

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)
                 throws WFCIException
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.
Throws:
WFCIException
Since:
version 2.2.3.6

sendPASEMessage

boolean sendPASEMessage(PASEMessage msg)
                        throws WFCIException
Send message through message-system built in Agentflow.

Examples: 

    var mID = "MEM0000992492169920";
    var CurrMember = WFCI.getMember(mID);
    var fmID = "MEM0000992492169911";
    var FrontMember= WFCI.getMember(fmID);
    var msg = new 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 = WFCI.sendPASEMessage(msg);
        returns <dfn>true if it's successful;false otherwise</dfn>

Parameters:
msg - the deliverable message.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
PASEMessage

sendShortMessageToAdminAll

void sendShortMessageToAdminAll(java.lang.String msg,
                                java.lang.String fromMemID)
                                throws WFCIException
Sends a message from a specific member to all on-line members on Admin.

Parameters:
msg - the sent message context.
fromMemID - the MemberRecordID which sends message.
Throws:
WFCIException

sendShortMessageToAdminUser

void sendShortMessageToAdminUser(java.lang.String msg,
                                 java.lang.String fromMemID,
                                 java.lang.String toMemID)
                                 throws WFCIException
Send a message from a specific member to another specific member on Admin.

Parameters:
msg - the sent message context.
fromMemID - the MemberRecordID which sends message.
toMemID - the MemberRecordID which receives message.
Throws:
WFCIException

sendShortMessageToAll

void sendShortMessageToAll(java.lang.String msg,
                           java.lang.String fromMemID)
                           throws WFCIException
Send a message from a specific member to all on-line members on Agenda.

Parameters:
msg - the sent message context.
fromMemID - the MemberRecordID which sends message.
Throws:
WFCIException

sendShortMessageToUser

void sendShortMessageToUser(java.lang.String msg,
                            java.lang.String fromMemID,
                            java.lang.String toMemID)
                            throws WFCIException
Send a message from a specific member to another specific member on Agenda.

Parameters:
msg - the sent message context.
fromMemID - the MemberRecordID which sends message.
toMemID - the MemberRecordID which receives message.
Throws:
WFCIException

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)
                      throws WFCIException
Send E-Mail Template through internet, using HTML format.

Examples: 

 var CurrMember = WFCI.getMember(MyTask.getMemberID());
 var FrontMember = WFCI.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");
 WFCI.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.
Throws:
WFCIException
Since:
version 2.2.0

setAFConnection

void setAFConnection(AFConnection afConn)
Sets AFConnection, store the connection between wfci and server.

setArtInsState

boolean setArtInsState(PASEartInstance artInstance,
                       java.lang.String stateID)
                       throws WFCIException
Returns true for success, else false.

Examples: 

    var iID = "ART0099992486182440";
    var artInstance = WFCI.getArtInstance(tID);
    var stateID = "AST0371992486182500";
    var Result  = WFCI.setArtInsState(artInstance, stateID);
        returns <dfn>true if it sets successfully; false otherwise</dfn>

Parameters:
artInstance - an ArtifactInstance.
stateID - for ArtStateID.
Returns:
true for success, else false.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
PASEartInstance

setCompanyAnnouncementBoard

boolean setCompanyAnnouncementBoard(java.util.Map companyAnnouncementBoardMap)
                                    throws WFCIException
set the map of every company's announce board

Parameters:
MapcompanyAnnouncementBoardMap, - [Key:String company id, Value:pe.pase.BBSBoard board]
Returns:
true if success; false otherwise.
Throws:
WFCIException
Since:
V3.1

setGlobals

void setGlobals(java.lang.String rootTaskID,
                java.util.HashMap args)
                throws WFCIException
Keep data into database and then reuse.

Examples: 

 var rootTaskID = "Tsk0003459343453";
 var ht = new java.util.HashMap();
 ht.put("ItemName", "Pen");
 WFCI.setGlobals(rootTaskID, ht);

Parameters:
rootTaskID - a root TaskID.
args - a HashMap data ( [Key:Value] = [retValue:Boolean(true/false)]).
Throws:
WFCIException
Since:
version 1.1.5

setMemberAccess

boolean setMemberAccess(java.lang.String mID,
                        AccessMember access)
                        throws WFCIException
Sets the access config of Agenda for the specific member.

Parameters:
mID - a MemberRecordID.
access - an AccessMember.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessMember

setMemberAdminAccess

boolean setMemberAdminAccess(java.lang.String mID,
                             AccessAdmin access)
                             throws WFCIException
Sets the access config of Admin for the specific member.

Parameters:
mID - a MemberRecordID.
access - an AccessAdmin.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessAdmin

setMemberArtifactAccess

boolean setMemberArtifactAccess(java.lang.String mID,
                                java.util.Vector artifactAccessList)
                                throws WFCIException
Sets the access config list of Agenda's function "artifact search" for the specific member.

Parameters:
mID - a MemberRecordID.
taskAccessList - an AccessArtifact list.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessArtifact

setMemberOnLineAccess

boolean setMemberOnLineAccess(java.lang.String mID,
                              AccessOnLineUser access)
                              throws WFCIException
Sets the access config of Agenda's function "on-line user" for the specific member.

Parameters:
mID - a MemberRecordID.
access - an AccessOnLineUser.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessOnLineUser

setMemberTaskAccess

boolean setMemberTaskAccess(java.lang.String mID,
                            java.util.Vector taskAccessList)
                            throws WFCIException
Sets the access config list of Agenda's function "task search" for the specific member.

Parameters:
mID - a MemberRecordID.
taskAccessList - an AccessTask list.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4
See Also:
AccessTask

setMonitorRelation

boolean setMonitorRelation(java.lang.String sourceTaskID,
                           java.lang.String createdRootTaskID)
                           throws WFCIException
Parameters:
sourceTaskID -
createdRootTaskID -
Returns:
Throws:
WFCIException

setMonitorRelation

boolean setMonitorRelation(java.lang.String sourceTaskID,
                           java.util.Vector createdRootTaskIDs)
                           throws WFCIException
Parameters:
sourceTaskID -
createdRootTaskIDs -
Returns:
Throws:
WFCIException

setPersonalConfig

void setPersonalConfig(PersonalConfig config)
                       throws WFCIException
Throws:
WFCIException

shutdownServer

boolean shutdownServer()
                       throws WFCIException
Stop server.

Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4

SQLdeleteValue

boolean SQLdeleteValue(java.lang.String sql)
                       throws WFCIException
The method is used to delete value from database (the RTRepository).

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

SQLinsertValue

boolean SQLinsertValue(java.lang.String sql)
                       throws WFCIException
The method is used to insert value to database (the RTRepository).

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

SQLloadValue

java.util.Vector SQLloadValue(java.lang.String sql)
                              throws WFCIException
The method is used to load value from database (the RTRepository).

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

SQLupdateValue

boolean SQLupdateValue(java.lang.String sql)
                       throws WFCIException
The method is used to update value to database (the RTRepository).

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

startServer

boolean startServer()
                    throws WFCIException
Start server.

Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException
Since:
version 1.1.5p4

startTask

java.util.HashMap startTask(Task t)
                            throws WFCIException
Start the task.

Examples: 

    var taskID = "Tsk000000213214";
    var task = WFCI.getTask(taskID);
    var hashmap = WFCI.startTask(task);
    var retValue = hashmap.get("retValue");
        returns <dfn>true if it starts successfully;false otherwise</dfn>

Parameters:
t - a Task.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)]).
Throws:
WFCIException
Since:
version 1.0.0

stopRootTask

void stopRootTask(java.lang.String rootTaskID)
                  throws WFCIException
Stop the root task.

Examples: 

 WFCI.stopRootTask("Tsk000000835835");

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

suspendBBSBoard

boolean suspendBBSBoard(java.lang.String bbsBoardID)
                        throws WFCIException
Suspends a bbs board in db with a board ID.

Parameters:
bbsBoardID - a BBSBoardID.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

suspendTask

java.util.HashMap suspendTask(Task t)
                              throws WFCIException
Suspend the task.

Examples: 

    var taskID = "Tsk000000226229";
    var task = WFCI.getTask(taskID);
    var hashmap = WFCI.suspendTask(task);
    var retValue = hashmap.get("retValue");
        returns <dfn>true if it starts successfully;false otherwise</dfn>

Parameters:
t - a Task.
Returns:
the result ( [Key:Value] = [retValue:Boolean(true)] ).
Throws:
WFCIException
Since:
version 1.0.1

swapAeppServer

boolean swapAeppServer(com.flowring.aeppServer.AeppServer aeppServer1,
                       com.flowring.aeppServer.AeppServer aeppServer2)
                       throws WFCIException
Exchange the order between one AEPP Server and another one.

Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

swapPersonalFavoriteOrder

boolean swapPersonalFavoriteOrder(java.lang.String memId,
                                  java.lang.String id1,
                                  java.lang.String id2)
                                  throws WFCIException
Throws:
WFCIException

swapProcessMapCategory

boolean swapProcessMapCategory(Category category1,
                               Category category2)
                               throws WFCIException
Exchange the order between one ProcessMap Category and another one.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

swapProcessMapLink

boolean swapProcessMapLink(Link link1,
                           Link link2)
                           throws WFCIException
Exchange the order between one ProcessMap Link and another one.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

testAFDBConnection

boolean testAFDBConnection(int seq)
                           throws WFCIException
Test an AFDBConnection object with database configuration, by the specific sequence.

Parameters:
seq - the sequence which the data is store in configuration, from 1
Returns:
true if testing is successful.
Throws:
WFCIException
See Also:
AFDBConnection

testAFDBConnection

boolean testAFDBConnection(java.lang.String name)
                           throws WFCIException
Test an AFDBConnection object with database configuration, by the specific name.

Parameters:
name - the name to recognize the db configuration
Returns:
true if testing is successful.
Throws:
WFCIException
See Also:
AFDBConnection

unlockTask

void unlockTask(java.lang.String tskID)
                throws WFCIException
UnLock the root task of the task.

Examples: 

 var taskID = "Tsk000000226229";
 WFCI.unlockTask(taskID);

Parameters:
tskID - a TaskID.
Throws:
WFCIException
Since:
version 1.1.5

unRegisterActivity

boolean unRegisterActivity(com.flowring.onlineregister.entity.Activity act,
                           java.lang.String mbrId)
                           throws WFCIException
Parameters:
act -
mbrId -
Returns:
Throws:
WFCIException

updateActivity

boolean updateActivity(com.flowring.onlineregister.entity.Activity act)
                       throws WFCIException
Parameters:
act -
Returns:
Throws:
WFCIException

updateAeppServerOfMultiOrg

boolean updateAeppServerOfMultiOrg(com.flowring.aeppServer.AeppServer aeppServer)
                                   throws WFCIException
Update all properties of AEPP Server in database.

Parameters:
AeppServer - bean object.
Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

updateArtInstance

boolean updateArtInstance(PASEartInstance instance)
                          throws WFCIException
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.

Parameters:
instance - a PASEartInstance.
Returns:
true for success, else false.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
PASEartInstance

updateArtInstance

boolean updateArtInstance(java.lang.String tID,
                          PASEartInstance instance)
                          throws WFCIException
Update artifact instance.

Parameters:
tID - a TaskID.
instance - a PASEartInstance.
Returns:
true for success, else false.
Throws:
WFCIException
Since:
version 1.1.5
See Also:
PASEartInstance

updateArtInstanceLog

boolean updateArtInstanceLog(java.lang.String tID,
                             PASEartInstance instance)
                             throws WFCIException
Update artifact instance log.

Parameters:
tID - a task id.
instance - a PASEartInstance.
Returns:
true for success. false for unsuccess.
Throws:
WFCIException
Since:
version 1.2
See Also:
PASEartInstance

updateBBSBoard

boolean updateBBSBoard(BBSBoard bbsBoard)
                       throws WFCIException
Updates a bbs board in db with a board object.

Parameters:
bbsBoard - a BBSBoard.
Returns:
true if it has been invoked successfully; false otherwise.
Throws:
WFCIException

updateBBSMessage

boolean updateBBSMessage(BBSMessage msg)
                         throws WFCIException
Throws:
WFCIException

updateDashboard

boolean updateDashboard(com.flowring.dashboard.Dashboard dboard)
                        throws WFCIException

Updates a Dashboard only.

NOTE: It will not update its style list, using updateDashboardStyle(DashboardStyle) to update its style.

Parameters:
dboard - a Dashboard object.
Returns:
true if update success; false otherwise.
Throws:
WFCIException
See Also:
Dashboard

updateDashboardStyle

boolean updateDashboardStyle(com.flowring.dashboard.DashboardStyle dstyle)
                             throws WFCIException
Updates a DashboardStyle from table.

Parameters:
dstyle - a DashboardStyle object.
Returns:
true if update success; false otherwise.
Throws:
WFCIException
See Also:
DashboardStyle

updateMbrSignGroup

boolean updateMbrSignGroup(java.lang.String mbrId,
                           AFGroup group)
                           throws WFCIException
Parameters:
mbrId -
group -
Returns:
Throws:
WFCIException

updateMemberRecord

boolean updateMemberRecord(MemberRecord mbr)
                           throws WFCIException
Update the MemberRecord in database.

Parameters:
mbr - the MemberRecord instance.
Throws:
WFCIException
See Also:
MemberRecord

updateMultiServerACL

boolean updateMultiServerACL(com.flowring.aeppServer.MultiServerACL multiServerACL)
                             throws WFCIException
Update the access control properties of the multi server.

Parameters:
MultiServerACL - bean object.
Returns:
true or fale.
Throws:
WFCIException
Since:
V3.0

updatePASEGroup

void updatePASEGroup(PASEGroup group)
                     throws WFCIException
Parameters:
group -
Throws:
WFCIException

updatePASESharedFile

void updatePASESharedFile(PASESharedFile sFile)
                          throws WFCIException
Parameters:
sFile -
Throws:
WFCIException

updatePersonalProShow

boolean updatePersonalProShow(java.lang.String memberId,
                              java.lang.String showType,
                              java.lang.String variety)
                              throws WFCIException
Throws:
WFCIException

updateProcessMapCategory

boolean updateProcessMapCategory(Category category)
                                 throws WFCIException
Update the Category bean of ProcessMap in database.

Returns:
true or false.
Throws:
WFCIException
Since:
V3.1

updateQuestionnaire

boolean updateQuestionnaire(com.flowring.questionnaire.entity.Questionnaire q)
                            throws WFCIException
The implement method should update datas from database by the given questionnaire object.

Parameters:
qne - a Questionnaire object.
Returns:
true if update success; false otherwise.
Throws:
WFCIException

updateScheduleEvent

void updateScheduleEvent(ScheduleEvent evt)
                         throws WFCIException
Update ScheduleEvent.

Parameters:
evt - ScheduleEvent which will be updated.
Throws:
WFCIException

updateTask

boolean updateTask(Task t)
                   throws WFCIException
Updates the data object of task. The method will update the task in cache and database.

Examples: 

 var taskID = "Tsk000000226232";
 var task = WFCI.getTask(taskID);
 task.setKeyWord("Hello");
 WFCI.updateTask(task);

Parameters:
t - a task.
Throws:
WFCIException
Since:
version 1.0.0
See Also:
Task

updateTaskState

boolean updateTaskState(Task t)
                        throws WFCIException
Update the task state.

Examples: 

 var taskID = "Tsk000000226232";
 var task = WFCI.getTask(taskID);
 task.setTaskState(task.TASK_STATE_READY);
 WFCI.updateTaskState(task);

Parameters:
t - a Task.
Returns:
true for success. false for unsuccess.
Throws:
WFCIException
Since:
version 1.2
See Also:
Task

updateUnitType

boolean updateUnitType(UnitType unit)
                       throws WFCIException
Update the specified unit type

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

updateValueWithAFDBConnection

boolean updateValueWithAFDBConnection(java.lang.String session,
                                      java.lang.String sqlcmd)
                                      throws WFCIException
Invoke the connection to update value.

Parameters:
session - the session connection key
sqlcmd - the SQL statement to update data
Returns:
the correspondence data(each element in Vector are instance of ResultTable).
Throws:
WFCIException
See Also:
ResultTable

updateVote

boolean updateVote(com.flowring.onlinevote.entity.Vote vote)
                   throws WFCIException
Parameters:
vote -
Returns:
Throws:
WFCIException

updateVoteOpt

boolean updateVoteOpt(com.flowring.onlinevote.entity.VoteOpt voteOpt)
                      throws WFCIException
Parameters:
voteOpt -
Returns:
Throws:
WFCIException

userVerify

java.util.HashMap userVerify(java.lang.String loginID,
                             java.lang.String pass,
                             boolean autoLogin)
                             throws WFCIException
Parameters:
loginID -
pass -
autoLogin -
Returns:
Throws:
WFCIException
Since:
version 2.2.2.1

waitTask

void waitTask(java.lang.String tskID)
              throws WFCIException
Sets the task to be state of waiting.

Examples: 

 var taskID = "Tsk000000226229";
 WFCI.waitTask(taskID);

Parameters:
tskID - a TaskID.
Throws:
WFCIException
Since:
version 1.1.5

waitTask

void waitTask(java.lang.String tskID,
              java.lang.String timeString)
              throws WFCIException
Sets the task to be state of waiting, and the waiting duration.

Examples: 

 var taskID = "Tsk000000226229";
 var time = "2001/12/12/23/58";
 WFCI.waitTask(taskID, time);

Parameters:
tskID - a TaskID.
timeString - the running time with format "yyyy/mm/dd/hh/mm".
Throws:
WFCIException
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.