org.olat.lms.course.nodes.projectbroker

接口 ProjectBrokerManager

所有超级接口:

DeletableGroupData

所有已知实现类:

ProjectBrokerManagerImpl

public interface ProjectBrokerManager
extends DeletableGroupData

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CUSTOMFIELD_LIST_DELIMITER

方法概要

方法

限定符和类型	方法和说明
boolean	canBeCancelEnrollmentBy(Identity identity, Project project, ProjectBrokerModuleConfiguration moduleConfig) Return true when the project can be de-selected by an identity.
boolean	canBeProjectSelectedBy(Identity identity, Project project, ProjectBrokerModuleConfiguration moduleConfig, int nbrSelectedProjects, boolean isParticipantInAnyProject) Return true when the project can be selected by an identity.
boolean	cancelProjectEnrollmentOf(Identity identity, Project projectAt, ProjectBrokerModuleConfiguration moduleConfig) Remove certain identity as participant or candidate of a project (depending on project-broker configuration).
ProjectBroker	createAndSaveProjectBroker() Creates a new project-broker and save it.
Project	createAndSaveProjectFor(java.lang.String projectTitle, java.lang.String description, java.lang.Long projectBrokerId, BusinessGroup projectGroup) Create and save a new project.
void	deleteProject(Project project, boolean deleteGroup, CourseEnvironment courseEnv, CourseNode cNode) Delete a project.
void	deleteProjectBroker(java.lang.Long projectBrokerId, CourseEnvironment courseEnvironment, CourseNode courseNode) Delete a project-broker and his projects and groups.
boolean	enrollProjectParticipant(Identity identity, Project projectAt, ProjectBrokerModuleConfiguration moduleConfig, int nbrSelectedProjects, boolean isParticipantInAnyProject) Enroll certain identity as participant or candidate of a project (depending on project-broker configuration).
boolean	existProjectName(java.lang.Long projectBrokerId, java.lang.String newProjectTitle) Return true when a project with the same title already exist.
boolean	existsProject(java.lang.Long projectKey) Check if certain project still exists (on db)
java.util.List<Project>	findProjectsForGoup(java.lang.Long groupId)
java.lang.String	getAttachmentBasePathRelToFolderRoot(CourseEnvironment courseEnvironment, CourseNode courseNode) Get attachment-folder relative path (without project-id).
java.lang.String	getAttamchmentRelativeRootPath(Project project, CourseEnvironment courseEnv, CourseNode courseNode) Get attachment-file relative path.
java.util.List<Project>	getCoachedProjectsOf(Identity identity, java.lang.Long projectBrokerId) Get list of coached projects for certain identity.
java.lang.String	getDropboxBasePathForProject(Project project, CourseEnvironment courseEnvironment, CourseNode node)
java.lang.String	getDropboxPathForProjectAndIdentity(Project project, Identity identity, CourseEnvironment courseEnvironment, CourseNode node)
java.lang.String	getDropboxRootFolder(CourseEnvironment courseEnvironment, CourseNode node)
int	getNbrSelectedProjects(Identity identity, java.util.List<Project> projectList) Get the number of total selected project for certain identity.
Project	getProject(java.lang.Long projectId) Get certain project by key.
ProjectBroker	getProjectBroker(java.lang.Long projectBrokerId) Returns a project-broker object for certain project-broker-ID.
java.lang.Long	getProjectBrokerId(CoursePropertyManager cpm, CourseNode courseNode) Get saved project-broker-id.
java.util.List<Project>	getProjectListBy(java.lang.Long projectBrokerId) Returns a list of projects for certain project-broker.
java.util.List<Project>	getProjectsOf(Identity identity, java.lang.Long projectBrokerId) Get list of selected projects for certain identity.
java.lang.String	getReturnboxBasePathForProject(Project project, CourseEnvironment courseEnv, CourseNode node) Return returnbox base-path. e.g. course//returnbox/ To have the path for certain user you must call method 'getReturnboxPathFor'
java.lang.String	getReturnboxPathForProjectAndIdentity(Project project, CourseEnvironment courseEnv, CourseNode node, Identity identity)
java.lang.String	getReturnboxRootFolder(CourseEnvironment courseEnvironment, CourseNode node)
int	getSelectedPlaces(Project project) Get number of selected places for certain project.
java.lang.String	getStateFor(Project project, Identity identity, ProjectBrokerModuleConfiguration moduleConfig) Get the state [STATE_ASSIGNED_ACCOUNT_MANAGER | STATE_NOT_ASSIGNED_ACCOUNT_MANAGER | STATE_NOT_ASSIGNED_ACCOUNT_MANAGER_NO_CANDIDATE | STATE_FINAL_ENROLLED | STATE_PROV_ENROLLED | STATE_COMPLETE | STATE_NOT_ASSIGNED | STATE_ENROLLED ] of a project
java.util.List<Identity>	getTopicTutors(Project project, UserCourseEnvironment userCourseEnv)
boolean	isCustomFieldValueValid(java.lang.String value, java.lang.String string) Return true when the custom-field value is one of possible-values (drop-down-mode) or when it could be any value (input field).
boolean	isDropboxAccessible(Project project, ProjectBrokerModuleConfiguration moduleConfig)
boolean	isParticipantInAnyProject(Identity identity, java.util.List<Project> projectList) Return true when an identity is participant in any project of a project-broker.
void	saveAttachedFile(Project project, java.lang.String fileName, VFSLeaf uploadedItem, CourseEnvironment courseEnv, CourseNode cNode) Save attachment file in the attachment-folder of a project.
void	saveProjectBrokerId(java.lang.Long projectBrokerId, CoursePropertyManager cpm, CourseNode courseNode) Save project-broker-id.
void	setProjectState(Project project, java.lang.String state) Set project-state [STATE_NOT_ASSIGNED | STATE_ASSIGNED].
void	signOutFromAllCandidateLists(java.util.List<Identity> chosenIdentities, java.lang.Long projectBrokerId) Remove identities from all projects as candidates.
void	updateProject(Project project) Update and save an existing project.

从接口继承的方法 org.olat.lms.group.DeletableGroupData

checkIfReferenced, deleteGroupDataFor

字段详细资料

CUSTOMFIELD_LIST_DELIMITER

static final java.lang.String CUSTOMFIELD_LIST_DELIMITER

另请参阅:

常量字段值

方法详细资料

getProjectListBy

java.util.List<Project> getProjectListBy(java.lang.Long projectBrokerId)

Returns a list of projects for certain project-broker.

参数:

projectBrokerId -

返回:

getProjectBroker

ProjectBroker getProjectBroker(java.lang.Long projectBrokerId)

Returns a project-broker object for certain project-broker-ID.

参数:

projectBrokerId -

返回:

getSelectedPlaces

int getSelectedPlaces(Project project)

Get number of selected places for certain project.

参数:

project -

返回:

createAndSaveProjectBroker

ProjectBroker createAndSaveProjectBroker()

Creates a new project-broker and save it.

返回:

updateProject

void updateProject(Project project)

Update and save an existing project.

参数:

project -

createAndSaveProjectFor

Project createAndSaveProjectFor(java.lang.String projectTitle,
                              java.lang.String description,
                              java.lang.Long projectBrokerId,
                              BusinessGroup projectGroup)

Create and save a new project.

参数:

projectTitle -

description -

projectBrokerId -

projectGroup -

返回:

enrollProjectParticipant

boolean enrollProjectParticipant(Identity identity,
                               Project projectAt,
                               ProjectBrokerModuleConfiguration moduleConfig,
                               int nbrSelectedProjects,
                               boolean isParticipantInAnyProject)

Enroll certain identity as participant or candidate of a project (depending on project-broker configuration).

参数:

identity -

projectAt -

moduleConfig -

nbrSelectedProjects -

isParticipantInAnyProject -

返回:

cancelProjectEnrollmentOf

boolean cancelProjectEnrollmentOf(Identity identity,
                                Project projectAt,
                                ProjectBrokerModuleConfiguration moduleConfig)

Remove certain identity as participant or candidate of a project (depending on project-broker configuration).

参数:

identity -

projectAt -

moduleConfig -

返回:

deleteProject

void deleteProject(Project project,
                 boolean deleteGroup,
                 CourseEnvironment courseEnv,
                 CourseNode cNode)

Delete a project.

参数:

project -

deleteGroup - true: project group will be deleted too

courseEnv -

cNode -

getNbrSelectedProjects

int getNbrSelectedProjects(Identity identity,
                         java.util.List<Project> projectList)

Get the number of total selected project for certain identity.

参数:

identity -

projectList -

返回:

canBeProjectSelectedBy

boolean canBeProjectSelectedBy(Identity identity,
                             Project project,
                             ProjectBrokerModuleConfiguration moduleConfig,
                             int nbrSelectedProjects,
                             boolean isParticipantInAnyProject)

Return true when the project can be selected by an identity. Depends on enrollment-date, number of already enrolled projects and project-broker configuration.

参数:

identity -

project -

moduleConfig -

nbrSelectedProjects -

isParticipantInAnyProject -

返回:

canBeCancelEnrollmentBy

boolean canBeCancelEnrollmentBy(Identity identity,
                              Project project,
                              ProjectBrokerModuleConfiguration moduleConfig)

Return true when the project can be de-selected by an identity.

参数:

identity -

project -

moduleConfig -

返回:

signOutFromAllCandidateLists

void signOutFromAllCandidateLists(java.util.List<Identity> chosenIdentities,
                                java.lang.Long projectBrokerId)

Remove identities from all projects as candidates.

参数:

chosenIdentities -

projectBrokerId -

getStateFor

java.lang.String getStateFor(Project project,
                           Identity identity,
                           ProjectBrokerModuleConfiguration moduleConfig)

Get the state [STATE_ASSIGNED_ACCOUNT_MANAGER | STATE_NOT_ASSIGNED_ACCOUNT_MANAGER | STATE_NOT_ASSIGNED_ACCOUNT_MANAGER_NO_CANDIDATE | STATE_FINAL_ENROLLED | STATE_PROV_ENROLLED | STATE_COMPLETE | STATE_NOT_ASSIGNED | STATE_ENROLLED ] of a project

参数:

project -

identity -

moduleConfig -

返回:

deleteProjectBroker

void deleteProjectBroker(java.lang.Long projectBrokerId,
                       CourseEnvironment courseEnvironment,
                       CourseNode courseNode)

Delete a project-broker and his projects and groups.

参数:

projectBrokerId -

courseEnvironment -

courseNode -

saveAttachedFile

void saveAttachedFile(Project project,
                    java.lang.String fileName,
                    VFSLeaf uploadedItem,
                    CourseEnvironment courseEnv,
                    CourseNode cNode)

Save attachment file in the attachment-folder of a project.

参数:

project -

fileName -

uploadedItem -

courseEnv -

cNode -

isCustomFieldValueValid

boolean isCustomFieldValueValid(java.lang.String value,
                              java.lang.String string)

Return true when the custom-field value is one of possible-values (drop-down-mode) or when it could be any value (input field).

参数:

value -

string -

返回:

getAttamchmentRelativeRootPath

java.lang.String getAttamchmentRelativeRootPath(Project project,
                                              CourseEnvironment courseEnv,
                                              CourseNode courseNode)

Get attachment-file relative path. E.g. course//projectbroker_attach//

参数:

project -

courseEnv -

courseNode -

返回:

setProjectState

void setProjectState(Project project,
                   java.lang.String state)

Set project-state [STATE_NOT_ASSIGNED | STATE_ASSIGNED].

参数:

project -

state -

isParticipantInAnyProject

boolean isParticipantInAnyProject(Identity identity,
                                java.util.List<Project> projectList)

Return true when an identity is participant in any project of a project-broker.

参数:

identity -

projectList -

返回:

getProjectBrokerId

java.lang.Long getProjectBrokerId(CoursePropertyManager cpm,
                                CourseNode courseNode)

Get saved project-broker-id.

参数:

cpm -

courseNode -

返回:

saveProjectBrokerId

void saveProjectBrokerId(java.lang.Long projectBrokerId,
                       CoursePropertyManager cpm,
                       CourseNode courseNode)

Save project-broker-id.

参数:

projectBrokerId -

cpm -

courseNode -

existProjectName

boolean existProjectName(java.lang.Long projectBrokerId,
                       java.lang.String newProjectTitle)

Return true when a project with the same title already exist.

参数:

projectBrokerId -

newProjectTitle -

返回:

getAttachmentBasePathRelToFolderRoot

java.lang.String getAttachmentBasePathRelToFolderRoot(CourseEnvironment courseEnvironment,
                                                    CourseNode courseNode)

Get attachment-folder relative path (without project-id). THis path can be used to delete all attachment-file for certain project-broker. E.g. course//projectbroker_attach/

参数:

courseEnvironment -

courseNode -

返回:

getProjectsOf

java.util.List<Project> getProjectsOf(Identity identity,
                                    java.lang.Long projectBrokerId)

Get list of selected projects for certain identity.

参数:

identity -

projectBrokerId -

返回:

getProject

Project getProject(java.lang.Long projectId)

Get certain project by key.

参数:

projectId -

返回:

getCoachedProjectsOf

java.util.List<Project> getCoachedProjectsOf(Identity identity,
                                           java.lang.Long projectBrokerId)

Get list of coached projects for certain identity.

参数:

identity -

projectBrokerId -

返回:

existsProject

boolean existsProject(java.lang.Long projectKey)

Check if certain project still exists (on db)

参数:

projectKey -

返回:

getDropboxBasePathForProject

java.lang.String getDropboxBasePathForProject(Project project,
                                            CourseEnvironment courseEnvironment,
                                            CourseNode node)

参数:

project -

courseEnvironment -

node -

返回:

getDropboxPathForProjectAndIdentity

java.lang.String getDropboxPathForProjectAndIdentity(Project project,
                                                   Identity identity,
                                                   CourseEnvironment courseEnvironment,
                                                   CourseNode node)

getDropboxRootFolder

java.lang.String getDropboxRootFolder(CourseEnvironment courseEnvironment,
                                    CourseNode node)

参数:

courseEnvironment -

projectBrokerCourseNode -

返回:

getReturnboxBasePathForProject

java.lang.String getReturnboxBasePathForProject(Project project,
                                              CourseEnvironment courseEnv,
                                              CourseNode node)

Return returnbox base-path. e.g. course//returnbox/ To have the path for certain user you must call method 'getReturnboxPathFor'

参数:

project -

courseEnv -

cNode -

返回:

Returnbox path relative to folder root.

getReturnboxRootFolder

java.lang.String getReturnboxRootFolder(CourseEnvironment courseEnvironment,
                                      CourseNode node)

getReturnboxPathForProjectAndIdentity

java.lang.String getReturnboxPathForProjectAndIdentity(Project project,
                                                     CourseEnvironment courseEnv,
                                                     CourseNode node,
                                                     Identity identity)

isDropboxAccessible

boolean isDropboxAccessible(Project project,
                          ProjectBrokerModuleConfiguration moduleConfig)

findProjectsForGoup

java.util.List<Project> findProjectsForGoup(java.lang.Long groupId)

getTopicTutors

java.util.List<Identity> getTopicTutors(Project project,
                                      UserCourseEnvironment userCourseEnv)