Summary: Methods | [Expand All]
public interface

ClarizenClient

org.mule.modules.clarizen.api.ClarizenClient
Known Indirect Subclasses

Summary

Public Methods
abstract Boolean attachFileUrlToEntity(EntityId entityId, String attachmentUrl, String attachmentFilename)
Attaches a file to an entity, given that the file resides in an external storage and can be accessed via a URL.
abstract GenericEntity createEntity(GenericEntity entity)
Creates a generic entity
abstract BaseClarizenEntity createEntity(BaseClarizenEntity entity)
Creates an entity
abstract <T extends BaseClarizenEntity> List<T> createEntityQuery(List<String> fieldsToRetrieve, String queryTypeName, Condition condition, Integer pageSize, Integer maxNumberOfPages, boolean useFlatClasses)
Creates an entity query
abstract BaseClarizenEntity createFromTemplate(String templateName, BaseClarizenEntity entity)
Creates milestones and projects from templates
abstract <T extends BaseClarizenEntity> List<T> createIssuesQuery(List<String> fieldsToRetrieve, AllIssueType issueType, Condition condition, Integer pageSize, Integer maxNumberOfPages, boolean useFlatClasses)
Creates an issue query
abstract Boolean deleteEntity(BaseClarizenEntity entity)
Deletes en entity
abstract Boolean deleteEntity(EntityId entityId)
Deletes en entity, defined by its entity Id
abstract List<EntityDescription> describeEntities(List<String> typeNames)
Describes an entity querying the metadata information provided by the webservice
abstract List<FileInformation> downloadEntityAttachments(EntityId entityId)
Given a certain Entity Id, retrieves all associated attachments.
abstract FileInformation downloadFileInformation(BaseClarizenEntity entity)
Download file information
abstract GetCalendarInfoResult getCalendarInfo(EntityId userId)
Get Calendar Information
abstract <T extends BaseClarizenEntity> List<T> getMyWorkItems(List<String> fieldsToRetrieve, WorkItemState workItemState, WorkItemType workItemType, WorkItemFilter workItemFilter, Integer pageSize, Integer maxNumberOfPages, Boolean useFlatClasses)
Query for current user's workitems
abstract List<Object> getSystemSettings(List<String> settingList)
Gets System settings
abstract BaseClarizenEntity getWorkItemById(WorkItemType workItemType, String workItemId, List<String> fieldsToRetrieve, boolean useFlatClasses)
Gets workItem information by id
abstract Boolean lifecycleChange(List<EntityId> entityIdList, String operation, Boolean recursive)
Changes the state of an entity
abstract List<String> listEntities()
Queries metadata information provided by the webservice for available entities
abstract Login login(String username, String password, String applicationId, String partnerId)
Login to the webservice
abstract void logout()
Logout
abstract List<GenericEntity> retrieveWorkItemHumanResources(EntityId entityId, List<String> fieldsToRetrieve)
Given a certain Entity Id representing a work item, retrieves all associated human resources.
abstract Boolean sendEmail(AccessType accessType, String body, String subject, List<Recipient> recipients, BaseClarizenEntity relatedEntity)
Sends an email
abstract GenericEntity updateEntity(GenericEntity entity)
Updates an entity
abstract BaseClarizenEntity updateEntity(BaseClarizenEntity entity)
Updates an entity
abstract <T extends BaseClarizenEntity> List<T> workItemsQuery(List<String> fieldsToRetrieve, WorkItemState workItemState, WorkItemType workItemType, WorkItemFilter workItemFilter, Integer pageSize, Integer maxNumberOfPages, Boolean useFlatClasses)
Queries workItems

Public Methods

public abstract Boolean attachFileUrlToEntity (EntityId entityId, String attachmentUrl, String attachmentFilename)

Attaches a file to an entity, given that the file resides in an external storage and can be accessed via a URL.

Parameters
entityId ID of the entity to which the file URL will be attached
attachmentUrl URL pointing to the attachment
attachmentFilename Filename of the attachment
Returns
  • true if the action was successful

public abstract GenericEntity createEntity (GenericEntity entity)

Creates a generic entity

Parameters
entity Model class extending GenericEntity
Returns
  • created entity

public abstract BaseClarizenEntity createEntity (BaseClarizenEntity entity)

Creates an entity

Parameters
entity Model class extending BaseClarizenClient
Returns
  • created entity

public abstract List<T> createEntityQuery (List<String> fieldsToRetrieve, String queryTypeName, Condition condition, Integer pageSize, Integer maxNumberOfPages, boolean useFlatClasses)

Creates an entity query

Parameters
fieldsToRetrieve
queryTypeName
condition
pageSize
maxNumberOfPages
useFlatClasses Use flat model classes org.mule.modules.clarizen.api.model.flat
Returns
  • a list of entities taking into account depending on the parameter queryTypeName

public abstract BaseClarizenEntity createFromTemplate (String templateName, BaseClarizenEntity entity)

Creates milestones and projects from templates

Parameters
templateName
entity
Returns
  • created entity

public abstract List<T> createIssuesQuery (List<String> fieldsToRetrieve, AllIssueType issueType, Condition condition, Integer pageSize, Integer maxNumberOfPages, boolean useFlatClasses)

Creates an issue query

Parameters
fieldsToRetrieve
issueType
condition
pageSize
maxNumberOfPages
useFlatClasses Use flat model classes org.mule.modules.clarizen.api.model.flat
Returns
  • a list of entities taking into account depending on the parameter issueType

public abstract Boolean deleteEntity (BaseClarizenEntity entity)

Deletes en entity

Parameters
entity To be deleted
Returns
  • true if the entity was successfully deleted

public abstract Boolean deleteEntity (EntityId entityId)

Deletes en entity, defined by its entity Id

Parameters
entityId Identifies the Entity to delete
Returns
  • true if the entity was successfully deleted

public abstract List<EntityDescription> describeEntities (List<String> typeNames)

Describes an entity querying the metadata information provided by the webservice

Parameters
typeNames
Returns
  • entityDescription object

public abstract List<FileInformation> downloadEntityAttachments (EntityId entityId)

Given a certain Entity Id, retrieves all associated attachments.

Parameters
entityId The entity Id associated with the attachments
Returns
  • The list containing all the attachments.

public abstract FileInformation downloadFileInformation (BaseClarizenEntity entity)

Download file information

Parameters
entity To be downloaded
Returns
  • File information

public abstract GetCalendarInfoResult getCalendarInfo (EntityId userId)

Get Calendar Information

Parameters
userId
Returns
  • calendar information

public abstract List<T> getMyWorkItems (List<String> fieldsToRetrieve, WorkItemState workItemState, WorkItemType workItemType, WorkItemFilter workItemFilter, Integer pageSize, Integer maxNumberOfPages, Boolean useFlatClasses)

Query for current user's workitems

Parameters
fieldsToRetrieve
workItemState
workItemType
workItemFilter
pageSize
maxNumberOfPages
useFlatClasses
Returns
  • list containing the workitems objects

public abstract List<Object> getSystemSettings (List<String> settingList)

Gets System settings

Parameters
settingList
Returns
  • system settings values

public abstract BaseClarizenEntity getWorkItemById (WorkItemType workItemType, String workItemId, List<String> fieldsToRetrieve, boolean useFlatClasses)

Gets workItem information by id

Parameters
workItemType
workItemId
fieldsToRetrieve
useFlatClasses Use flat model classes org.mule.modules.clarizen.api.model.flat
Returns
  • GenericEntity

public abstract Boolean lifecycleChange (List<EntityId> entityIdList, String operation, Boolean recursive)

Changes the state of an entity

Parameters
entityIdList List of entityIds to be updated
operation Lifecycle change
recursive
Returns
  • true if the change was successful

public abstract List<String> listEntities ()

Queries metadata information provided by the webservice for available entities

Returns
  • list of entities names

public abstract Login login (String username, String password, String applicationId, String partnerId)

Login to the webservice

Parameters
username
password
applicationId
partnerId
Returns
  • Login information including session id

public abstract void logout ()

Logout

public abstract List<GenericEntity> retrieveWorkItemHumanResources (EntityId entityId, List<String> fieldsToRetrieve)

Given a certain Entity Id representing a work item, retrieves all associated human resources.

Parameters
entityId The entity Id associated with a work item
fieldsToRetrieve
Returns
  • The list containing all the human resources.

public abstract Boolean sendEmail (AccessType accessType, String body, String subject, List<Recipient> recipients, BaseClarizenEntity relatedEntity)

Sends an email

Parameters
accessType PUBLIC or PRIVATE
body
subject
recipients
relatedEntity
Returns
  • true if the action was successful

public abstract GenericEntity updateEntity (GenericEntity entity)

Updates an entity

Parameters
entity Model class extending GenericEntity
Returns
  • updated entity

public abstract BaseClarizenEntity updateEntity (BaseClarizenEntity entity)

Updates an entity

Parameters
entity Model class extending BaseClarizenClient
Returns
  • updated entity

public abstract List<T> workItemsQuery (List<String> fieldsToRetrieve, WorkItemState workItemState, WorkItemType workItemType, WorkItemFilter workItemFilter, Integer pageSize, Integer maxNumberOfPages, Boolean useFlatClasses)

Queries workItems

Parameters
fieldsToRetrieve
workItemState
workItemType
workItemFilter
pageSize
maxNumberOfPages
useFlatClasses
Returns
  • list containing the workitems objects