Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.podio.item;
import java.util.List;
import java.util.Map;
import javax.ws.rs.core.MediaType;
import com.podio.BaseAPI;
import com.podio.ResourceFactory;
import com.podio.filter.ExternalIdFilterBy;
import com.podio.filter.FilterByValue;
import com.podio.filter.SortBy;
import com.sun.jersey.api.client.GenericType;
import com.sun.jersey.api.client.WebResource;
/**
* Items are entries in an app. If you think of app as a table, items will be
* the rows in the table. Items consists of some basic information as well
* values for each of the fields in the app. For each field there can be
* multiple values (F.ex. there can be multiple links to another app) and
* multiple types of values (F.ex. a field of type date field consists of both a
* start date and an optional end date). The type is denoted by an string id
* called a sub_id. Most types of fields have only one type, which is denoted by
* the sub_id values. Others have multiple sub_ids.
*/
public class ItemAPI extends BaseAPI {
public ItemAPI(ResourceFactory resourceFactory) {
super(resourceFactory);
}
/**
* Adds a new item to the given app.
*
* @param appId
* The id of the app the item should be added to
* @param create
* The data for the new item
* @param silent
* True if the create should be silten, false otherwise
* @return The id of the newly created item
*/
public int addItem(int appId, ItemCreate create, boolean silent) {
return getResourceFactory().getApiResource("/item/app/" + appId + "/")
.queryParam("silent", silent ? "1" : "0")
.entity(create, MediaType.APPLICATION_JSON_TYPE)
.post(ItemCreateResponse.class).getId();
}
/**
* Gets the item with the given id
*
* @param itemId
* The id of the item
* @return The item with given id
*/
public Item getItem(int itemId) {
return getResourceFactory().getApiResource("/item/" + itemId).get(
Item.class);
}
/**
* Updates the entire item. Only fields which have values specified will be
* updated. To delete the contents of a field, pass an empty array for the
* value.
*
* @param itemId
* The id of the item to update
* @param update
* The data for the update
* @param silent
* True if the update should be silent, false otherwise
* @param hook
* True if hooks should be executed for the change, false otherwise
*/
public void updateItem(int itemId, ItemUpdate update, boolean silent, boolean hook) {
getResourceFactory().getApiResource("/item/" + itemId)
.queryParam("silent", silent ? "1" : "0")
.queryParam("hook", hook ? "1" : "0")
.entity(update, MediaType.APPLICATION_JSON_TYPE).put();
}
/**
* Updates all the values for an item
*
* @param itemId
* The id of the item
* @param values
* The values for the fields
* @param silent
* True if the update should be silent, false otherwise
* @param hook
* True if hooks should be executed for the change, false otherwise
*/
public void updateItemValues(int itemId, List values,
boolean silent, boolean hook) {
getResourceFactory().getApiResource("/item/" + itemId + "/value/")
.queryParam("silent", silent ? "1" : "0")
.queryParam("hook", hook ? "1" : "0")
.entity(values, MediaType.APPLICATION_JSON_TYPE).put();
}
/**
* Update the item values for a specific field.
*
* @param itemId
* The id of the item
* @param fieldId
* The id of the field
* @param values
* The new values for the field
* @param silent
* True if the update should be silent, false otherwise
* @param hook
* True if hooks should be executed for the change, false otherwise
*/
public void updateItemFieldValues(int itemId, int fieldId,
List> values, boolean silent, boolean hook) {
getResourceFactory()
.getApiResource("/item/" + itemId + "/value/" + fieldId)
.queryParam("silent", silent ? "1" : "0")
.queryParam("hook", hook ? "1" : "0")
.entity(values, MediaType.APPLICATION_JSON_TYPE).put();
}
/**
* Deletes an item and removes it from all views. The data can no longer be
* retrieved.
*
* @param itemId
* The id of the item
* @param silent
* True if the deletion should be silent, false otherwise
*/
public void deleteItem(int itemId, boolean silent) {
getResourceFactory().getApiResource("/item/" + itemId)
.queryParam("silent", silent ? "1" : "0").delete();
}
/**
* Returns the values for a specified field on an item
*
* @param itemId
* The id of the item
* @param fieldId
* The id of the field
* @return The values on the field on the item
*/
public List> getItemFieldValues(int itemId, int fieldId) {
return getResourceFactory().getApiResource(
"/item/" + itemId + "/value/" + fieldId).get(
new GenericType>>() {
});
}
/**
* Returns all the values for an item, with the additional data provided by
* the get item operation.
*
* @param itemId
* The id of the item
* @return The values on the item
*/
public List getItemValues(int itemId) {
return getResourceFactory().getApiResource(
"/item/" + itemId + "/value/").get(
new GenericType>() {
});
}
/**
* Used to find possible items for a given application field. It searches
* the relevant items for the title given.
*
* @param fieldId
* The id of app reference field to search for
* @param text
* The text to search for in the items title
* @return The items that were valid for the field and with text matching
*/
public List getItemsByFieldAndTitle(int fieldId, String text) {
return getResourceFactory()
.getApiResource("/item/field/" + fieldId + "/find")
.queryParam("text", text)
.get(new GenericType>() {
});
}
/**
* Returns the items that have a reference to the given item. The references
* are grouped by app. Both the apps and the items are sorted by title.
*
* @param itemId
* The id of the item
* @return The references to the given item
*/
public List getItemReference(int itemId) {
return getResourceFactory().getApiResource(
"/item/" + itemId + "/reference/").get(
new GenericType>() {
});
}
/**
* Returns the data about the specific revision on an item
*
* @param itemId
* The id of the item
* @param revisionId
* The running revision number, starts at 0 for the initial
* revision
* @return The revision
*/
public ItemRevision getItemRevision(int itemId, int revisionId) {
return getResourceFactory().getApiResource(
"/item/" + itemId + "/revision/" + revisionId).get(
ItemRevision.class);
}
/**
* Returns the difference in fields values between the two revisions.
*
* @param itemId
* The id of the item
* @param revisionFrom
* The from revision
* @param revisionTo
* The to revision
* @return The difference between the two revision
*/
public List getItemRevisionDifference(int itemId,
int revisionFrom, int revisionTo) {
return getResourceFactory().getApiResource(
"/item/" + itemId + "/revision/" + revisionFrom + "/"
+ revisionTo).get(
new GenericType>() {
});
}
/**
* Returns all the revisions that have been made to an item
*
* @param itemId
* The id of the item
* @return All the revisions
*/
public List getItemRevisions(int itemId) {
return getResourceFactory().getApiResource(
"/item/" + itemId + "/revision/").get(
new GenericType>() {
});
}
/**
* Returns the items on app matching the given filters.
*
* @param appId
* The id of the app
* @param limit
* The maximum number of items to receive, defaults to 20
* @param offset
* The offset from the start of the items returned, defaults to 0
* @param sortBy
* How the items should be sorted. For the possible options, see
* the filter area.
* @param sortDesc
* true or leave out to sort descending, use
* false to sort ascending
* @param filters
* The filters to apply
* @return The items matching the filters
*/
public ItemsResponse getItems(int appId, Integer limit, Integer offset,
SortBy sortBy, Boolean sortDesc, FilterByValue... filters) {
WebResource resource = getResourceFactory().getApiResource(
"/item/app/" + appId + "/v2/");
if (limit != null) {
resource = resource.queryParam("limit", limit.toString());
}
if (offset != null) {
resource = resource.queryParam("offset", offset.toString());
}
if (sortBy != null) {
resource = resource.queryParam("sort_by", sortBy.getKey());
}
if (sortDesc != null) {
resource = resource.queryParam("sort_desc", sortDesc ? "1" : "0");
}
for (FilterByValue filter : filters) {
resource = resource.queryParam(filter.getBy().getKey(),
filter.getFormattedValue());
}
return resource.get(ItemsResponse.class);
}
/**
* Utility method to get items matching an external id
*
* @param appId
* The id of the app
* @param externalId
* The external id
* @return The items matching the app and external id
*/
public ItemsResponse getItemsByExternalId(int appId, String externalId) {
return getItems(appId, null, null, null, null,
new FilterByValue(new ExternalIdFilterBy(), externalId));
}
}
