Package MarcSync

Klasse Collection

java.lang.Object

MarcSync.Collection

public class Collection
extends Object

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Collection(String accessToken, String collectionName)	Creates a new instance of the MarcSync collection

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

Collection

public Collection(String accessToken,
 String collectionName)

Creates a new instance of the MarcSync collection

Parameter:

accessToken - The access token to use for communication with MarcSync

collectionName - The name of the collection to use

Siehe auch:

• Client

Methodendetails

drop

public void drop()
          throws URISyntaxException,
IOException

Warning:

Löst aus:

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

Gibt zurück:

The name of the collection

Löst aus:

URISyntaxException

IOException

getName

public String getName()

Gibt zurück:

The name of the collection

exists

public boolean exists()

Gibt zurück:

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

Gibt zurück:

A new instance of the MarcSync entry

Löst aus:

URISyntaxException

IOException

getEntryById

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

Gibt zurück:

The entry with the specified ID

Löst aus:

URISyntaxException

IOException

InterruptedException

getEntries

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

Gibt zurück:

The entries with the specified filter

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

Löst aus:

IOException

InterruptedException

URISyntaxException

Siehe auch:

• 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.

Löst aus:

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.

Löst aus:

URISyntaxException

IOException

Siehe auch:

• EntryData

updateEntryById

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

Updates the entry with the specified ID

Löst aus:

URISyntaxException

IOException

Siehe auch:

• Entry
• EntryData

updateEntries

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

Updates the entries matching with the specified filter

Löst aus:

URISyntaxException

IOException

Siehe auch:

• Entry
• EntryData