|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectCosm.Cosm
public class Cosm
The Cosm class provides the methods for interfacing with the Cosm (www.cosm.com) webservice.
Field Summary | |
---|---|
static java.lang.String |
VERSION
|
Constructor Summary | |
---|---|
Cosm(java.lang.String apikey)
Constructor based on access with an Cosm API key |
|
Cosm(java.lang.String username,
java.lang.String password)
Constructor based on access with a username and password |
Method Summary | |
---|---|
Apikey |
createApikey(Apikey apikey)
|
void |
createDatapoint(java.lang.Integer feedid,
java.lang.String datastreamid,
Datapoint datapoint)
|
void |
createDatapoints(java.lang.Integer feedid,
java.lang.String datastreamid,
Datapoint[] datapoints)
|
Datastream |
createDatastream(java.lang.Integer feedid,
Datastream datastream)
|
Feed |
createFeed(Feed feed)
|
Group |
createGroup(Group group)
|
Trigger |
createTrigger(Trigger trigger)
|
void |
createUser(User user)
|
void |
deleteApikey(java.lang.String apikey)
|
void |
deleteDatapoint(java.lang.Integer feedid,
java.lang.String datastreamid,
java.lang.String at)
|
void |
deleteDatapoints(java.lang.Integer feedid,
java.lang.String datastreamid,
java.lang.String start,
java.lang.String end,
java.lang.String duration)
|
void |
deleteDatastream(java.lang.Integer feedid,
java.lang.String datastreamid)
|
void |
deleteFeed(java.lang.Integer feedid)
|
void |
deleteGroup(java.lang.String groupid)
|
void |
deleteTrigger(java.lang.Integer id)
|
void |
deleteUser(java.lang.String login)
|
Apikey |
getApikey(java.lang.String apikey)
|
Apikey[] |
getApikeys()
|
Datapoint |
getDatapoint(java.lang.Integer feedid,
java.lang.String datastreamid,
java.lang.String at)
|
Datapoint[] |
getDatapoints(java.lang.Integer feedid,
java.lang.String datastreamid,
java.lang.String start,
java.lang.String end,
java.lang.String duration,
java.lang.Integer interval,
java.lang.Boolean find_previous,
Interval_type interval_type,
int per_page,
java.lang.String timezone)
|
Datastream |
getDatastream(java.lang.Integer feedid,
java.lang.String datastreamid)
|
Datastream[] |
getDatastreams(java.lang.Integer feedid)
|
Feed |
getFeed(int feedid)
Retrieve a Feed object from Cosm retrieves a Feed object by its identifier. |
Feed |
getFeed(int feedid,
java.lang.Boolean show_user)
Get a feed object by its feed identifier |
Feed[] |
getFeeds()
|
Feed[] |
getFeeds(java.lang.String query,
Content content,
java.lang.String tag,
java.lang.String user,
java.lang.String units,
Status status,
Order order,
java.lang.Boolean show_user)
returns a list of feed objects based on a number of optional query parameters. |
Group |
getGroup(java.lang.String groupid)
|
Group[] |
getGroups()
|
Trigger |
getTrigger(java.lang.Integer id)
|
Trigger[] |
getTriggers()
|
User |
getUser(java.lang.String login)
|
User[] |
getUsers()
|
Waypoint[] |
getWaypoints(java.lang.Integer feedid,
java.lang.String start,
java.lang.String end,
java.lang.String duration,
java.lang.Integer interval,
java.lang.Boolean find_previous,
Interval_type interval_type,
java.lang.String timezone)
|
void |
updateDatapoint(java.lang.Integer feedid,
java.lang.String datastreamid,
Datapoint datapoint)
|
void |
updateDatastream(java.lang.Integer feedid,
java.lang.String datastreamid,
Datastream datastream)
|
void |
updateFeed(Feed feed)
|
void |
updateGroup(Group group)
|
void |
updateTrigger(Trigger trigger)
|
void |
updateUser(java.lang.String login,
User user)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VERSION
Constructor Detail |
---|
public Cosm(java.lang.String apikey)
apikey
- Cosm API keypublic Cosm(java.lang.String username, java.lang.String password)
username
- Cosm username (or login)password
- Cosm passwordMethod Detail |
---|
public Feed getFeed(int feedid) throws CosmException
feedid
- identifier of the Cosm feed
CosmException
public Feed getFeed(int feedid, java.lang.Boolean show_user) throws CosmException
feedid
- Id of the Cosm feed to retrieve
CosmException
- If something goes wrong, or if the Feed was not found.public Feed[] getFeeds(java.lang.String query, Content content, java.lang.String tag, java.lang.String user, java.lang.String units, Status status, Order order, java.lang.Boolean show_user) throws CosmException
null
, a parameter is ignored.
query
- Full text String
search parameter. Should return any feeds matching this stringcontent
- parameter of type Content
describing the type of resultstag
- Returns feeds containing datastreams tagged with the search queryuser
- Returns feeds created by the user specified.units
- Returns feeds containing datastreams with units specified by the search query.status
- Parameter of type Status
order
- Parameter of type Order
. Used for ordering the results.show_user
- Include user login and user level for each feed. Boolean
with possible values: true, false (default)
Feed
objects
CosmException
public Feed[] getFeeds() throws CosmException
CosmException
public void deleteFeed(java.lang.Integer feedid) throws CosmException
CosmException
public Feed createFeed(Feed feed) throws CosmException
CosmException
public void updateFeed(Feed feed) throws CosmException
CosmException
public Group createGroup(Group group) throws CosmException
CosmException
public Group getGroup(java.lang.String groupid) throws CosmException
CosmException
public Group[] getGroups() throws CosmException
CosmException
public void updateGroup(Group group) throws CosmException
CosmException
public void deleteGroup(java.lang.String groupid) throws CosmException
CosmException
public Datastream getDatastream(java.lang.Integer feedid, java.lang.String datastreamid) throws CosmException
CosmException
public Datastream[] getDatastreams(java.lang.Integer feedid) throws CosmException
CosmException
public Datastream createDatastream(java.lang.Integer feedid, Datastream datastream) throws CosmException
CosmException
public void updateDatastream(java.lang.Integer feedid, java.lang.String datastreamid, Datastream datastream) throws CosmException
CosmException
public void deleteDatastream(java.lang.Integer feedid, java.lang.String datastreamid) throws CosmException
CosmException
public void createDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, Datapoint datapoint) throws CosmException
CosmException
public void createDatapoints(java.lang.Integer feedid, java.lang.String datastreamid, Datapoint[] datapoints) throws CosmException
CosmException
public void updateDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, Datapoint datapoint) throws CosmException
CosmException
public Datapoint getDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String at) throws CosmException
CosmException
public void deleteDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String at) throws CosmException
CosmException
public void deleteDatapoints(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String start, java.lang.String end, java.lang.String duration) throws CosmException
CosmException
public Waypoint[] getWaypoints(java.lang.Integer feedid, java.lang.String start, java.lang.String end, java.lang.String duration, java.lang.Integer interval, java.lang.Boolean find_previous, Interval_type interval_type, java.lang.String timezone) throws CosmException
CosmException
public Datapoint[] getDatapoints(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String start, java.lang.String end, java.lang.String duration, java.lang.Integer interval, java.lang.Boolean find_previous, Interval_type interval_type, int per_page, java.lang.String timezone) throws CosmException
CosmException
public Apikey createApikey(Apikey apikey) throws CosmException
CosmException
public Apikey getApikey(java.lang.String apikey) throws CosmException
CosmException
public Apikey[] getApikeys() throws CosmException
CosmException
public void deleteApikey(java.lang.String apikey) throws CosmException
CosmException
public Trigger getTrigger(java.lang.Integer id) throws CosmException
CosmException
public Trigger[] getTriggers() throws CosmException
CosmException
public void deleteTrigger(java.lang.Integer id) throws CosmException
CosmException
public Trigger createTrigger(Trigger trigger) throws CosmException
CosmException
public void updateTrigger(Trigger trigger) throws CosmException
CosmException
public User getUser(java.lang.String login) throws CosmException
CosmException
public User[] getUsers() throws CosmException
CosmException
public void deleteUser(java.lang.String login) throws CosmException
CosmException
public void updateUser(java.lang.String login, User user) throws CosmException
CosmException
public void createUser(User user) throws CosmException
CosmException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |