org.gedcomx.rs.client

Class CollectionsState

java.lang.Object

org.gedcomx.rs.client.GedcomxApplicationState<org.gedcomx.Gedcomx>

org.gedcomx.rs.client.CollectionsState

public class CollectionsState
extends GedcomxApplicationState<org.gedcomx.Gedcomx>

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.rs.client.GedcomxApplicationState

accessToken, client, DEFAULT_EMBEDDED_LINK_LOADER, entity, links, request, response, stateFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionsState(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response, String accessToken, StateFactory stateFactory)

Method Summary

Modifier and Type	Method and Description
CollectionState	addCollection(org.gedcomx.records.Collection collection, org.gedcomx.source.SourceDescription sourceDescription, StateTransitionOption... options)
CollectionState	addCollection(org.gedcomx.records.Collection collection, StateTransitionOption... options)
CollectionState	addCollection(org.gedcomx.source.SourceDescription description, StateTransitionOption... options)
protected CollectionsState	clone(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response)
CollectionsState	delete(StateTransitionOption... options)
CollectionsState	get(StateTransitionOption... options)
List<org.gedcomx.records.Collection>	getCollections()
protected org.gedcomx.links.SupportsLinks	getMainDataElement()
List<org.gedcomx.source.SourceDescription>	getSourceDescriptions()
CollectionsState	head(StateTransitionOption... options)
CollectionsState	ifSuccessful()
protected org.gedcomx.Gedcomx	loadEntity(com.sun.jersey.api.client.ClientResponse response)
CollectionsState	options(StateTransitionOption... options)
CollectionsState	post(org.gedcomx.Gedcomx entity, StateTransitionOption... options)
CollectionsState	put(org.gedcomx.Gedcomx e, StateTransitionOption... options)
CollectionState	readCollection(org.gedcomx.records.Collection collection, StateTransitionOption... options)
CollectionState	readCollection(org.gedcomx.source.SourceDescription sourceDescription, StateTransitionOption... options)
CollectionState	readCollection(StateTransitionOption... options)
CollectionState	readFirstPage(StateTransitionOption... options)
CollectionState	readLastPage(StateTransitionOption... options)
CollectionState	readNextPage(StateTransitionOption... options)
CollectionState	readPreviousPage(StateTransitionOption... options)
CollectionState	updateCollection(org.gedcomx.records.Collection collection, StateTransitionOption... options)

Methods inherited from class org.gedcomx.rs.client.GedcomxApplicationState

authenticateViaOAuth2, authenticateViaOAuth2AuthCode, authenticateViaOAuth2AuthCode, authenticateViaOAuth2ClientCredentials, authenticateViaOAuth2Password, authenticateViaOAuth2Password, authenticateWithAccessToken, buildFailureMessage, createAuthenticatedFeedRequest, createAuthenticatedGedcomxRequest, createAuthenticatedRequest, createRequest, createRequestForEmbeddedResource, embed, embed, getAccessToken, getClient, getDescription, getEmbeddedLinkLoader, getEntity, getETag, getHeaders, getLastEmbeddedRequest, getLastEmbeddedResponse, getLastModified, getLink, getLinks, getRequest, getResponse, getSelfRel, getSelfUri, getUri, getWarnings, hasClientError, hasError, hasServerError, hasStatus, includeEmbeddedResources, inject, invoke, isAuthenticated, isEmbeddedLinkLoaded, loadEntityConditionally, loadLinks, readContributor, readContributor, readContributor, readPage

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionsState

protected CollectionsState(com.sun.jersey.api.client.ClientRequest request,
                           com.sun.jersey.api.client.ClientResponse response,
                           String accessToken,
                           StateFactory stateFactory)

Method Detail

clone

protected CollectionsState clone(com.sun.jersey.api.client.ClientRequest request,
                                 com.sun.jersey.api.client.ClientResponse response)

Specified by:

clone in class GedcomxApplicationState<org.gedcomx.Gedcomx>

ifSuccessful

public CollectionsState ifSuccessful()

Overrides:

ifSuccessful in class GedcomxApplicationState<org.gedcomx.Gedcomx>

loadEntity

protected org.gedcomx.Gedcomx loadEntity(com.sun.jersey.api.client.ClientResponse response)

Specified by:

loadEntity in class GedcomxApplicationState<org.gedcomx.Gedcomx>

getMainDataElement

protected org.gedcomx.links.SupportsLinks getMainDataElement()

Specified by:

getMainDataElement in class GedcomxApplicationState<org.gedcomx.Gedcomx>

head

public CollectionsState head(StateTransitionOption... options)

Overrides:

head in class GedcomxApplicationState<org.gedcomx.Gedcomx>

options

public CollectionsState options(StateTransitionOption... options)

Overrides:

options in class GedcomxApplicationState<org.gedcomx.Gedcomx>

get

public CollectionsState get(StateTransitionOption... options)

Overrides:

get in class GedcomxApplicationState<org.gedcomx.Gedcomx>

delete

public CollectionsState delete(StateTransitionOption... options)

Overrides:

delete in class GedcomxApplicationState<org.gedcomx.Gedcomx>

put

public CollectionsState put(org.gedcomx.Gedcomx e,
                            StateTransitionOption... options)

Overrides:

put in class GedcomxApplicationState<org.gedcomx.Gedcomx>

post

public CollectionsState post(org.gedcomx.Gedcomx entity,
                             StateTransitionOption... options)

Overrides:

post in class GedcomxApplicationState<org.gedcomx.Gedcomx>

getCollections

public List<org.gedcomx.records.Collection> getCollections()

getSourceDescriptions

public List<org.gedcomx.source.SourceDescription> getSourceDescriptions()

readCollection

public CollectionState readCollection(org.gedcomx.records.Collection collection,
                                      StateTransitionOption... options)

updateCollection

public CollectionState updateCollection(org.gedcomx.records.Collection collection,
                                        StateTransitionOption... options)

readCollection

public CollectionState readCollection(org.gedcomx.source.SourceDescription sourceDescription,
                                      StateTransitionOption... options)

readCollection

public CollectionState readCollection(StateTransitionOption... options)

addCollection

public CollectionState addCollection(org.gedcomx.records.Collection collection,
                                     StateTransitionOption... options)

addCollection

public CollectionState addCollection(org.gedcomx.source.SourceDescription description,
                                     StateTransitionOption... options)

addCollection

public CollectionState addCollection(org.gedcomx.records.Collection collection,
                                     org.gedcomx.source.SourceDescription sourceDescription,
                                     StateTransitionOption... options)

readNextPage

public CollectionState readNextPage(StateTransitionOption... options)

Overrides:

readNextPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readPreviousPage

public CollectionState readPreviousPage(StateTransitionOption... options)

Overrides:

readPreviousPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readFirstPage

public CollectionState readFirstPage(StateTransitionOption... options)

Overrides:

readFirstPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readLastPage

public CollectionState readLastPage(StateTransitionOption... options)

Overrides:

readLastPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>