java.lang.Object
   ↳ org.mule.LiquidPlanner.client.core.LiquidPlannerClient

Class Overview

This is the entry point for the LiquidPlanner client.

Summary

Fields
private ActivityService activityService
private CheckListItemService checkListItemService
private ClientService clientService
private CommentService commentService
private CustomFieldService customFieldService
private DocumentService documentService
private EventService eventService
private FolderService folderService
private LinkService linkService
private MemberService memberService
private MileStoneService milestoneService
private PackageService packageService
private ProjectService projectService
private TaskService taskService
private TimesheetEntryService timesheetEntryService
private TimesheetService timesheetService
private TreeItemService treeItemService
private WorkspaceService workspaceService
Public Constructors
LiquidPlannerClient(String user, String password)
Public Methods
Client createClient(String workSpaceId, Client client)
Comment createComment(String workSpaceId, Comment comment)
String createDocument(String workSpaceId, ServiceEntity entity, String entityId, String fileName, String fileDescription, InputStream fileInputStream)
Event createEvent(String workSpaceId, Event event)
Folder createFolder(String workSpaceId, Folder folder)
Link createLink(String workSpaceId, Link link)
Milestone createMilestone(String workSpaceId, Milestone milestone)
LPPackage createPackage(String workSpaceId, LPPackage aPackage)
Project createProject(String workSpaceId, Project project)
Create a new Project.
Task createTask(String workSpaceId, Task task)
Create a Task
Client deleteClient(String workSpaceId, String id)
Comment deleteComment(String workSpaceId, String commentId)
Document deleteDocument(String workSpaceId, String id)
Event deleteEvent(String workSpaceId, String commentId)
Folder deleteFolder(String workSpaceId, String id)
Link deleteLink(String workSpaceId, String id)
Milestone deleteMilestone(String workSpaceId, String id)
LPPackage deletePackage(String workSpaceId, String id)
Project deleteProject(String workSpaceId, String id)
Task deleteTask(String workSpaceId, String taskId)
InputStream downloadDocument(String workSpaceId, String documentId)
List<Activity> getActivities(String workSpaceId)
Activity getActivity(String workSpaceId, String activityId)
CheckListItem getCheckListItem(String workSpaceId, String checkListItemId)
List<CheckListItem> getCheckListItems(String workSpaceId)
Client getClient(String workSpaceId, String clientId)
List<Comment> getClientComments(String workSpaceId, String clientId)
List<Document> getClientDocuments(String workSpaceId, String clientId)
Estimate getClientEstimate(String workSpaceId, String clientId, String estimateId)
List<Estimate> getClientEstimates(String workSpaceId, String clientId)
List<Link> getClientLinks(String workSpaceId, String clientId)
Note getClientNote(String workSpaceId, String clientId)
List<Client> getClients(String workSpaceId)
Comment getComment(String workSpaceId, String commentId)
List<Comment> getComments(String workSpaceId)
CustomField getCustomField(String workSpaceId, String customFieldId)
List<CustomField> getCustomFields(String workSpaceId)
Document getDocument(String workSpaceId, String documentId)
List<Document> getDocuments(String workSpaceId)
Event getEvent(String workSpaceId, String eventId)
List<CheckListItem> getEventCheckListItems(String workSpaceId, String eventId)
List<Comment> getEventComments(String workSpaceId, String eventId)
List<Document> getEventDocuments(String workSpaceId, String eventId)
List<Link> getEventLinks(String workSpaceId, String eventId)
List<TimesheetEntry> getEventTimesheetEntries(String workSpaceId, String eventId)
List<Event> getEvents(String workSpaceId)
Folder getFolder(String workSpaceId, String folderId)
List<Folder> getFolders(String workSpaceId)
Link getLink(String workSpaceId, String linkId)
List<Link> getLinks(String workSpaceId)
Member getMember(String workspaceId, String memeberId)
Retrieve a particular member
List<Member> getMembers(String workspaceId)
Retrieve all the members related to a workspace
Milestone getMilestone(String workSpaceId, String mileStoneId)
List<Milestone> getMilestones(String workSpaceId)
LPPackage getPackage(String workSpaceId, String packageId)
Retrieve a particular package
List<Comment> getPackageComments(String workSpaceId, String packageId)
List<Dependency> getPackageDependencies(String workSpaceId, String packageId)
List<Document> getPackageDocuments(String workSpaceId, String packageId)
List<Estimate> getPackageEstimates(String workSpaceId, String packageId)
List<Link> getPackageLinks(String workSpaceId, String packageId)
List<Note> getPackageNote(String workSpaceId, String packageId)
List<LPPackage> getPackages(String workSpaceId, List<Filter> filters)
Retrieve all the packages related to a workspace
Project getProject(String workSpaceId, String projectId)
Retrieve a particular Project.
List<Comment> getProjectComments(String workSpaceId, String projectId)
Retrieve the comments related to a particular ProjectId.
List<Project> getProjects(String workSpaceId)
Retrieve List of Project.
Task getTask(String workSpaceId, String taskId)
Retrieves a particular task related to a workspace
Timesheet getTaskTimesheet(String workSpaceId, String taskId, String timesheetId)
Retrieves a particular time sheets
List<Timesheet> getTaskTimesheets(String workSpaceId, String taskId, List<Filter> filters)
Retrieves time sheets related to a particular task
List<Task> getTasks(String workSpaceId, List<Filter> filters)
Retrieves tasks related to a workspace
Timesheet getTimesheet(String workSpaceId, String timesheetId)
Returns a particular time sheet for the provided workspace.
List<TimesheetEntry> getTimesheetEntries(String workSpaceId, List<Filter> filters)
TimesheetEntry getTimesheetEntry(String workSpaceId, String timesheetEntryId)
List<Timesheet> getTimesheets(String workSpaceId, List<Filter> filters)
Returns a list of all the time sheets related to given project.
<T extends TreeItem> T getTreeItem(String workSpaceId, String treeItemId, Class<T> clazz)
String getTreeItems(String workSpaceId)
List<Workspace> getWorkSpaces()
Workspace getWorkspace(String workSpaceId)
Client updateClient(String workSpaceId, Client client)
Comment updateComment(String workSpaceId, Comment comment)
Document updateDocument(String workSpaceId, Document document)
Event updateEvent(String workSpaceId, Event event)
Folder updateFolder(String workSpaceId, Folder folder)
Link updateLink(String workSpaceId, Link link)
Milestone updateMilestone(String workSpaceId, Milestone milestone)
LPPackage updatePackage(String workSpaceId, LPPackage lpPackage)
Project updateProject(String workSpaceId, Project project)
Task updateTask(String workSpaceId, Task task)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.mule.LiquidPlanner.client.services.ActivityService
From interface org.mule.LiquidPlanner.client.services.CheckListItemService
From interface org.mule.LiquidPlanner.client.services.ClientService
From interface org.mule.LiquidPlanner.client.services.CommentService
From interface org.mule.LiquidPlanner.client.services.CustomFieldService
From interface org.mule.LiquidPlanner.client.services.DocumentService
From interface org.mule.LiquidPlanner.client.services.EventService
From interface org.mule.LiquidPlanner.client.services.FolderService
From interface org.mule.LiquidPlanner.client.services.LinkService
From interface org.mule.LiquidPlanner.client.services.MemberService
From interface org.mule.LiquidPlanner.client.services.MileStoneService
From interface org.mule.LiquidPlanner.client.services.PackageService
From interface org.mule.LiquidPlanner.client.services.ProjectService
From interface org.mule.LiquidPlanner.client.services.TaskService
From interface org.mule.LiquidPlanner.client.services.TimesheetEntryService
From interface org.mule.LiquidPlanner.client.services.TimesheetService
From interface org.mule.LiquidPlanner.client.services.TreeItemService
From interface org.mule.LiquidPlanner.client.services.WorkspaceService

Fields

private ActivityService activityService

private CheckListItemService checkListItemService

private ClientService clientService

private CommentService commentService

private CustomFieldService customFieldService

private DocumentService documentService

private EventService eventService

private FolderService folderService

private LinkService linkService

private MemberService memberService

private MileStoneService milestoneService

private PackageService packageService

private ProjectService projectService

private TaskService taskService

private TimesheetEntryService timesheetEntryService

private TimesheetService timesheetService

private TreeItemService treeItemService

private WorkspaceService workspaceService

Public Constructors

public LiquidPlannerClient (String user, String password)

Parameters
user
password

Public Methods

public Client createClient (String workSpaceId, Client client)

Parameters
workSpaceId
client

public Comment createComment (String workSpaceId, Comment comment)

Parameters
workSpaceId
comment

public String createDocument (String workSpaceId, ServiceEntity entity, String entityId, String fileName, String fileDescription, InputStream fileInputStream)

Parameters
workSpaceId
entity
entityId
fileName
fileDescription
fileInputStream

public Event createEvent (String workSpaceId, Event event)

Parameters
workSpaceId
event

public Folder createFolder (String workSpaceId, Folder folder)

Parameters
workSpaceId
folder

public Link createLink (String workSpaceId, Link link)

Parameters
workSpaceId
link

public Milestone createMilestone (String workSpaceId, Milestone milestone)

Parameters
workSpaceId
milestone

public LPPackage createPackage (String workSpaceId, LPPackage aPackage)

Parameters
workSpaceId
aPackage

public Project createProject (String workSpaceId, Project project)

Create a new Project.

Parameters
workSpaceId
project

public Task createTask (String workSpaceId, Task task)

Create a Task

Parameters
workSpaceId
task

public Client deleteClient (String workSpaceId, String id)

Parameters
workSpaceId
id

public Comment deleteComment (String workSpaceId, String commentId)

Parameters
workSpaceId
commentId

public Document deleteDocument (String workSpaceId, String id)

Parameters
workSpaceId
id

public Event deleteEvent (String workSpaceId, String commentId)

Parameters
workSpaceId
commentId

public Folder deleteFolder (String workSpaceId, String id)

Parameters
workSpaceId
id

public Link deleteLink (String workSpaceId, String id)

Parameters
workSpaceId
id

public Milestone deleteMilestone (String workSpaceId, String id)

Parameters
workSpaceId
id

public LPPackage deletePackage (String workSpaceId, String id)

Parameters
workSpaceId
id

public Project deleteProject (String workSpaceId, String id)

Parameters
workSpaceId
id

public Task deleteTask (String workSpaceId, String taskId)

Parameters
workSpaceId
taskId

public InputStream downloadDocument (String workSpaceId, String documentId)

Parameters
workSpaceId
documentId

public List<Activity> getActivities (String workSpaceId)

Parameters
workSpaceId

public Activity getActivity (String workSpaceId, String activityId)

Parameters
workSpaceId
activityId

public CheckListItem getCheckListItem (String workSpaceId, String checkListItemId)

Parameters
workSpaceId
checkListItemId

public List<CheckListItem> getCheckListItems (String workSpaceId)

Parameters
workSpaceId

public Client getClient (String workSpaceId, String clientId)

Parameters
workSpaceId
clientId

public List<Comment> getClientComments (String workSpaceId, String clientId)

Parameters
workSpaceId
clientId

public List<Document> getClientDocuments (String workSpaceId, String clientId)

Parameters
workSpaceId
clientId

public Estimate getClientEstimate (String workSpaceId, String clientId, String estimateId)

Parameters
workSpaceId
clientId
estimateId

public List<Estimate> getClientEstimates (String workSpaceId, String clientId)

Parameters
workSpaceId
clientId

public List<Link> getClientLinks (String workSpaceId, String clientId)

Parameters
workSpaceId
clientId

public Note getClientNote (String workSpaceId, String clientId)

Parameters
workSpaceId
clientId

public List<Client> getClients (String workSpaceId)

Parameters
workSpaceId

public Comment getComment (String workSpaceId, String commentId)

Parameters
workSpaceId
commentId

public List<Comment> getComments (String workSpaceId)

Parameters
workSpaceId

public CustomField getCustomField (String workSpaceId, String customFieldId)

Parameters
workSpaceId
customFieldId

public List<CustomField> getCustomFields (String workSpaceId)

Parameters
workSpaceId

public Document getDocument (String workSpaceId, String documentId)

Parameters
workSpaceId
documentId

public List<Document> getDocuments (String workSpaceId)

Parameters
workSpaceId

public Event getEvent (String workSpaceId, String eventId)

Parameters
workSpaceId
eventId

public List<CheckListItem> getEventCheckListItems (String workSpaceId, String eventId)

Parameters
workSpaceId
eventId

public List<Comment> getEventComments (String workSpaceId, String eventId)

Parameters
workSpaceId
eventId

public List<Document> getEventDocuments (String workSpaceId, String eventId)

Parameters
workSpaceId
eventId

public List<Link> getEventLinks (String workSpaceId, String eventId)

Parameters
workSpaceId
eventId

public List<TimesheetEntry> getEventTimesheetEntries (String workSpaceId, String eventId)

Parameters
workSpaceId
eventId

public List<Event> getEvents (String workSpaceId)

Parameters
workSpaceId

public Folder getFolder (String workSpaceId, String folderId)

Parameters
workSpaceId
folderId

public List<Folder> getFolders (String workSpaceId)

Parameters
workSpaceId

public Link getLink (String workSpaceId, String linkId)

Parameters
workSpaceId
linkId

public List<Link> getLinks (String workSpaceId)

Parameters
workSpaceId

public Member getMember (String workspaceId, String memeberId)

Retrieve a particular member

Parameters
workspaceId
memeberId

public List<Member> getMembers (String workspaceId)

Retrieve all the members related to a workspace

Parameters
workspaceId

public Milestone getMilestone (String workSpaceId, String mileStoneId)

Parameters
workSpaceId
mileStoneId

public List<Milestone> getMilestones (String workSpaceId)

Parameters
workSpaceId

public LPPackage getPackage (String workSpaceId, String packageId)

Retrieve a particular package

Parameters
workSpaceId
packageId

public List<Comment> getPackageComments (String workSpaceId, String packageId)

Parameters
workSpaceId
packageId

public List<Dependency> getPackageDependencies (String workSpaceId, String packageId)

Parameters
workSpaceId
packageId

public List<Document> getPackageDocuments (String workSpaceId, String packageId)

Parameters
workSpaceId
packageId

public List<Estimate> getPackageEstimates (String workSpaceId, String packageId)

Parameters
workSpaceId
packageId

public List<Link> getPackageLinks (String workSpaceId, String packageId)

Parameters
workSpaceId
packageId

public List<Note> getPackageNote (String workSpaceId, String packageId)

Parameters
workSpaceId
packageId

public List<LPPackage> getPackages (String workSpaceId, List<Filter> filters)

Retrieve all the packages related to a workspace

Parameters
workSpaceId
filters

public Project getProject (String workSpaceId, String projectId)

Retrieve a particular Project.

Parameters
workSpaceId
projectId

public List<Comment> getProjectComments (String workSpaceId, String projectId)

Retrieve the comments related to a particular ProjectId.

Parameters
workSpaceId
projectId

public List<Project> getProjects (String workSpaceId)

Retrieve List of Project.

Parameters
workSpaceId

public Task getTask (String workSpaceId, String taskId)

Retrieves a particular task related to a workspace

Parameters
workSpaceId
taskId

public Timesheet getTaskTimesheet (String workSpaceId, String taskId, String timesheetId)

Retrieves a particular time sheets

Parameters
workSpaceId
taskId
timesheetId

public List<Timesheet> getTaskTimesheets (String workSpaceId, String taskId, List<Filter> filters)

Retrieves time sheets related to a particular task

Parameters
workSpaceId
taskId
filters

public List<Task> getTasks (String workSpaceId, List<Filter> filters)

Retrieves tasks related to a workspace

Parameters
workSpaceId
filters

public Timesheet getTimesheet (String workSpaceId, String timesheetId)

Returns a particular time sheet for the provided workspace.

Parameters
workSpaceId
timesheetId

public List<TimesheetEntry> getTimesheetEntries (String workSpaceId, List<Filter> filters)

Parameters
workSpaceId
filters

public TimesheetEntry getTimesheetEntry (String workSpaceId, String timesheetEntryId)

Parameters
workSpaceId
timesheetEntryId

public List<Timesheet> getTimesheets (String workSpaceId, List<Filter> filters)

Returns a list of all the time sheets related to given project.

Parameters
workSpaceId
filters

public T getTreeItem (String workSpaceId, String treeItemId, Class<T> clazz)

Parameters
workSpaceId
treeItemId
clazz

public String getTreeItems (String workSpaceId)

Parameters
workSpaceId

public List<Workspace> getWorkSpaces ()

public Workspace getWorkspace (String workSpaceId)

Parameters
workSpaceId

public Client updateClient (String workSpaceId, Client client)

Parameters
workSpaceId
client

public Comment updateComment (String workSpaceId, Comment comment)

Parameters
workSpaceId
comment

public Document updateDocument (String workSpaceId, Document document)

Parameters
workSpaceId
document

public Event updateEvent (String workSpaceId, Event event)

Parameters
workSpaceId
event

public Folder updateFolder (String workSpaceId, Folder folder)

Parameters
workSpaceId
folder

public Link updateLink (String workSpaceId, Link link)

Parameters
workSpaceId
link

public Milestone updateMilestone (String workSpaceId, Milestone milestone)

Parameters
workSpaceId
milestone

public LPPackage updatePackage (String workSpaceId, LPPackage lpPackage)

Parameters
workSpaceId
lpPackage

public Project updateProject (String workSpaceId, Project project)

Parameters
workSpaceId
project

public Task updateTask (String workSpaceId, Task task)

Parameters
workSpaceId
task