Package com.aquima.web.rest.v1.service

Class ProjectService

java.lang.Object

com.aquima.web.rest.v1.service.ProjectService

public class ProjectService
extends Object

Since:

9.6

Author:

m.van.tilburg

Constructor Summary

Constructors

Constructor	Description
ProjectService(com.aquima.interactions.portal.IPortalEngine portalEngine, IResourceConverter<com.aquima.interactions.foundation.ApplicationID,Project> projectConverter, IResourceConverter<com.aquima.interactions.portal.ds.ProjectMetadata,Metadata> metadataConverter, IResourceLinker<Project> projectLinker, PaginatorFactory paginatorFactory)

Method Summary

Modifier and Type	Method	Description
Project	getProject(Project project, String projectId)
Metadata	getProjectMetadata(Metadata projectMetadata, String projectId)
PagedObject<Project>	getProjects(PagedObject<Project> pagedProjects, Integer page, Integer pageSize, String sortCriteria)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProjectService

public ProjectService(com.aquima.interactions.portal.IPortalEngine portalEngine,
 IResourceConverter<com.aquima.interactions.foundation.ApplicationID,Project> projectConverter,
 IResourceConverter<com.aquima.interactions.portal.ds.ProjectMetadata,Metadata> metadataConverter,
 IResourceLinker<Project> projectLinker,
 PaginatorFactory paginatorFactory)

Method Details

getProjects

public PagedObject<Project> getProjects(PagedObject<Project> pagedProjects,
 Integer page,
 Integer pageSize,
 String sortCriteria)

Parameters:

pagedProjects - Return object instance with paginated projects

page - The page number for the paginator, starts at 1

pageSize - The number of projects per page

sortCriteria - A comma separated string of sort criteria

Returns:

requested projects

getProject

public Project getProject(Project project,
 String projectId)

Parameters:

project - return object instance for the project

projectId - the unique ID of the project to get. The ID is in short format, @see ProjectConverter

Returns:

requested projects

Throws:

ResourceNotFoundException - when the project with ID projectId does not exist

getProjectMetadata

public Metadata getProjectMetadata(Metadata projectMetadata,
 String projectId)

Parameters:

projectMetadata - return object instance for the project metadata

projectId - the unique ID of the project to get. The ID is in short format, @see ProjectConverter

Returns:

the requested project metadata

Throws:

ResourceNotFoundException - when the project with ID projectId does not exist or the project has no metadata