跳转至

部门管理

创建部门

功能说明

通过部门名称创建部门

方法原型

public int createDept(Dept dept) throws AESCryptoException, ParamParserException, HttpRequestException;

参数说明

参数名称 类型 描述
dept Dept 部门实体

dept成员说明

dept成员 必须 说明
id 部门id,整型。必须大于0
name 部门名称。不能超过32个字符(包括汉字和英文字母)
parentId 父部门id。根部门id为0
sortId 整型。在父部门中的排序值。值越小排序越靠前。填0自动生成。同级部门不允许重复(推荐全局唯一)
alias 字符串。部门id的别名(通常存放以字符串表示的部门id)。唯一不为空,相同会覆盖旧数据。

返回结果说明

成功:返回创建成功的部门Id

失败:发生错误(如请求失败),抛出异常。

请求示例

Dept dept = new Dept();
dept.setName("测试部门创建");
dept.setParentId(0);
dept.setAlias("abc");
int deptId = orgClient.createDept(dept);
System.out.println("create dept ok. deptId: " + deptId);

更新部门

功能说明

修改部门

方法原型

public void updateDept(Dept dept) throws AESCryptoException, ParamParserException, HttpRequestException;

参数说明

参数名称 类型 描述
dept Dept 部门实体

dept成员说明

dept成员 必须 说明
id 部门id,整型。必须大于0,不能修改根部门
name 部门名称。不能超过32个字符(包括汉字和英文字母)
parentId 父部门id。根部门id为0
sortId 整型。在父部门中的排序值。值越大排序越靠前。填0自动生成。同级部门不允许重复(推荐全局唯一)
alias 字符串。部门id的别名(通常存放以字符串表示的部门id)。唯一不为空,相同会覆盖旧数据。

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

int deptId = 1;
Dept dept = new Dept();
dept.setId(deptId);
dept.setName("test测试-1");
dept.setAlias("abcd");
orgClient.updateDept(dept);
System.out.println("update dept with id " + deptId + " ok.");

删除部门

功能说明

通过部门Id删除部门

方法原型

public void deleteDept(int deptId) throws HttpRequestException, ParamParserException, AESCryptoException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:没有返回

失败:发生错误(如请求失败),抛出异常。

请求示例

int deptId = 1;
orgClient.deleteDept(deptId);
System.out.println("delete dept with id " + deptId + " ok.");

获取部门列表

获取部门

功能说明

通过部门Id获取部门信息

方法原型

public Dept getDept(int deptId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:返回Dept实体

失败:发生错误(如请求失败),抛出异常。

请求示例

int deptId = 1;
Dept dept = orgClient.getDept(deptId);
System.out.println("get dept with id " + deptId + " ok: " + dept);

获取当前部门及直属子部门列表

功能说明

通过部门Id获取当前部门及直属子部门列表

方法原型

public List<Dept> listDeptSelfAndChildren(int deptId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:返回List

失败:发生错误(如请求失败),抛出异常。

请求示例

int deptId = 26325;
List<Dept> depts = orgClient.listDeptSelfAndChildren(deptId);
if (depts.size() == 0) {
    System.out.println("list dept children ok, found no children: " + deptId);
    return;
}
for (Dept dept : depts) {
    System.out.println("get dept child: " + dept);
}

获取直属子部门列表

功能说明

通过部门Id获取直属子部门列表

方法原型

public List<Dept> listDeptChildren(int deptId) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
deptId int 部门Id

返回结果说明

成功:返回List

失败:发生错误(如请求失败),抛出异常。

请求示例

int deptId = 1;
List<Dept> depts = orgClient.listDeptChildren(deptId);
if (depts.size() == 0) {
    System.out.println("list dept children ok, found no children: " + deptId);
    return;
}
for (Dept dept : depts) {
    System.out.println("get dept children: " + dept);
}

获取部门ID

通过别名获取部门ID

功能说明

通过别名获取部门ID

方法原型

public int getDeptIdByAlias(String alias) throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

参数名称 类型 描述
alias String 别名

返回结果说明

成功:返回int,部门Id

失败:发生错误(如请求失败),抛出异常。

请求示例

String alias = "alias_test";
int deptId = orgClient.getDeptIdByAlias(alias);
System.out.println(String.format("get deptId by alias ok: %s,%d", alias, deptId));

获取所有有别名的部门ID列表

功能说明

获取所有有别名的部门ID列表

方法原型

public List<AliasDept> listAliasDept() throws ParamParserException, HttpRequestException, AESCryptoException;

参数说明

返回结果说明

成功:返回List

失败:发生错误(如请求失败),抛出异常。

请求示例

List<AliasDept> depts = orgClient.listAliasDept();
if (depts.size() == 0) {
    System.out.println("no dept was found has alias");
    return;
}
for (AliasDept dept : depts) {
    System.out.println(String.format("get alias dept: %s:%d", dept.getAlias(), dept.getDeptId()));
}