Agentflow
V3.1

si.wfcidata
Class AFUserSession

java.lang.Object
  extended by si.wfcidata.AFUserSession

public class AFUserSession
extends java.lang.Object

AFUserSession

Version:
1.1.5,
Author:
Flowring co.

Constructor Summary
AFUserSession(WFCI wfci, MemberRecord member)
          Constructor
AFUserSession(WFCI wfci, MemberRecord member, java.lang.String domainName)
          Constructor
 
Method Summary
 boolean changePassword(java.lang.String newPwd)
          Change password of member
 boolean changePassword(java.lang.String oldPwd, java.lang.String newPwd)
          Change password of member
 AFArtInstance createFreqArtInstance(java.lang.String aID)
          Create artifact instance, for FreqAp use
 AFMemberRecord getAFMemberRecord()
          Get member instance
 AFTaskList getAFMyTaskList()
          Get AFMyTaskList which is viewed in MyTask in Agenda
 AFProcessList getAFProcessList()
          Get AFProcessList of root AFTask of member
 AFTaskList getAFTaskList()
          Get AFTaskList of AFTask of member
 AFTaskList getAFTaskList(int state)
          Get AFTaskList whose state of task equals 'state'
 AFTaskList getApprovalHistoryRootTask()
           
 java.lang.String getDomainName()
           
 java.lang.String getFlowServerHost()
          Get the flow server host.
 java.lang.String getFlowServerPort()
          Get the flow server port.
 java.util.Vector getFreqApListOfMember()
          return a PASEFreqAp List.
 AFTaskList getHistoryRootTask()
           
 AFMemberRecord getMemberRecord()
          Get the MemberRecord of the Session
 AFTaskList getMonitorRootAFTask()
          Get AFTaskList which is viewed in Monitor in Agenda
 AFTaskList getRequestHistoryRootTask()
           
 java.util.HashMap getRetHashMap()
          Get the login result HashMap
 AFTaskList getRootAFTaskOfJoinMember(int state)
          Get AFTaskList whose state of AFTask equals 'state' of join member
 AFTaskList getRootAFTaskOfMember()
          Get AFTaskList of root AFTask of member
 AFTaskList getRootAFTaskOfMember(int state)
          Get AFTaskList whose state of AFTask equals 'state' of member
 java.util.HashMap getTreeTaskList()
          Get MyTask Data with a tree structure which consists of AFProjectTask and AFProcessTask
 WFCI getWFCI()
          Get WFCI interface
 java.util.HashMap initProcess(AFProcess process)
          Initializa AFProcess with some AFProcess arguments
 java.util.HashMap initProcess(java.lang.String roleID, java.lang.String depID, java.lang.String processID, java.lang.String subject, int priority)
          Initializa AFProcess with some AFProcess arguments, using default process name
 java.util.HashMap initProcess(java.lang.String roleID, java.lang.String depID, java.lang.String processID, java.lang.String processName, java.lang.String subject, int priority)
          Initializa AFProcess with some AFProcess arguments
 void logout()
          User logout.
 void reloadAFMemberRecord()
          Reload member instance
 void setAFMemberRecord(MemberRecord member)
          Set member instance
 void setDomainName(java.lang.String domainName)
           
 void setRetHashMap(java.util.HashMap retHashMap)
          Set the login result HashMap
 void setWFCI(WFCI wfci)
          set WFCI interface
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AFUserSession

public AFUserSession(WFCI wfci,
                     MemberRecord member)
Constructor

Parameters:
wfci - WFCI interface
member - MemberRecord object

AFUserSession

public AFUserSession(WFCI wfci,
                     MemberRecord member,
                     java.lang.String domainName)
Constructor

Parameters:
wfci - WFCI interface
member - MemberRecord object
domainName -
Since:
V3.1
Method Detail

changePassword

public boolean changePassword(java.lang.String newPwd)
                       throws WFCIException
Change password of member

Parameters:
newPwd - new password
Returns:
true if success else false
Throws:
WFCIException

changePassword

public boolean changePassword(java.lang.String oldPwd,
                              java.lang.String newPwd)
                       throws WFCIException
Change password of member

Parameters:
oldPwd - old password
newPwd - new password
Returns:
true if success else false
Throws:
WFCIException

createFreqArtInstance

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

Parameters:
iID - the givin ArtifactID
Returns:
the AFArtifact instance
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFArtInstance

getAFMemberRecord

public AFMemberRecord getAFMemberRecord()
                                 throws WFCIException
Get member instance

Returns:
the AFMemberRecord instance
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFMemberRecord

getAFMyTaskList

public AFTaskList getAFMyTaskList()
                           throws WFCIException
Get AFMyTaskList which is viewed in MyTask in Agenda

Returns:
AFTaskList
Throws:
WFCIException

getAFProcessList

public AFProcessList getAFProcessList()
                               throws WFCIException
Get AFProcessList of root AFTask of member

Returns:
AFTaskList
Throws:
WFCIException

getAFTaskList

public AFTaskList getAFTaskList()
                         throws WFCIException
Get AFTaskList of AFTask of member

Returns:
AFTaskList
Throws:
WFCIException

getAFTaskList

public AFTaskList getAFTaskList(int state)
                         throws WFCIException
Get AFTaskList whose state of task equals 'state'

Parameters:
state - AFTask state
Returns:
AFTaskList
Throws:
WFCIException

getApprovalHistoryRootTask

public AFTaskList getApprovalHistoryRootTask()
                                      throws WFCIException
Throws:
WFCIException

getDomainName

public java.lang.String getDomainName()

getFlowServerHost

public java.lang.String getFlowServerHost()
                                   throws WFCIException
Get the flow server host.

Returns:
the host address
Throws:
WFCIException

getFlowServerPort

public java.lang.String getFlowServerPort()
                                   throws WFCIException
Get the flow server port.

Returns:
the host port
Throws:
WFCIException

getFreqApListOfMember

public java.util.Vector getFreqApListOfMember()
                                       throws WFCIException
return a PASEFreqAp List.

Returns:
the correspondence data(each element in Vector are instance of AFFreqAP)
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFFreqAP

getHistoryRootTask

public AFTaskList getHistoryRootTask()
                              throws WFCIException
Throws:
WFCIException

getMemberRecord

public AFMemberRecord getMemberRecord()
                               throws WFCIException
Get the MemberRecord of the Session

Returns:
the MemberRecord object
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFMemberRecord

getMonitorRootAFTask

public AFTaskList getMonitorRootAFTask()
                                throws WFCIException
Get AFTaskList which is viewed in Monitor in Agenda

Returns:
AFTaskList
Throws:
WFCIException

getRequestHistoryRootTask

public AFTaskList getRequestHistoryRootTask()
                                     throws WFCIException
Throws:
WFCIException

getRetHashMap

public java.util.HashMap getRetHashMap()
Get the login result HashMap

Returns:
the result ( [Key:Value] = [retValue:Boolean(true/false)] ; [reason:login failed result])

getRootAFTaskOfJoinMember

public AFTaskList getRootAFTaskOfJoinMember(int state)
                                     throws WFCIException
Get AFTaskList whose state of AFTask equals 'state' of join member

Parameters:
state - AFTask state
Returns:
AFTaskList
Throws:
WFCIException

getRootAFTaskOfMember

public AFTaskList getRootAFTaskOfMember()
                                 throws WFCIException
Get AFTaskList of root AFTask of member

Returns:
AFTaskList
Throws:
WFCIException

getRootAFTaskOfMember

public AFTaskList getRootAFTaskOfMember(int state)
                                 throws WFCIException
Get AFTaskList whose state of AFTask equals 'state' of member

Parameters:
state - AFTask state
Returns:
AFTaskList
Throws:
WFCIException

getTreeTaskList

public java.util.HashMap getTreeTaskList()
                                  throws WFCIException
Get MyTask Data with a tree structure which consists of AFProjectTask and AFProcessTask

Returns:
the result ( [Key:Value] = [AFProjectID:AFProjectTask])
Throws:
WFCIException
Since:
version 1.1.5
See Also:
AFProjectTask, AFProcessTask

getWFCI

public WFCI getWFCI()
             throws WFCIException
Get WFCI interface

Returns:
WFCI interface
Throws:
WFCIException

initProcess

public java.util.HashMap initProcess(AFProcess process)
                              throws WFCIException
Initializa AFProcess with some AFProcess arguments

Parameters:
process - AFProcess object
Returns:
the result ( [Key:Value] = [rootTaskID:rootTaskID] ; [retValue:Boolean(true/false)])
Throws:
WFCIException

initProcess

public java.util.HashMap initProcess(java.lang.String roleID,
                                     java.lang.String depID,
                                     java.lang.String processID,
                                     java.lang.String subject,
                                     int priority)
                              throws WFCIException
Initializa AFProcess with some AFProcess arguments, using default process name

Parameters:
roleID - AFRole ID
processID - AFProcess ID
subject - AFProcess subject
priority - AFProcess priority number
Returns:
the result ( [Key:Value] = [rootTaskID:rootTaskID] ; [retValue:Boolean(true/false)])
Throws:
WFCIException

initProcess

public java.util.HashMap initProcess(java.lang.String roleID,
                                     java.lang.String depID,
                                     java.lang.String processID,
                                     java.lang.String processName,
                                     java.lang.String subject,
                                     int priority)
                              throws WFCIException
Initializa AFProcess with some AFProcess arguments

Parameters:
roleID - AFRole ID
processID - AFProcess ID
processName - AFProcess name
subject - AFProcess subject
priority - AFProcess priority number
Returns:
the result ( [Key:Value] = [rootTaskID:rootTaskID] ; [retValue:Boolean(true/false)])
Throws:
WFCIException

logout

public void logout()
            throws WFCIException
User logout.

Throws:
WFCIException

reloadAFMemberRecord

public void reloadAFMemberRecord()
                          throws WFCIException
Reload member instance

Throws:
WFCIException
Since:
version 1.1.5
See Also:
MemberRecord

setAFMemberRecord

public void setAFMemberRecord(MemberRecord member)
Set member instance

Since:
version 1.1.5
See Also:
MemberRecord

setDomainName

public void setDomainName(java.lang.String domainName)

setRetHashMap

public void setRetHashMap(java.util.HashMap retHashMap)
Set the login result HashMap

Parameters:
the - result HashMap, invoked by AFConnection

setWFCI

public void setWFCI(WFCI wfci)
             throws WFCIException
set WFCI interface

Parameters:
wfci -
Throws:
WFCIException

Agentflow
V3.1

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.