public class

DefaultClarizenClient

extends Object
implements ClarizenClient
java.lang.Object
   ↳ org.mule.modules.clarizen.DefaultClarizenClient

Summary

Constants
String DEFAULT_DATE_CONVERTER_PATTERN
String DEFAULT_PACKAGE_MODEL
String DEFAULT_PACKAGE_MODEL_FLAT Package used for model classes containing only EntityId references
String SUFFIX_FLAT_CLASSES Suffix for flat classes
Fields
private BeanUtilsBean beanUtilsBean
private ClarizenDateConverter clarizenDateConverter
private ConvertUtilsBean convertUtilsBean
private ClarizenClientHelper helper
private IClarizen service
private ClarizenServiceProvider serviceProvider
private String sessionId
Public Constructors
DefaultClarizenClient(ClarizenServiceProvider provider)
Public Methods
BaseClarizenEntity createEntity(BaseClarizenEntity entity)
Creates an entity
<T extends BaseClarizenEntity> List<T> createEntityQuery(List<String> fieldsToRetrieve, String queryTypeName, Condition condition, Integer pageSize, Integer maxNumberOfPages, boolean useFlatClasses)
Creates an entity query
BaseClarizenEntity createFromTemplate(String templateName, BaseClarizenEntity entity)
Creates milestones and projects from templates
<T extends BaseClarizenEntity> List<T> createIssuesQuery(List<String> fieldsToRetrieve, AllIssueType issueType, Condition condition, Integer pageSize, Integer maxNumberOfPages, boolean useFlatClasses)
Creates an issue query
Boolean deleteEntity(BaseClarizenEntity entity)
Deletes en entity
List<EntityDescription> describeEntities(List<String> typeNames)
Describes an entity querying the metadata information provided by the webservice
FileInformation downloadFileInformation(BaseClarizenEntity entity)
Download file information
GetCalendarInfoResult getCalendarInfo(EntityId userId)
Get Calendar Information
ConvertUtilsBean getConvertUtilsBean()
ClarizenClientHelper getHelper()
<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
ClarizenServiceProvider getServiceProvider()
String getSessionId()
List<Object> getSystemSettings(List<String> settingList)
Gets System settings
BaseClarizenEntity getWorkItemById(WorkItemType type, String workItemId, List<String> fieldsToRetrieve, boolean useFlatClasses)
Gets workItem information by id
ClarizenDateConverter getXmlGregorianCalendarConverter()
Boolean lifecycleChange(List<EntityId> entityIdList, String operation, Boolean recursive)
Changes the state of an entity
List<String> listEntities()
Queries metadata information provided by the webservice for available entities
Login login(String username, String password, String applicationId, String partnerId)
Login to the webservice
void logout()
Logout
Boolean sendEmail(AccessType accessType, String body, String subject, List<Recipient> recipients, BaseClarizenEntity relatedEntity)
Sends an email
void setConvertUtilsBean(ConvertUtilsBean convertUtilsBean)
void setHelper(ClarizenClientHelper helper)
void setService(IClarizen service)
void setServiceProvider(ClarizenServiceProvider serviceProvider)
void setSessionId(String sessionId)
void setXmlGregorianCalendarConverter(ClarizenDateConverter xmlGregorianCalendarConverter)
BaseClarizenEntity updateEntity(BaseClarizenEntity entity)
Updates an entity
<T extends BaseClarizenEntity> List<T> workItemsQuery(List<String> fieldsToRetrieve, WorkItemState workItemState, WorkItemType workItemType, WorkItemFilter workItemFilter, Integer pageSize, Integer maxNumberOfPages, Boolean useFlatClasses)
Queries workItems
Protected Methods
IClarizen getService()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.mule.modules.clarizen.api.ClarizenClient

Constants

private static final String DEFAULT_DATE_CONVERTER_PATTERN

Constant Value: "yyyy-MM-dd'T'HH:mm:ssZ"

private static final String DEFAULT_PACKAGE_MODEL

Constant Value: "org.mule.modules.clarizen.api.model."

private static final String DEFAULT_PACKAGE_MODEL_FLAT

Package used for model classes containing only EntityId references

Constant Value: "org.mule.modules.clarizen.api.model.flat."

private static final String SUFFIX_FLAT_CLASSES

Suffix for flat classes

Constant Value: "Flat"

Fields

private BeanUtilsBean beanUtilsBean

private ClarizenDateConverter clarizenDateConverter

private ConvertUtilsBean convertUtilsBean

private ClarizenClientHelper helper

private IClarizen service

private ClarizenServiceProvider serviceProvider

private String sessionId

Public Constructors

public DefaultClarizenClient (ClarizenServiceProvider provider)

Parameters
provider

Public Methods

public BaseClarizenEntity createEntity (BaseClarizenEntity entity)

Creates an entity

Parameters
entity Model class extending BaseClarizenClient
Returns
  • created entity

public 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 BaseClarizenEntity createFromTemplate (String templateName, BaseClarizenEntity entity)

Creates milestones and projects from templates

Parameters
templateName
entity
Returns
  • created entity

public 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 Boolean deleteEntity (BaseClarizenEntity entity)

Deletes en entity

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

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

Describes an entity querying the metadata information provided by the webservice

Parameters
typeNames
Returns
  • entityDescription object

public FileInformation downloadFileInformation (BaseClarizenEntity entity)

Download file information

Parameters
entity To be downloaded
Returns
  • File information

public GetCalendarInfoResult getCalendarInfo (EntityId userId)

Get Calendar Information

Parameters
userId
Returns
  • calendar information

public ConvertUtilsBean getConvertUtilsBean ()

public ClarizenClientHelper getHelper ()

public 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 ClarizenServiceProvider getServiceProvider ()

public String getSessionId ()

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

Gets System settings

Parameters
settingList
Returns
  • system settings values

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

Gets workItem information by id

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

public ClarizenDateConverter getXmlGregorianCalendarConverter ()

public 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 List<String> listEntities ()

Queries metadata information provided by the webservice for available entities

Returns
  • list of entities names

public 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 void logout ()

Logout

public 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 void setConvertUtilsBean (ConvertUtilsBean convertUtilsBean)

Parameters
convertUtilsBean

public void setHelper (ClarizenClientHelper helper)

Parameters
helper

public void setService (IClarizen service)

Parameters
service

public void setServiceProvider (ClarizenServiceProvider serviceProvider)

Parameters
serviceProvider

public void setSessionId (String sessionId)

Parameters
sessionId

public void setXmlGregorianCalendarConverter (ClarizenDateConverter xmlGregorianCalendarConverter)

Parameters
xmlGregorianCalendarConverter

public BaseClarizenEntity updateEntity (BaseClarizenEntity entity)

Updates an entity

Parameters
entity Model class extending BaseClarizenClient
Returns
  • updated entity

public 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

Protected Methods

protected IClarizen getService ()