org.gedcomx.rs.client

Class PlaceDescriptionsState

java.lang.Object

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

org.gedcomx.rs.client.PlaceDescriptionsState

public class PlaceDescriptionsState
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	PlaceDescriptionsState(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
PlaceDescriptionState	addPlaceDescription(org.gedcomx.conclusion.PlaceDescription place, StateTransitionOption... options)
protected PlaceDescriptionsState	clone(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response)
PlaceDescriptionsState	delete(StateTransitionOption... options)
PlaceDescriptionsState	get(StateTransitionOption... options)
protected org.gedcomx.links.SupportsLinks	getMainDataElement()
List<org.gedcomx.conclusion.PlaceDescription>	getPlaceDescriptions()
PlaceDescriptionsState	head(StateTransitionOption... options)
PlaceDescriptionsState	ifSuccessful()
protected org.gedcomx.Gedcomx	loadEntity(com.sun.jersey.api.client.ClientResponse response)
PlaceDescriptionsState	options(StateTransitionOption... options)
PlaceDescriptionsState	post(org.gedcomx.Gedcomx entity, StateTransitionOption... options)
PlaceDescriptionsState	put(org.gedcomx.Gedcomx e, StateTransitionOption... options)
CollectionState	readCollection(StateTransitionOption... options)
PlaceDescriptionsState	readFirstPage(StateTransitionOption... options)
PlaceDescriptionsState	readLastPage(StateTransitionOption... options)
PlaceDescriptionsState	readNextPage(StateTransitionOption... options)
PlaceDescriptionsState	readPreviousPage(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

PlaceDescriptionsState

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

Method Detail

clone

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

Specified by:

clone 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>

ifSuccessful

public PlaceDescriptionsState ifSuccessful()

Overrides:

ifSuccessful in class GedcomxApplicationState<org.gedcomx.Gedcomx>

getPlaceDescriptions

public List<org.gedcomx.conclusion.PlaceDescription> getPlaceDescriptions()

head

public PlaceDescriptionsState head(StateTransitionOption... options)

Overrides:

head in class GedcomxApplicationState<org.gedcomx.Gedcomx>

options

public PlaceDescriptionsState options(StateTransitionOption... options)

Overrides:

options in class GedcomxApplicationState<org.gedcomx.Gedcomx>

get

public PlaceDescriptionsState get(StateTransitionOption... options)

Overrides:

get in class GedcomxApplicationState<org.gedcomx.Gedcomx>

delete

public PlaceDescriptionsState delete(StateTransitionOption... options)

Overrides:

delete in class GedcomxApplicationState<org.gedcomx.Gedcomx>

put

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

Overrides:

put in class GedcomxApplicationState<org.gedcomx.Gedcomx>

post

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

Overrides:

post in class GedcomxApplicationState<org.gedcomx.Gedcomx>

getMainDataElement

protected org.gedcomx.links.SupportsLinks getMainDataElement()

Specified by:

getMainDataElement in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readNextPage

public PlaceDescriptionsState readNextPage(StateTransitionOption... options)

Overrides:

readNextPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readPreviousPage

public PlaceDescriptionsState readPreviousPage(StateTransitionOption... options)

Overrides:

readPreviousPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readFirstPage

public PlaceDescriptionsState readFirstPage(StateTransitionOption... options)

Overrides:

readFirstPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

readLastPage

public PlaceDescriptionsState readLastPage(StateTransitionOption... options)

Overrides:

readLastPage in class GedcomxApplicationState<org.gedcomx.Gedcomx>

addPlaceDescription

public PlaceDescriptionState addPlaceDescription(org.gedcomx.conclusion.PlaceDescription place,
                                                 StateTransitionOption... options)

readCollection

public CollectionState readCollection(StateTransitionOption... options)