...
Abstract Methods
authenticate
booleanpublic boolean authenticate(java.lang.String username, java.lang.String password)
Method called to authenticate a particular User against the directory
getDepartmentById
public org.joget.directory.model.Department getDepartmentById(java.lang.String departmentId)Method called to retrieve a specific Department by Department Id
getDepartmentByName
public org.joget.directory.model.Department getDepartmentByName(java.lang.String name)Method called to retrieve a specific Department by Department Name
getDepartmentHod
public org.joget.directory.model.User getDepartmentHod(java.lang.String departmentId)Method called to return a specific HOD for a Department
getDepartmentList
Collection<Department>public java.util.Collection<org.joget.directory.model.Department> getDepartmentList()
Generic method called to retrieve all Departments within the directory
getDepartmentList
Collection<Department>public java.util.Collection<org.joget.directory.model.Department> getDepartmentList(java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
...
getDepartmentListByOrganization
Collection<Department>public java.util.Collection<org.joget.directory.model.Department> getDepartmentListByOrganization(java.lang.String organizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
...
getDepartmentsByOrganizationId
Collection<Department>public java.util.Collection<org.joget.directory.model.Department> getDepartmentsByOrganizationId(java.lang.String filterString, java.lang.String organizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve all Departments within a specific Organization filtered by search parameters
getDepartmentsByParentId
Collection<Department>public java.util.Collection<org.joget.directory.model.Department> getDepartmentsByParentId(java.lang.String filterString, java.lang.String parentId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
...
getDepartmentUserByGradeId
Collection<User>public java.util.Collection<org.joget.directory.model.User> getDepartmentUserByGradeId(java.lang.String departmentId, java.lang.String gradeId)
Method called to retrieve a listing of Users which belongs to a specified Department and Grade
getParentDepartment
public org.joget.directory.model.Department getParentDepartment(java.lang.String id)...
getParentDepartmentByName
public org.joget.directory.model.Department getParentDepartmentByName(java.lang.String name)Method called to retrieve a parent Department of a Department by Department Name
getTotalDepartments
javapublic java.lang.Long getTotalDepartments(java.lang.String organizationId)
...
getTotalDepartmentnsByOrganizationId
javapublic java.lang.Long getTotalDepartmentnsByOrganizationId(java.lang.String filterString, java.lang.String organizationId)
...
getTotalDepartmentsByParentId
javapublic java.lang.Long getTotalDepartmentsByParentId(java.lang.String filterString, java.lang.String parentId)
Method called to retrieve the number of sub Departments within a specific Department
getEmployment
public org.joget.directory.model.Employment getEmployment(java.lang.String id)Method called to retrieve a specific Employment info
getEmployments
Collection<Employment>public java.util.Collection<org.joget.directory.model.Employment> getEmployments(java.lang.String filterString, java.lang.String organizationId, java.lang.String departmentId, java.lang.String gradeId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve the users' employment info within the directory filtered by search parameters
getTotalEmployments
javapublic java.lang.Long getTotalEmployments(java.lang.String filterString, java.lang.String organizationId, java.lang.String departmentId, java.lang.String gradeId)
Method called to retrieve the number of users' employment info within the directory
getGradeById
public org.joget.directory.model.Grade getGradeById(java.lang.String gradeId)Method called to retrieve a specific Grade by Grade id
getGradeByName
public org.joget.directory.model.Grade getGradeByName(java.lang.String name)Method called to retrieve a specific Grade by Grade Name
getGradeList
Collection<Grade>public java.util.Collection<org.joget.directory.model.Grade> getGradeList()
Generic method called to retrieve all Grades within the directory
getGradesByOrganizationId
Collection<Grade>public java.util.Collection<org.joget.directory.model.Grade> getGradesByOrganizationId(java.lang.String filterString, java.lang.String organizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
...
getTotalGradesByOrganizationId
javapublic java.lang.Long getTotalGradesByOrganizationId(java.lang.String filterString, java.lang.String organizationId)
Method called to retrieve the number of Grades within a specific Organization filtered by search parameters
getGroupById
public org.joget.directory.model.Group getGroupById(java.lang.String groupId)Method called to retrieve a specific Group by id
getGroupByName
public org.joget.directory.model.Group getGroupByName(java.lang.String groupName)Method called to retrieve a specific Group by name
getGroupsByUserId
Collection<Group>public java.util.Collection<org.joget.directory.model.Group> getGroupsByUserId(java.lang.String filterString, java.lang.String userId, java.lang.String organizationId, java.lang.Boolean inGroup, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve a collection of Group in/not in which a user belongs to and filtered by search parameters
getGroupByUsername
Collection<Group>public java.util.Collection<org.joget.directory.model.Group> getGroupByUsername(java.lang.String username)
Method called to retrieve a collection of Group in which a user belongs to
getGroupList
Collection<Group>public java.util.Collection<org.joget.directory.model.Group> getGroupList()
Generic method called to retrieve the entire Group listing within the directory
getGroupList
Collection<Group>public java.util.Collection<org.joget.directory.model.Group> getGroupList(java.lang.String nameFilter, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
...
getGroupsByOrganizationId
Collection<Group>public java.util.Collection<org.joget.directory.model.Group> getGroupsByOrganizationId(java.lang.String filterString, java.lang.String organizationId, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve all groups within a specific Organization filtered by search parameters
getTotalGroups
javapublic java.lang.Long getTotalGroups()
...
getTotalGroupsByOrganizationId
javapublic java.lang.Long getTotalGroupsByOrganizationId(java.lang.String filterString, java.lang.String organizationId)
Method call to retrieve the number of Groups available within a specific Organization filtered by search parameters
getTotalGroupsByUserId
javapublic java.lang.Long getTotalGroupsByUserId(java.lang.String filterString, java.lang.String userId, java.lang.String organizationId, java.lang.Boolean inGroup)
Method called to retrieve the number of Group in/not in which a user belongs to
getOrganization
public org.joget.directory.model.Organization getOrganization(java.lang.String id)Method called to retrieve a specific Organization by Id
getOrganizationByName
public org.joget.directory.model.Organization getOrganizationByName(String name)Method called to retrieve a specific Organization by Name
getOrganizationsByFilter
Collection<Organization>public java.util.Collection<org.joget.directory.model.Organization> getOrganizationsByFilter(java.lang.String filterString, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
...
getTotalOrganizationsByFilter
javapublic java.lang.Long getTotalOrganizationsByFilter(java.lang.String filterString)
Method called to retrieve the number of Organizations
getUserByDepartmentId
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserByDepartmentId(java.lang.String departmentId)
Method called to retrieve a listing of Users by Department id
getUserByGradeId
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserByGradeId(java.lang.String gradeId)
Method called to retrieve a listing of Users by Grade id
getUserByGroupId
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserByGroupId(java.lang.String groupId)
Method called to retrieve a listing of Users by Group id
getUserByGroupName
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserByGroupName(java.lang.String groupName)
Method called to retrieve a listing of Users by Group name
getUserById
public org.joget.directory.model.User getUserById(java.lang.String userId)Method called to retrieve a specific User by User id
getUserByOrganizationId
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserByOrganizationId(java.lang.String organizationId)
Method called to retrieve a listing of Users by Organization id
getUserByUsername
public org.joget.directory.model.User getUserByUsername(java.lang.String username)Method called to retrieve a specific User by Username
getUserList
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserList()
Generic method called to retrieve the entire User listing within the directory
getUserList
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserList(java.lang.String nameFilter, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve the entire User listing within the directory filtered by search parameters
getUsers
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUsers(java.lang.String filterString, java.lang.String organizationId, java.lang.String departmentId, java.lang.String gardeId, java.lang.String groupId, java.lang.String roleId, java.lang.String active, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve the users within the directory filtered by search parameters
getTotalUsers
javapublic java.lang.Long getTotalUsers()
Method called to retrieve the number of Users available
getTotalUsers
javapublic java.lang.Long getTotalUsers(java.lang.String filterString, java.lang.String organizationId, java.lang.String departmentId, java.lang.String gardeId, java.lang.String groupId, java.lang.String roleId, java.lang.String active)
Method call to retrieve the number of Users available within the directory filtered by search parametersisUserInGroup
isUserInGroup
booleanpublic boolean isUserInGroup(java.lang.String username, java.lang.String groupName)
Method called to check if a User belongs to a specific Group
getUserDepartmentUser
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserDepartmentUser(java.lang.String username)
Method called to retrieve a listing of Users which belongs to the same Department as the specific Username
getUserHod
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserHod(java.lang.String username)
Method called to retrieve a listing of HODs in which a specific User reports to
getUserSubordinate
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUserSubordinate(java.lang.String username)
Method called to retrieve a listing of all the subordinates which reports to a specific User
getUsersSubordinate
Collection<User>public java.util.Collection<org.joget.directory.model.User> getUsersSubordinate(java.lang.String username, java.lang.String sort, java.lang.Boolean desc, java.lang.Integer start, java.lang.Integer rows)
Method called to retrieve a listing of all the subordinates which reports to a specific User filtered by search parameters
getTotalUsersSubordinate
javapublic java.lang.Long getTotalUsersSubordinate(java.lang.String username)
Method called to retrieve the number of subordinates which reports to a specific User
getUserRoles
Collection<Role>public java.util.Collection<org.joget.directory.model.Role> getUserRoles(java.lang.String username)
...