pe.pase

Interface AdminAPI

public interface AdminAPI

The method defined in this interface can be invoked by Client and Administrator Tools

Since:

version 1.1

Version:

1.1.5,

Author:

lchuang

Method Summary

Modifier and Type	Method and Description
boolean	activeBBSBoard(java.lang.String boardID)
boolean	bypassTask(Task p_TaskID, java.lang.String p_AstID) ByPass a task.
boolean	changePassword(java.lang.String uID, java.lang.String newPwd) Change user's password.
boolean	deleteBBSBoard(java.lang.String boardID)
boolean	deleteFunctionAccess(FunctionAccess access) Delete user's FunctionAccess.
boolean	deleteFunctionAccess(java.lang.String principalID, java.lang.String orgID, java.lang.String functionName, java.lang.String permission) Delete user's FunctionAccess.
boolean	forceReassignTask(java.lang.String p_TaskID, java.lang.String p_MemID) Force to reassign a task to other user.
boolean	forceReassignTask(java.lang.String p_TaskID, java.lang.String p_MemID, java.lang.String p_RoleID) Force to reassign the task and assign the specific roleID when this member has multi-roles.
AccessManager	getAccessManagerByOrgRightID(java.lang.String managerID, java.lang.String orgRightID) Get the content of AccessManager of user.
java.util.Vector	getAllBBSBoard()
java.util.Vector	getBBSBoard()
java.util.Vector	getConcurrentUser() Get the concurrent user list.
java.util.List	getFunctionAccessList(java.lang.String principalID) Get the content of AccessManager of user.
java.util.List	getFunctionAccessList(java.lang.String principalID, java.lang.String orgID, java.lang.String functionName, java.lang.String permission) Get the content of AccessManager of user.
java.util.Vector	getHalfHolidays() Get the half-holidays list.
java.util.Vector	getHolidays() Get the holidays list.
AccessMember	getMemberAccess(java.lang.String memID) Get the content of AccessMember of user.
AccessAdmin	getMemberAdminAccess(java.lang.String memID) Get the content of AccessAdmin of user.
java.util.Vector	getMemberArtifactAccess(java.lang.String memID) Get the list of AccessArtifact of user.
AccessOnLineUser	getMemberOnLineAccess(java.lang.String memID) Get the content of AccessOnLineUser of user.
java.util.Vector	getMemberTaskAccess(java.lang.String memID) Get the list of AccessTask of user.
java.util.Vector	getOnLineAdminUser() Get the on-line admin user list.
java.util.Vector	getOnLineUser() Get the on-line user list.
int[]	getWeek() Get the weeks list.
java.util.Vector	getWorkdays() Get the workdays list.
void	initHoliday() Initialize holidays.
boolean	kickOnLineAdminUser(java.lang.String memID) remove an admin user from on-line in sever.
boolean	kickOnLineUser(java.lang.String memID) remove an user from on-line in sever.
boolean	newBBSBoard(BBSBoard bbsBoard)
boolean	reflushProcessManager() Demmand process manager of server to re-schedule.
boolean	removeTaskByAdm(java.lang.String tID) Remove a root task
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) Get searched result by using given conditions.
int	searchDataCount(SearchCondition cond) Get searched number by using given conditions.
void	sendShortMessageToAdminAll(java.lang.String msg, java.lang.String fromMemID) send short message to all on-line admin users
void	sendShortMessageToAll(java.lang.String msg, java.lang.String fromMemID) send short message to all on-line users
void	sendShortMessgeToAdminUser(java.lang.String msg, java.lang.String fromMemID, java.lang.String toMemID) send short message to someone admin user online
void	sendShortMessgeToUser(java.lang.String msg, java.lang.String fromMemID, java.lang.String toMemID) send short message to someone user online
boolean	setFunctionAccess(FunctionAccess access) Set user's FunctionAccess.
boolean	setMemberAccess(java.lang.String memID, AccessMember access) Set user's AccessMember.
boolean	setMemberAdminAccess(java.lang.String memID, AccessAdmin access) Set user's AccessAdmin.
boolean	setMemberArtifactAccess(java.lang.String memID, java.util.Vector artifactAccessList) Set user's AccessArtifact list.
boolean	setMemberOnLineAccess(java.lang.String memID, AccessOnLineUser access) Set user's AccessOnLineUser.
boolean	setMemberTaskAccess(java.lang.String memID, java.util.Vector taskAccessList) Set user's AccessTask list.
boolean	suspendBBSBoard(java.lang.String bbsBoardID)
boolean	updateBBSBoard(BBSBoard bbsBoard)

Method Detail

searchData

java.util.Vector searchData(SearchCondition cond)

Get searched result by using given conditions. The pairs of condition and returned entity:

• ArtifactSearchCondition - String(ArtifactInstanceID)
• TaskSearchCondition - Task
• RoughTaskSearchCondition - TaskSearchEntity
• ComputeSearchCondition - SearchComputeItem(specified item, calculated number)

Parameters:

cond - the given SearchCondition

Returns:

a vector which entities depend on given condition type

Since:

version 1.1

searchDataCount

int searchDataCount(SearchCondition cond)

Get searched number by using given conditions. The condition choices are:

• TaskSearchCondition
• RoughTaskSearchCondition
• ComputeSearchCondition

Parameters:

cond - the given SearchCondition

Returns:

the number have found

Since:

version 1.1

removeTaskByAdm

boolean removeTaskByAdm(java.lang.String tID)

Remove a root task

Parameters:

tID - the task ID that the task will be removed

Returns:

true if removeTaskByAdm has been run properly

Since:

version 1.1

bypassTask

boolean bypassTask(Task p_TaskID,
                   java.lang.String p_AstID)

ByPass a task. A state should be chosen to determine how to bypass the task.

Parameters:

tID - the task ID which will be bypassed

p_AstID - the state ID which is used to determine which path to pass

Returns:

true if bypassTask has been run properly

Since:

version 1.1

forceReassignTask

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

Force to reassign the task and assign the specific roleID when this member has multi-roles.

Parameters:

p_TaskID - the given TaskID

p_MemID - the given MemberRecordID

p_RoleID - the given RoleID

Returns:

true if it sets successfully; false otherwise

Since:

version 3.7

forceReassignTask

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

Force to reassign a task to other user.

Parameters:

p_TaskID - the task ID which it's executor will be changed

p_MemID - the Member ID which is assigned to accept the task

Returns:

true if forceReassignTask has been run properly

Since:

version 1.1

getMemberAccess

AccessMember getMemberAccess(java.lang.String memID)

Get the content of AccessMember of user. It can check what function the user can use in Agenda.

Parameters:

memID - the Member ID

Returns:

AccessMember contains functions permission. return null if no found such AccessMember instance.

Since:

version 1.1

setMemberAccess

boolean setMemberAccess(java.lang.String memID,
                        AccessMember access)

Set user's AccessMember.

Parameters:

memID - the Member ID

access - AccessMember

Returns:

true if setMemberAccess has been run properly

Since:

version 1.1

getMemberOnLineAccess

AccessOnLineUser getMemberOnLineAccess(java.lang.String memID)

Get the content of AccessOnLineUser of user.

Parameters:

memID - the Member ID

Returns:

AccessOnLineUser specifies user's permission, return null if no found such AccessOnLineUser instance

Since:

version 1.1

setMemberOnLineAccess

boolean setMemberOnLineAccess(java.lang.String memID,
                              AccessOnLineUser access)

Set user's AccessOnLineUser.

Parameters:

memID - the Member ID

access - AccessOnLineUser

Returns:

true if setMemberOnLineAccess has been run properly

Since:

version 1.1

getMemberTaskAccess

java.util.Vector getMemberTaskAccess(java.lang.String memID)

Get the list of AccessTask of user. AccessTask's range consists of department, role and member. AccessTask's permission provides read and modify properties.

Parameters:

memID - the Member ID

Returns:

vector of AccessTask. return empty vector if no found any one.

Since:

version 1.1

setMemberTaskAccess

boolean setMemberTaskAccess(java.lang.String memID,
                            java.util.Vector taskAccessList)

Set user's AccessTask list.

Parameters:

memID - the Member ID

access - AccessTask

Returns:

true if setMemberTaskAccess has been run properly

Since:

version 1.1

getMemberArtifactAccess

java.util.Vector getMemberArtifactAccess(java.lang.String memID)

Get the list of AccessArtifact of user. AccessArtifact's range consists of project and artifact. AccessArtifact's permission provides read property only.

Parameters:

memID - the member ID

Returns:

vector of AccessArtifact. return empty vector if no found any one.

Since:

version 1.1

setMemberArtifactAccess

boolean setMemberArtifactAccess(java.lang.String memID,
                                java.util.Vector artifactAccessList)

Set user's AccessArtifact list.

Parameters:

memID - the Member ID

Vector - AccessArtifact

Returns:

true if setMemberArtifactAccess has been run properly

Since:

version 1.1

getMemberAdminAccess

AccessAdmin getMemberAdminAccess(java.lang.String memID)

Get the content of AccessAdmin of user. It can check what function the user can use in Admin.

Parameters:

memID - the Member ID

Returns:

AccessAdmin contains functions permission. return null if no found such AccessAdmin instance.

Since:

version 1.1.5

setMemberAdminAccess

boolean setMemberAdminAccess(java.lang.String memID,
                             AccessAdmin access)

Set user's AccessAdmin.

Parameters:

memID - the Member ID

access - AccessAdmin

Returns:

true if setMemberAdminAccess has been run properly

Since:

version 1.1.5

getAccessManagerByOrgRightID

AccessManager getAccessManagerByOrgRightID(java.lang.String managerID,
                                           java.lang.String orgRightID)

Get the content of AccessManager of user. It can check what function the user can use in Admin.

Parameters:

managerID -

orgRightID -

Returns:

AccessManager contains functions permission. return null if no found such AccessManager instance.

Since:

version 3.7

getFunctionAccessList

java.util.List getFunctionAccessList(java.lang.String principalID)

Get the content of AccessManager of user. It can check What kind of function can be used in Admin by the user.

Parameters:

principalID -

Returns:

List of FunctionAccess contains functions permission. such FunctionAccess instance.

Since:

version 3.7

getFunctionAccessList

java.util.List getFunctionAccessList(java.lang.String principalID,
                                     java.lang.String orgID,
                                     java.lang.String functionName,
                                     java.lang.String permission)

Get the content of AccessManager of user. It can check What kind of function can be used in Admin by the user.

Parameters:

principalID -

functionName -

permission -

Returns:

List of FunctionAccess contains functions permission. such FunctionAccess instance.

Since:

version 3.7

setFunctionAccess

boolean setFunctionAccess(FunctionAccess access)

Set user's FunctionAccess.

Parameters:

access - FunctionAccess

Returns:

true if setFunctionAccess has been run properly

Since:

version 3.7

deleteFunctionAccess

boolean deleteFunctionAccess(FunctionAccess access)

Delete user's FunctionAccess.

Parameters:

access - FunctionAccess

Returns:

true if deleteFunctionAccess has been run properly

Since:

version 3.7

deleteFunctionAccess

boolean deleteFunctionAccess(java.lang.String principalID,
                             java.lang.String orgID,
                             java.lang.String functionName,
                             java.lang.String permission)

Delete user's FunctionAccess.

Parameters:

principalID - String

orgID - String

functionName - String

permission - String

Returns:

true if deleteFunctionAccess has been run properly

Since:

version 3.7

initHoliday

void initHoliday()

Initialize holidays.

Since:

version 1.0

getWeek

int[] getWeek()

Get the weeks list.

Returns:

an array of integer.

Since:

version 1.0

getHolidays

java.util.Vector getHolidays()

Get the holidays list.

Returns:

a Vector of date.

Since:

version 1.0

getHalfHolidays

java.util.Vector getHalfHolidays()

Get the half-holidays list.

Returns:

a Vector of date.

Since:

version 1.0

getWorkdays

java.util.Vector getWorkdays()

Get the workdays list.

Returns:

a Vector of date.

Since:

version 1.0

saveSchedule

void saveSchedule(java.util.Vector hdays,
                  java.util.Vector h_days,
                  java.util.Vector wdays,
                  int[] w)

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

Since:

version 1.0

getBBSBoard

java.util.Vector getBBSBoard()

See Also:

clientAPI

getAllBBSBoard

java.util.Vector getAllBBSBoard()

See Also:

clientAPI

newBBSBoard

boolean newBBSBoard(BBSBoard bbsBoard)

See Also:

clientAPI

suspendBBSBoard

boolean suspendBBSBoard(java.lang.String bbsBoardID)

See Also:

clientAPI

deleteBBSBoard

boolean deleteBBSBoard(java.lang.String boardID)

See Also:

clientAPI

updateBBSBoard

boolean updateBBSBoard(BBSBoard bbsBoard)

See Also:

clientAPI

activeBBSBoard

boolean activeBBSBoard(java.lang.String boardID)

See Also:

clientAPI

getOnLineUser

java.util.Vector getOnLineUser()

Get the on-line user list.

Returns:

a Vector of MemberRecord.

Since:

version 1.0

getConcurrentUser

java.util.Vector getConcurrentUser()

Get the concurrent user list.

Returns:

a Vector of MemberRecord.

Since:

version 3.7

kickOnLineUser

boolean kickOnLineUser(java.lang.String memID)

remove an user from on-line in sever.

Returns:

a Vector of MemberRecord.

Since:

version 1.1

sendShortMessgeToUser

void sendShortMessgeToUser(java.lang.String msg,
                           java.lang.String fromMemID,
                           java.lang.String toMemID)

send short message to someone user online

Parameters:

msg - the message string

fromMemID - the member ID

toMemID - the received member ID

Since:

version 1.1.5

sendShortMessageToAll

void sendShortMessageToAll(java.lang.String msg,
                           java.lang.String fromMemID)

send short message to all on-line users

Parameters:

msg - the message string

fromMemID - the member ID

Since:

version 1.1.5

getOnLineAdminUser

java.util.Vector getOnLineAdminUser()

Get the on-line admin user list.

Returns:

a Vector of MemberRecord.

Since:

version 1.1.5

kickOnLineAdminUser

boolean kickOnLineAdminUser(java.lang.String memID)

remove an admin user from on-line in sever.

Returns:

a Vector of MemberRecord.

Since:

version 1.1.5

sendShortMessgeToAdminUser

void sendShortMessgeToAdminUser(java.lang.String msg,
                                java.lang.String fromMemID,
                                java.lang.String toMemID)

send short message to someone admin user online

Parameters:

msg - the message string

fromMemID - the member ID

toMemID - the received member ID

Since:

version 1.1.5

sendShortMessageToAdminAll

void sendShortMessageToAdminAll(java.lang.String msg,
                                java.lang.String fromMemID)

send short message to all on-line admin users

Parameters:

msg - the message string

fromMemID - the member ID

Since:

version 1.1.5

changePassword

boolean changePassword(java.lang.String uID,
                       java.lang.String newPwd)

Change user's password.

Parameters:

uID - the member ID

newPwd - the new password

Returns:

true if password changed properly.

Since:

version 1.0

reflushProcessManager

boolean reflushProcessManager()

Demmand process manager of server to re-schedule.

Returns:

true if reflushProcessManager is run properly.

Since:

version 1.0