backend/com.tecknobit.nova.helpers.services/ProjectsHelper

ProjectsHelper

@Service

open class ProjectsHelper : EquinoxItemsHelper<T> , NovaResourcesManager

The ProjectsHelper class is useful to manage all the project database operations

Author

N7ghtm4r3 - Tecknobit

Constructors

ProjectsHelper

constructor()

Types

ProjectPayload

class ProjectPayload : Record

Record class used ad payload for the addProject request

Properties

ASSETS_DIRECTORY

val ASSETS_DIRECTORY: String = "assets"

ASSETS_DIRECTORY the assets directory where are stored the assets of the releases uploaded

COMMA

private val COMMA: String = ","

COMMA comma character

entityManager

protected open var entityManager: EntityManager

entityManager entity manager helper

INSERT_JOINING_QR_CODE_MEMBERS

protected val INSERT_JOINING_QR_CODE_MEMBERS: String = "INSERT INTO joining_qrcode_members(id,role,email) VALUES "

INSERT_JOINING_QR_CODE_MEMBERS the query used to insert the members invited in a project with a JoiningQRCode

JOIN_MEMBERS_QUERY

protected val JOIN_MEMBERS_QUERY: String = "REPLACE INTO project_members(id,member_id) VALUES "

JOIN_MEMBERS_QUERY the query used to join members in a project

joiningQRCodeRepository

@Autowired

private open var joiningQRCodeRepository: JoiningQRCodeRepository

joiningQRCodeRepository instance for the joining qrcodes repository

LOGOS_DIRECTORY

val LOGOS_DIRECTORY: String = "logos"

LOGOS_DIRECTORY the logos directory where are stored the logos of the projects

notificationsRepository

@Autowired

private open var notificationsRepository: NotificationsRepository

notificationsRepository instance useful to manage the notifications

PROFILES_DIRECTORY

val PROFILES_DIRECTORY: String = "profiles"

projectsRepository

@Autowired

private open var projectsRepository: ProjectsRepository

projectsRepository instance for the projects repository

RELATIONSHIP_VALUES_SLICE

protected val RELATIONSHIP_VALUES_SLICE: String = "(?, ?)"

RELATIONSHIP_VALUES_SLICE query part to insert in the join table new row

releasesHelper

@Autowired

private open var releasesHelper: ReleasesHelper

releasesHelper helper to manage the releases database operations

REMOVE_MEMBERS_QUERY

private val REMOVE_MEMBERS_QUERY: String = "DELETE FROM project_members WHERE id='%s' AND member_id IN ("

REMOVE_MEMBERS_QUERY the query used to remove members from a project

REPORTS_DIRECTORY

val REPORTS_DIRECTORY: String = "reports"

REPORTS_DIRECTORY the reports directory where are stored the reports of the releases created

RESOURCES_KEY

val RESOURCES_KEY: String = "resources"

RESOURCES_PATH

val RESOURCES_PATH: String = "resources/"

RESOURCES_REPORTS_PATH

val RESOURCES_REPORTS_PATH: String = "resources/reports/"

RESOURCES_REPORTS_PATH the complete reports path from resources directory

ROUND_BRACKET

private val ROUND_BRACKET: String = ")"

ROUND_BRACKET round bracket character

SINGLE_QUOTE

private val SINGLE_QUOTE: String = "'"

SINGLE_QUOTE single quote character

TUPLE_VALUES_SLICE

protected val TUPLE_VALUES_SLICE: String = "(?, ?, ?)"

TUPLE_VALUES_SLICE query part to insert in the join table new row

Functions

addProject

open fun addProject(name: String, logo: MultipartFile, members: ArrayList<String>, projectId: String, authorId: String): JSONObject

Method to add a new project

createAssetResource

open fun createAssetResource(resource: MultipartFile, resourceId: String): String

Method to create the pathname for an asset

createJoiningQrcode

open fun createJoiningQrcode(QRCodeId: String, projectId: String, invitedMembers: List<JSONObject>): String

Method to create a new joining qrcode

createLogoResource

open fun createLogoResource(resource: MultipartFile, resourceId: String): String

Method to create the pathname for a project logo

createProfileResource

open fun createProfileResource(resource: MultipartFile, resourceId: String): String

createReportResource

open fun createReportResource(resource: MultipartFile, resourceId: String): String

Method to create the pathname for a report

createResource

open fun createResource(resource: MultipartFile, resourcesDirectory: String, resourceId: String): String

deleteAssetResource

open fun deleteAssetResource(assetId: String): Boolean

Method to delete an asset

deleteJoiningQrcode

open fun deleteJoiningQrcode(joiningQRCode: JoiningQRCode)

Method to delete a joining qrcode

deleteLogoResource

open fun deleteLogoResource(logoId: String): Boolean

Method to delete a project logo

deleteProfileResource

open fun deleteProfileResource(userId: String): Boolean

deleteProject

open fun deleteProject(authorId: String, project: Project)

Method to delete a project and all the data related to it

deleteReportResource

open fun deleteReportResource(reportId: String): Boolean

Method to delete a report

deleteResource

open fun deleteResource(resourcesDirectory: String, resourceId: String): Boolean

editProject

open fun editProject(name: String, logo: MultipartFile, members: List<String>, project: Project)

Method to edit an existing project

executeDeleteBatch

protected open fun <I> executeDeleteBatch(deleteQuery: String, itemToDeleteId: String, values: List<I>)

Method to execute a batch query to delete items

executeInsertBatch

protected open fun <I> executeInsertBatch(insertQuery: String, valuesSlice: String, values: Collection<I>, batchQuery: EquinoxItemsHelper.BatchQuery)

Method to execute a batch query to insert items

getItemIfAllowed

@TestOnly

open fun getItemIfAllowed(userId: String, itemId: String): T

Method used to get an item if the user is authorized

getJoiningQrcode

open fun getJoiningQrcode(QRCodeId: String): JoiningQRCode

Method to get an existing joining qrcode by its identifier

getJoiningQrcodeByJoinCode

open fun getJoiningQrcodeByJoinCode(joinCode: String): JoiningQRCode

Method to get an existing joining qrcode by its textual join code

getProject

open fun getProject(userId: String, projectId: String): Project

Method to get a project

getProjects

open fun getProjects(userId: String): HashMap<String, List<Project>>

Method to get the project of a NovaUser

getSuffixResource

open fun getSuffixResource(resource: MultipartFile): String

joinMember

open fun joinMember(joiningQRCode: JoiningQRCode, email: String, memberId: String)

Method to join a new member in a project

manageItems

protected open fun manageItems(workflow: EquinoxItemsHelper.ItemsManagementWorkflow, itemId: String, ids: List<String>)

protected open fun manageItems(workflow: EquinoxItemsHelper.ItemsManagementWorkflow, valuesSlice: String, itemId: String, ids: List<String>, batchQuery: EquinoxItemsHelper.BatchQuery)

Method to manage the items of an item to a container

manageProjectMembers

private open fun manageProjectMembers(project: Project, editedMembers: List<String>)

markMemberAsTester

open fun markMemberAsTester(projectId: String, memberId: String)

Method to mark a member as Tester of the project

removeMember

open fun removeMember(projectId: String, memberId: String)

Method to remove a member from a project

removeMemberFromMailingList

open fun removeMemberFromMailingList(joiningQRCode: JoiningQRCode, email: String)

Method to remove a member from the mailing list of the joining qrcode.

saveResource

open fun saveResource(resource: MultipartFile, path: String)

ProjectsHelper

Author

See also

Constructors

Types

Properties

Functions