Package MarcSync

Class Collection

java.lang.Object

MarcSync.Collection

public class Collection
extends Object

Constructor Summary

Constructors

Constructor	Description
Collection(String accessToken, String collectionName)	Creates a new instance of the MarcSync collection

Method Summary

Modifier and Type	Method	Description
Entry	createEntry(EntryData entryData)	Creates an entry in the collection
void	deleteEntries(EntryData filters)	Deletes the entries matching with the specified filter
void	deleteEntryById(String id)	Deletes the entry with the specified ID
void	drop()	Warning:
boolean	exists()
Entry[]	getEntries(EntryData filters)
Entry	getEntryById(String id)
String	getName()
String	setName(String name)
void	updateEntries(EntryData filters, EntryData entryData)	Updates the entries matching with the specified filter
void	updateEntryById(String id, EntryData entryData)	Updates the entry with the specified ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Collection

public Collection(String accessToken,
                  String collectionName)

Creates a new instance of the MarcSync collection

Parameters:

accessToken - The access token to use for communication with MarcSync

collectionName - The name of the collection to use

See Also:

Client

Method Detail

drop

public void drop()
          throws URISyntaxException,
                 IOException

Warning:

Throws:

URISyntaxException

IOException -

Note: This method will delete the collection and all of its entries. This action cannot be undone.

setName

public String setName(String name)
               throws URISyntaxException,
                      IOException

Returns:

The name of the collection

Throws:

URISyntaxException

IOException

getName

public String getName()

Returns:

The name of the collection

exists

public boolean exists()

Returns:

Whether or not the collection exists

Note: This method is useful if you want to fetch the collection from the server to check if it exists before using it.

createEntry

public Entry createEntry(EntryData entryData)
                  throws URISyntaxException,
                         IOException

Creates an entry in the collection

Returns:

A new instance of the MarcSync entry

Throws:

URISyntaxException

IOException

getEntryById

public Entry getEntryById(String id)
                   throws URISyntaxException,
                          IOException,
                          InterruptedException

Returns:

The entry with the specified ID

Throws:

URISyntaxException

IOException

InterruptedException

getEntries

public Entry[] getEntries(EntryData filters)
                   throws IOException,
                          InterruptedException,
                          URISyntaxException

Returns:

The entries with the specified filter

Note: This method is useful if you want to fetch multiple entries from the server at once.

Throws:

IOException

InterruptedException

URISyntaxException

See Also:

Entry, EntryData

deleteEntryById

public void deleteEntryById(String id)
                     throws URISyntaxException,
                            IOException

Deletes the entry with the specified ID

Note: Will delete the entry from the collection. This action cannot be undone.

Throws:

URISyntaxException

IOException

deleteEntries

public void deleteEntries(EntryData filters)
                   throws URISyntaxException,
                          IOException

Deletes the entries matching with the specified filter

Note: Will delete the matching entries from the collection. This action cannot be undone.

Throws:

URISyntaxException

IOException

See Also:

EntryData

updateEntryById

public void updateEntryById(String id,
                            EntryData entryData)
                     throws URISyntaxException,
                            IOException

Updates the entry with the specified ID

Throws:

URISyntaxException

IOException

See Also:

Entry, EntryData

updateEntries

public void updateEntries(EntryData filters,
                          EntryData entryData)
                   throws URISyntaxException,
                          IOException

Updates the entries matching with the specified filter

Throws:

URISyntaxException

IOException

See Also:

Entry, EntryData