public class

PackageServiceClient

extends AbstractServiceClient
implements PackageService
java.lang.Object
   ↳ org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
     ↳ org.mule.LiquidPlanner.client.services.impl.PackageServiceClient

Summary

Constants
String API_MOVE_AFTER_PATH
String API_MOVE_BEFORE_PATH
String API_SNAPSHOT_PATH
String API_TRACK_TIME_PATH
[Expand]
Inherited Constants
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
[Expand]
Inherited Fields
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
Public Constructors
PackageServiceClient(String user, String password)
Public Methods
LPPackage createPackage(String workSpaceId, LPPackage aPackage)
LPPackage deletePackage(String workSpaceId, String id)
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
LPPackage updatePackage(String workSpaceId, LPPackage lpPackage)
Protected Methods
String extendGetBaseUrl(String baseUrl)
This method is called by getBaseURL for the user to extend the base URL of its ServiceClient implementation.
ClientConfig getJerseyClientConfiguration()
This method is called by getBuilder before the creation of the Client.
List<ClientFilter> getJerseyClientFilters()
This method is called by getBuilder before the creation of the Client.
[Expand]
Inherited Methods
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
From class java.lang.Object
From interface org.mule.LiquidPlanner.client.services.PackageService

Constants

private static final String API_MOVE_AFTER_PATH

Constant Value: "/move_after"

private static final String API_MOVE_BEFORE_PATH

Constant Value: "/move_before"

private static final String API_SNAPSHOT_PATH

Constant Value: "/snapshots"

private static final String API_TRACK_TIME_PATH

Constant Value: "/track_time"

Public Constructors

public PackageServiceClient (String user, String password)

Parameters
user
password

Public Methods

public LPPackage createPackage (String workSpaceId, LPPackage aPackage)

Parameters
workSpaceId
aPackage

public LPPackage deletePackage (String workSpaceId, String id)

Parameters
workSpaceId
id

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 LPPackage updatePackage (String workSpaceId, LPPackage lpPackage)

Parameters
workSpaceId
lpPackage

Protected Methods

protected String extendGetBaseUrl (String baseUrl)

This method is called by getBaseURL for the user to extend the base URL of its ServiceClient implementation.

Parameters
baseUrl The URL created by getBaseURL
Returns
  • the enhanced base URL

protected ClientConfig getJerseyClientConfiguration ()

This method is called by getBuilder before the creation of the Client. The ClientConfig is used to create the Client.

Returns
  • null if there are ClientConfig to be added.

protected List<ClientFilter> getJerseyClientFilters ()

This method is called by getBuilder before the creation of the Client. The ClientFilter is used to create the Client. If there are no ClientFilter to be added just return null.

Returns
  • null if there are no ClientFilter to be added.