com.nulabinc.backlog4j.api

Interface ProjectMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface ProjectMethods

Executes Backlog Project APIs.

Method Summary

Modifier and Type	Method and Description
Category	addCategory(AddCategoryParams params) Adds a category to the project.
CheckBoxCustomFieldSetting	addCheckBoxCustomField(AddCheckBoxCustomFieldParams params) Adds a checkbox type custom field to the project.
DateCustomFieldSetting	addDateCustomField(AddDateCustomFieldParams params) Adds a date type custom field to the project.
IssueType	addIssueType(AddIssueTypeParams params) Adds a issue type to the project.
CustomFieldSetting	addListCustomFieldItem(java.lang.Object projectIdOrKey, java.lang.Object customFieldId, java.lang.String name) Adds a item to the list type custom field.
Milestone	addMilestone(AddMilestoneParams params) Adds a Milestone to the project.
MultipleListCustomFieldSetting	addMultipleListCustomField(AddMultipleListCustomFieldParams params) Adds a multiple list type custom field to the project.
NumericCustomFieldSetting	addNumericCustomField(AddNumericCustomFieldParams params) Adds a numeric type custom field to the project.
User	addProjectAdministrator(java.lang.Object projectIdOrKey, java.lang.Object userId) Adds the project administrators.
User	addProjectUser(java.lang.Object projectIdOrKey, java.lang.Object userId) Adds the user to the project.
RadioCustomFieldSetting	addRadioCustomField(AddRadioCustomFieldParams params) Adds a radio type custom field to the project.
SingleListCustomFieldSetting	addSingleListCustomField(AddSingleListCustomFieldParams params) Adds a single list type custom field to the project.
TextAreaCustomFieldSetting	addTextAreaCustomField(AddTextAreaCustomFieldParams params) Adds a text area type custom field to the project.
TextCustomFieldSetting	addTextCustomField(AddTextCustomFieldParams params) Adds a text type custom field to the project.
Version	addVersion(AddVersionParams params) Adds a version to the project.
Project	createProject(CreateProjectParams params) Create a project.
Project	deleteProject(java.lang.Object projectIdOrKey) Deletes the existing project.
SharedFileData	downloadSharedFile(java.lang.Object projectIdOrKey, java.lang.Object sharedFileId) Returns the shared file data in the project.
ResponseList<Category>	getCategories(java.lang.Object projectIdOrKey) Returns the categories in the project.
ResponseList<CustomFieldSetting>	getCustomFields(java.lang.Object projectIdOrKey) Returns the custom fields in the project.
ResponseList<IssueType>	getIssueTypes(java.lang.Object projectIdOrKey) Returns the issue types in the project.
ResponseList<Milestone>	getMilestones(java.lang.Object projectIdOrKey) Returns the Milestones in the project.
Project	getProject(java.lang.Object projectIdOrKey) Returns the project.
ResponseList<Activity>	getProjectActivities(java.lang.Object projectIdOrKey) Returns the activities on the project.
ResponseList<Activity>	getProjectActivities(java.lang.Object projectIdOrKey, ActivityQueryParams query) Returns the activities on the project.
ResponseList<User>	getProjectAdministrators(java.lang.Object projectIdOrKey) Returns the project administrators.
DiskUsageDetail	getProjectDiskUsage(java.lang.Object projectIdOrKey) Returns the disk usage of the project.
Icon	getProjectIcon(java.lang.Object projectIdOrKey) Returns the project icon.
ResponseList<Project>	getProjects() Returns all the projects.
ResponseList<User>	getProjectUsers(java.lang.Object projectIdOrKey) Returns the users in the project.
ResponseList<SharedFile>	getSharedFiles(java.lang.Object projectIdOrKey, java.lang.String path) Returns the shared files in the project.
ResponseList<SharedFile>	getSharedFiles(java.lang.Object projectIdOrKey, java.lang.String path, QueryParams queryParams) Returns the shared files in the project.
ResponseList<Status>	getStatuses(java.lang.Object projectIdOrKey) Returns the issue statuses in the project.
ResponseList<Version>	getVersions(java.lang.Object projectIdOrKey) Returns the versions in the project.
Category	removeCategory(java.lang.Object projectIdOrKey, java.lang.Object categoryId) Removes the category from the project
CustomFieldSetting	removeCustomField(java.lang.Object projectIdOrKey, java.lang.Object customFieldId) Removes the custom filed from the project.
IssueType	removeIssueType(java.lang.Object projectIdOrKey, java.lang.Object issueTypeId, java.lang.Object substituteIssueTypeId) Removes the existing issue type from the project.
CustomFieldSetting	removeListCustomFieldItem(java.lang.Object projectIdOrKey, java.lang.Object customFieldId, java.lang.Object itemId) Removes the item of list type custom field.
Milestone	removeMilestone(java.lang.Object projectIdOrKey, java.lang.Object MilestoneId) Removes the Milestone from the project.
User	removeProjectAdministrator(java.lang.Object projectIdOrKey, java.lang.Object userId) Deletes the project administrators.
User	removeProjectUser(java.lang.Object projectIdOrKey, java.lang.Object userId) Removes the user from the project.
Version	removeVersion(java.lang.Object projectIdOrKey, java.lang.Object versionId) Removes the version from the project.
Category	updateCategory(UpdateCategoryParams params) Updates the existing category in the project.
CheckBoxCustomFieldSetting	updateCheckBoxCustomField(UpdateCheckBoxCustomFieldParams params) Updates the existing checkbox type custom field in the project.
DateCustomFieldSetting	updateDateCustomField(UpdateDateCustomFieldParams params) Updates the existing date type custom field in the project.
IssueType	updateIssueType(UpdateIssueTypeParams params) Updates the issue type in the project.
CustomFieldSetting	updateListCustomFieldItem(java.lang.Object projectIdOrKey, java.lang.Object customFieldId, java.lang.Object itemId, java.lang.String name) Updates the existing item of list type custom field.
Milestone	updateMilestone(UpdateMilestoneParams params) Updates the existing Milestone in the project.
MultipleListCustomFieldSetting	updateMultipleListCustomField(UpdateMultipleListCustomFieldParams params) Updates the existing multiple list type custom field in the project.
NumericCustomFieldSetting	updateNumericCustomField(UpdateNumericCustomFieldParams params) Updates the existing numeric type custom field in the project.
Project	updateProject(UpdateProjectParams params) Updates the existing project.
RadioCustomFieldSetting	updateRadioCustomField(UpdateRadioCustomFieldParams params) Updates the existing radio type custom field in the project.
SingleListCustomFieldSetting	updateSingleListCustomField(UpdateSingleListCustomFieldParams params) Updates the existing single list type custom field in the project.
TextAreaCustomFieldSetting	updateTextAreaCustomField(UpdateTextAreaCustomFieldParams params) Updates the existing text area type custom field in the project.
TextCustomFieldSetting	updateTextCustomField(UpdateTextCustomFieldParams params) Updates the existing text type custom field in the project.
Version	updateVersion(UpdateVersionParams params) Updates the existing version in the project.

Method Detail

getProjects

ResponseList<Project> getProjects()
                           throws BacklogException

Returns all the projects.

Returns:

the projects in a list.

Throws:

BacklogException

createProject

Project createProject(CreateProjectParams params)
               throws BacklogException

Create a project.

Parameters:

params - the creating project parameters.

Returns:

the created project

Throws:

BacklogException

getProject

Project getProject(java.lang.Object projectIdOrKey)
            throws BacklogException

Returns the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the Project

Throws:

BacklogException

updateProject

Project updateProject(UpdateProjectParams params)
               throws BacklogException

Updates the existing project.

Parameters:

params - the updating project parameters

Returns:

the updated Project

Throws:

BacklogException

deleteProject

Project deleteProject(java.lang.Object projectIdOrKey)
               throws BacklogException

Deletes the existing project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the deleted Project

Throws:

BacklogException

getProjectIcon

Icon getProjectIcon(java.lang.Object projectIdOrKey)
             throws BacklogException

Returns the project icon.

Parameters:

projectIdOrKey - the project identifier

Returns:

the Icon

Throws:

BacklogException

getProjectActivities

ResponseList<Activity> getProjectActivities(java.lang.Object projectIdOrKey)
                                     throws BacklogException

Returns the activities on the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the activities in a list

Throws:

BacklogException

getProjectActivities

ResponseList<Activity> getProjectActivities(java.lang.Object projectIdOrKey,
                                            ActivityQueryParams query)
                                     throws BacklogException

Returns the activities on the project.

Parameters:

projectIdOrKey - the project identifier

query - the query parameters

Returns:

the activities in a list

Throws:

BacklogException

addProjectUser

User addProjectUser(java.lang.Object projectIdOrKey,
                    java.lang.Object userId)
             throws BacklogException

Adds the user to the project.

Parameters:

projectIdOrKey - the project identifier

userId - the user identifier

Returns:

the added User

Throws:

BacklogException

getProjectUsers

ResponseList<User> getProjectUsers(java.lang.Object projectIdOrKey)
                            throws BacklogException

Returns the users in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the users in a list.

Throws:

BacklogException

removeProjectUser

User removeProjectUser(java.lang.Object projectIdOrKey,
                       java.lang.Object userId)
                throws BacklogException

Removes the user from the project.

Parameters:

projectIdOrKey - the project identifier

userId - the user identifier

Returns:

the removed User

Throws:

BacklogException

addProjectAdministrator

User addProjectAdministrator(java.lang.Object projectIdOrKey,
                             java.lang.Object userId)
                      throws BacklogException

Adds the project administrators.

Parameters:

projectIdOrKey - the project identifier

userId - the user identifier

Returns:

the removed User

Throws:

BacklogException

getProjectAdministrators

ResponseList<User> getProjectAdministrators(java.lang.Object projectIdOrKey)
                                     throws BacklogException

Returns the project administrators.

Parameters:

projectIdOrKey - the project identifier

Returns:

the project administrators

Throws:

BacklogException

removeProjectAdministrator

User removeProjectAdministrator(java.lang.Object projectIdOrKey,
                                java.lang.Object userId)
                         throws BacklogException

Deletes the project administrators.

Parameters:

projectIdOrKey - the project identifier

userId - the user identifier

Returns:

the removed User

Throws:

BacklogException

getIssueTypes

ResponseList<IssueType> getIssueTypes(java.lang.Object projectIdOrKey)
                               throws BacklogException

Returns the issue types in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the issue types in a list

Throws:

BacklogException

addIssueType

IssueType addIssueType(AddIssueTypeParams params)
                throws BacklogException

Adds a issue type to the project.

Parameters:

params - the creating issue type parameters

Returns:

the added IssueType

Throws:

BacklogException

updateIssueType

IssueType updateIssueType(UpdateIssueTypeParams params)
                   throws BacklogException

Updates the issue type in the project.

Parameters:

params - the updating issue type parameters

Returns:

the updated IssueType

Throws:

BacklogException

removeIssueType

IssueType removeIssueType(java.lang.Object projectIdOrKey,
                          java.lang.Object issueTypeId,
                          java.lang.Object substituteIssueTypeId)
                   throws BacklogException

Removes the existing issue type from the project.

Parameters:

projectIdOrKey - the project identifier

issueTypeId - the issue type identifier

substituteIssueTypeId - the substitute issue type identifier

Returns:

the removed IssueType

Throws:

BacklogException

getStatuses

ResponseList<Status> getStatuses(java.lang.Object projectIdOrKey)
                          throws BacklogException

Returns the issue statuses in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the statuses in a list

Throws:

BacklogException

getCategories

ResponseList<Category> getCategories(java.lang.Object projectIdOrKey)
                              throws BacklogException

Returns the categories in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the categories in a list

Throws:

BacklogException

addCategory

Category addCategory(AddCategoryParams params)
              throws BacklogException

Adds a category to the project.

Parameters:

params - the adding category parameter

Returns:

the added category

Throws:

BacklogException

updateCategory

Category updateCategory(UpdateCategoryParams params)
                 throws BacklogException

Updates the existing category in the project.

Parameters:

params - the updating category parameters.

Returns:

the updated category

Throws:

BacklogException

removeCategory

Category removeCategory(java.lang.Object projectIdOrKey,
                        java.lang.Object categoryId)
                 throws BacklogException

Removes the category from the project

Parameters:

projectIdOrKey - the project identifier

categoryId - the category identifier

Returns:

the removed category

Throws:

BacklogException

getVersions

ResponseList<Version> getVersions(java.lang.Object projectIdOrKey)
                           throws BacklogException

Returns the versions in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the versions in a list

Throws:

BacklogException

addVersion

Version addVersion(AddVersionParams params)
            throws BacklogException

Adds a version to the project.

Parameters:

params - the adding version parameters.

Returns:

the added version

Throws:

BacklogException

updateVersion

Version updateVersion(UpdateVersionParams params)
               throws BacklogException

Updates the existing version in the project.

Parameters:

params - the updating version parameters.

Returns:

the updated version

Throws:

BacklogException

removeVersion

Version removeVersion(java.lang.Object projectIdOrKey,
                      java.lang.Object versionId)
               throws BacklogException

Removes the version from the project.

Parameters:

projectIdOrKey - the project identifier

versionId - the version identifier

Returns:

the removed version

Throws:

BacklogException

getMilestones

ResponseList<Milestone> getMilestones(java.lang.Object projectIdOrKey)
                               throws BacklogException

Returns the Milestones in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the Milestones in a list

Throws:

BacklogException

addMilestone

Milestone addMilestone(AddMilestoneParams params)
                throws BacklogException

Adds a Milestone to the project.

Parameters:

params - the adding Milestone parameters.

Returns:

the added Milestone

Throws:

BacklogException

updateMilestone

Milestone updateMilestone(UpdateMilestoneParams params)
                   throws BacklogException

Updates the existing Milestone in the project.

Parameters:

params - the updating Milestone parameters.

Returns:

the updated Milestone

Throws:

BacklogException

removeMilestone

Milestone removeMilestone(java.lang.Object projectIdOrKey,
                          java.lang.Object MilestoneId)
                   throws BacklogException

Removes the Milestone from the project.

Parameters:

projectIdOrKey - the project identifier

MilestoneId - the Milestone identifier

Returns:

the removed Milestone

Throws:

BacklogException

getCustomFields

ResponseList<CustomFieldSetting> getCustomFields(java.lang.Object projectIdOrKey)
                                          throws BacklogException

Returns the custom fields in the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the custom fields in a list

Throws:

BacklogException

addTextCustomField

TextCustomFieldSetting addTextCustomField(AddTextCustomFieldParams params)
                                   throws BacklogException

Adds a text type custom field to the project.

Parameters:

params - the adding text type custom filed parameters.

Returns:

the added text type custom field setting.

Throws:

BacklogException

addTextAreaCustomField

TextAreaCustomFieldSetting addTextAreaCustomField(AddTextAreaCustomFieldParams params)
                                           throws BacklogException

Adds a text area type custom field to the project.

Parameters:

params - the adding text area type custom filed parameters.

Returns:

the added text area type custom field setting.

Throws:

BacklogException

addNumericCustomField

NumericCustomFieldSetting addNumericCustomField(AddNumericCustomFieldParams params)
                                         throws BacklogException

Adds a numeric type custom field to the project.

Parameters:

params - the adding numeric type custom filed parameters.

Returns:

the added numeric type custom field setting.

Throws:

BacklogException

addDateCustomField

DateCustomFieldSetting addDateCustomField(AddDateCustomFieldParams params)
                                   throws BacklogException

Adds a date type custom field to the project.

Parameters:

params - the adding date type custom filed parameters.

Returns:

the added date type custom field setting.

Throws:

BacklogException

addSingleListCustomField

SingleListCustomFieldSetting addSingleListCustomField(AddSingleListCustomFieldParams params)
                                               throws BacklogException

Adds a single list type custom field to the project.

Parameters:

params - the adding single list type custom filed parameters.

Returns:

the added single list type custom field setting.

Throws:

BacklogException

addMultipleListCustomField

MultipleListCustomFieldSetting addMultipleListCustomField(AddMultipleListCustomFieldParams params)
                                                   throws BacklogException

Adds a multiple list type custom field to the project.

Parameters:

params - the adding multiple list type custom filed parameters.

Returns:

the added multiple list type custom field setting.

Throws:

BacklogException

addRadioCustomField

RadioCustomFieldSetting addRadioCustomField(AddRadioCustomFieldParams params)
                                     throws BacklogException

Adds a radio type custom field to the project.

Parameters:

params - the adding radio type custom filed parameters.

Returns:

the added radio type custom field setting.

Throws:

BacklogException

addCheckBoxCustomField

CheckBoxCustomFieldSetting addCheckBoxCustomField(AddCheckBoxCustomFieldParams params)
                                           throws BacklogException

Adds a checkbox type custom field to the project.

Parameters:

params - the adding checkbox type custom filed parameters.

Returns:

the added checkbox type custom field setting.

Throws:

BacklogException

updateTextCustomField

TextCustomFieldSetting updateTextCustomField(UpdateTextCustomFieldParams params)
                                      throws BacklogException

Updates the existing text type custom field in the project.

Parameters:

params - the updating text type custom filed parameters.

Returns:

the updated text type custom field setting.

Throws:

BacklogException

updateTextAreaCustomField

TextAreaCustomFieldSetting updateTextAreaCustomField(UpdateTextAreaCustomFieldParams params)
                                              throws BacklogException

Updates the existing text area type custom field in the project.

Parameters:

params - the updating text area type custom filed parameters.

Returns:

the updated text area type custom field setting.

Throws:

BacklogException

updateNumericCustomField

NumericCustomFieldSetting updateNumericCustomField(UpdateNumericCustomFieldParams params)
                                            throws BacklogException

Updates the existing numeric type custom field in the project.

Parameters:

params - the updating numeric type custom filed parameters.

Returns:

the updated numeric type custom field setting.

Throws:

BacklogException

updateDateCustomField

DateCustomFieldSetting updateDateCustomField(UpdateDateCustomFieldParams params)
                                      throws BacklogException

Updates the existing date type custom field in the project.

Parameters:

params - the updating date type custom filed parameters.

Returns:

the updated date type custom field setting.

Throws:

BacklogException

updateSingleListCustomField

SingleListCustomFieldSetting updateSingleListCustomField(UpdateSingleListCustomFieldParams params)
                                                  throws BacklogException

Updates the existing single list type custom field in the project.

Parameters:

params - the updating single list type custom filed parameters.

Returns:

the updated single list type custom field setting.

Throws:

BacklogException

updateMultipleListCustomField

MultipleListCustomFieldSetting updateMultipleListCustomField(UpdateMultipleListCustomFieldParams params)
                                                      throws BacklogException

Updates the existing multiple list type custom field in the project.

Parameters:

params - the multiple list text type custom filed parameters.

Returns:

the updated multiple list type custom field setting.

Throws:

BacklogException

updateRadioCustomField

RadioCustomFieldSetting updateRadioCustomField(UpdateRadioCustomFieldParams params)
                                        throws BacklogException

Updates the existing radio type custom field in the project.

Parameters:

params - the updating radio type custom filed parameters.

Returns:

the updated radio type custom field setting.

Throws:

BacklogException

updateCheckBoxCustomField

CheckBoxCustomFieldSetting updateCheckBoxCustomField(UpdateCheckBoxCustomFieldParams params)
                                              throws BacklogException

Updates the existing checkbox type custom field in the project.

Parameters:

params - the updating checkbox type custom filed parameters.

Returns:

the updated checkbox type custom field setting.

Throws:

BacklogException

removeCustomField

CustomFieldSetting removeCustomField(java.lang.Object projectIdOrKey,
                                     java.lang.Object customFieldId)
                              throws BacklogException

Removes the custom filed from the project.

Parameters:

projectIdOrKey - the project identifier

customFieldId - the custom field identifier

Returns:

the removed custom filed

Throws:

BacklogException

addListCustomFieldItem

CustomFieldSetting addListCustomFieldItem(java.lang.Object projectIdOrKey,
                                          java.lang.Object customFieldId,
                                          java.lang.String name)
                                   throws BacklogException

Adds a item to the list type custom field.

Parameters:

projectIdOrKey - the project identifier

customFieldId - the custom field identifier

name - name of the adding item

Returns:

the added custom filed item

Throws:

BacklogException

updateListCustomFieldItem

CustomFieldSetting updateListCustomFieldItem(java.lang.Object projectIdOrKey,
                                             java.lang.Object customFieldId,
                                             java.lang.Object itemId,
                                             java.lang.String name)
                                      throws BacklogException

Updates the existing item of list type custom field.

Parameters:

projectIdOrKey - the project identifier

customFieldId - the custom field identifier

itemId - the item identifier

name - name of the updating item

Returns:

the updated CustomFieldSetting

Throws:

BacklogException

removeListCustomFieldItem

CustomFieldSetting removeListCustomFieldItem(java.lang.Object projectIdOrKey,
                                             java.lang.Object customFieldId,
                                             java.lang.Object itemId)
                                      throws BacklogException

Removes the item of list type custom field.

Parameters:

projectIdOrKey - the project identifier

customFieldId - the custom field identifier

itemId - the item identifier

Returns:

the removed CustomFieldSetting

Throws:

BacklogException

getSharedFiles

ResponseList<SharedFile> getSharedFiles(java.lang.Object projectIdOrKey,
                                        java.lang.String path)
                                 throws BacklogException

Returns the shared files in the project.

Parameters:

projectIdOrKey - the project identifier

path - path of the shared file directory

Returns:

the shared files in a list

Throws:

BacklogException

getSharedFiles

ResponseList<SharedFile> getSharedFiles(java.lang.Object projectIdOrKey,
                                        java.lang.String path,
                                        QueryParams queryParams)
                                 throws BacklogException

Returns the shared files in the project.

Parameters:

projectIdOrKey - the project identifier

path - path of the shared file directory

queryParams - the query parameters

Returns:

the shared files in a list

Throws:

BacklogException

downloadSharedFile

SharedFileData downloadSharedFile(java.lang.Object projectIdOrKey,
                                  java.lang.Object sharedFileId)
                           throws BacklogException

Returns the shared file data in the project.

Parameters:

projectIdOrKey - the project identifier

sharedFileId - the shared file identifier

Returns:

the SharedFileData

Throws:

BacklogException

getProjectDiskUsage

DiskUsageDetail getProjectDiskUsage(java.lang.Object projectIdOrKey)
                             throws BacklogException

Returns the disk usage of the project.

Parameters:

projectIdOrKey - the project identifier

Returns:

the DiskUsageDetail

Throws:

BacklogException