org.gedcomx.rs.client

Class CollectionState

java.lang.Object

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

org.gedcomx.rs.client.CollectionState

public class CollectionState
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	CollectionState(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response, String accessToken, StateFactory stateFactory)
	CollectionState(URI uri)

Method Summary

Modifier and Type	Method and Description
SourceDescriptionState	addArtifact(DataSource artifact, StateTransitionOption... options)
SourceDescriptionState	addArtifact(org.gedcomx.source.SourceDescription description, DataSource artifact, StateTransitionOption... options)
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 sourceDescription, StateTransitionOption... options)
RelationshipState	addParentChildRelationship(PersonState parent, PersonState child, org.gedcomx.conclusion.Fact fact, StateTransitionOption... options)
RelationshipState	addParentChildRelationship(PersonState parent, PersonState child, StateTransitionOption... options)
PersonState	addPerson(org.gedcomx.Gedcomx entity, StateTransitionOption... options)
PersonState	addPerson(org.gedcomx.conclusion.Person person, StateTransitionOption... options)
RecordState	addRecord(org.gedcomx.Gedcomx record, StateTransitionOption... options)
RelationshipState	addRelationship(org.gedcomx.conclusion.Relationship relationship, StateTransitionOption... options)
RelationshipsState	addRelationships(List<org.gedcomx.conclusion.Relationship> relationships, StateTransitionOption... options)
SourceDescriptionState	addSourceDescription(org.gedcomx.source.SourceDescription source, StateTransitionOption... options)
RelationshipState	addSpouseRelationship(PersonState person1, PersonState person2, org.gedcomx.conclusion.Fact fact, StateTransitionOption... options)
RelationshipState	addSpouseRelationship(PersonState person1, PersonState person2, StateTransitionOption... options)
CollectionState	authenticateViaOAuth2(javax.ws.rs.core.MultivaluedMap<String,String> formData, StateTransitionOption... options)
CollectionState	authenticateViaOAuth2AuthCode(String authCode, String redirect, String clientId)
CollectionState	authenticateViaOAuth2AuthCode(String authCode, String redirect, String clientId, String clientSecret)
CollectionState	authenticateViaOAuth2ClientCredentials(String clientId, String clientSecret)
CollectionState	authenticateViaOAuth2Password(String username, String password, String clientId)
CollectionState	authenticateViaOAuth2Password(String username, String password, String clientId, String clientSecret)
CollectionState	authenticateWithAccessToken(String accessToken)
protected CollectionState	clone(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response)
CollectionState	delete(StateTransitionOption... options)
CollectionState	get(StateTransitionOption... options)
org.gedcomx.records.Collection	getCollection()
protected org.gedcomx.links.SupportsLinks	getMainDataElement()
List<org.gedcomx.source.SourceDescription>	getSourceDescriptions()
CollectionState	head(StateTransitionOption... options)
CollectionState	ifSuccessful()
protected org.gedcomx.Gedcomx	loadEntity(com.sun.jersey.api.client.ClientResponse response)
CollectionState	options(StateTransitionOption... options)
CollectionState	post(org.gedcomx.Gedcomx entity, StateTransitionOption... options)
CollectionState	put(org.gedcomx.Gedcomx e, StateTransitionOption... options)
CollectionState	readCollection(StateTransitionOption... options)
PersonState	readPerson(org.gedcomx.conclusion.Person person, StateTransitionOption... options)
PersonState	readPerson(URI personUri, StateTransitionOption... options)
PersonState	readPersonForCurrentUser(StateTransitionOption... options)
PersonsState	readPersons(StateTransitionOption... options)
RecordsState	readRecords(StateTransitionOption... options)
RelationshipsState	readRelationships(StateTransitionOption... options)
SourceDescriptionsState	readResourcesById(StateTransitionOption... options)
SourceDescriptionsState	readResourcesOfCurrentUser(StateTransitionOption... options)
SourceDescriptionState	readSourceDescription(org.gedcomx.source.SourceDescription sourceDescription, StateTransitionOption... options)
SourceDescriptionsState	readSourceDescriptions(StateTransitionOption... options)
CollectionsState	readSubcollections(StateTransitionOption... options)
PersonSearchResultsState	searchForPersons(PersonSearchQueryBuilder query, StateTransitionOption... options)
PersonSearchResultsState	searchForPersons(String query, StateTransitionOption... options)
CollectionState	update(org.gedcomx.records.Collection collection, StateTransitionOption... options)

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

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, readFirstPage, readLastPage, readNextPage, readPage, readPreviousPage

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionState

public CollectionState(URI uri)

CollectionState

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

Method Detail

clone

protected CollectionState 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 CollectionState ifSuccessful()

Overrides:

ifSuccessful in class GedcomxApplicationState<org.gedcomx.Gedcomx>

getMainDataElement

protected org.gedcomx.links.SupportsLinks getMainDataElement()

Specified by:

getMainDataElement in class GedcomxApplicationState<org.gedcomx.Gedcomx>

head

public CollectionState head(StateTransitionOption... options)

Overrides:

head in class GedcomxApplicationState<org.gedcomx.Gedcomx>

options

public CollectionState options(StateTransitionOption... options)

Overrides:

options in class GedcomxApplicationState<org.gedcomx.Gedcomx>

get

public CollectionState get(StateTransitionOption... options)

Overrides:

get in class GedcomxApplicationState<org.gedcomx.Gedcomx>

delete

public CollectionState delete(StateTransitionOption... options)

Overrides:

delete in class GedcomxApplicationState<org.gedcomx.Gedcomx>

put

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

Overrides:

put in class GedcomxApplicationState<org.gedcomx.Gedcomx>

post

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

Overrides:

post in class GedcomxApplicationState<org.gedcomx.Gedcomx>

getCollection

public org.gedcomx.records.Collection getCollection()

authenticateWithAccessToken

public CollectionState authenticateWithAccessToken(String accessToken)

Overrides:

authenticateWithAccessToken in class GedcomxApplicationState<org.gedcomx.Gedcomx>

authenticateViaOAuth2Password

public CollectionState authenticateViaOAuth2Password(String username,
                                                     String password,
                                                     String clientId)

Overrides:

authenticateViaOAuth2Password in class GedcomxApplicationState<org.gedcomx.Gedcomx>

authenticateViaOAuth2Password

public CollectionState authenticateViaOAuth2Password(String username,
                                                     String password,
                                                     String clientId,
                                                     String clientSecret)

Overrides:

authenticateViaOAuth2Password in class GedcomxApplicationState<org.gedcomx.Gedcomx>

authenticateViaOAuth2AuthCode

public CollectionState authenticateViaOAuth2AuthCode(String authCode,
                                                     String redirect,
                                                     String clientId)

Overrides:

authenticateViaOAuth2AuthCode in class GedcomxApplicationState<org.gedcomx.Gedcomx>

authenticateViaOAuth2AuthCode

public CollectionState authenticateViaOAuth2AuthCode(String authCode,
                                                     String redirect,
                                                     String clientId,
                                                     String clientSecret)

Overrides:

authenticateViaOAuth2AuthCode in class GedcomxApplicationState<org.gedcomx.Gedcomx>

authenticateViaOAuth2ClientCredentials

public CollectionState authenticateViaOAuth2ClientCredentials(String clientId,
                                                              String clientSecret)

Overrides:

authenticateViaOAuth2ClientCredentials in class GedcomxApplicationState<org.gedcomx.Gedcomx>

authenticateViaOAuth2

public CollectionState authenticateViaOAuth2(javax.ws.rs.core.MultivaluedMap<String,String> formData,
                                             StateTransitionOption... options)

Overrides:

authenticateViaOAuth2 in class GedcomxApplicationState<org.gedcomx.Gedcomx>

update

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

readRecords

public RecordsState readRecords(StateTransitionOption... options)

addRecord

public RecordState addRecord(org.gedcomx.Gedcomx record,
                             StateTransitionOption... options)

readPersons

public PersonsState readPersons(StateTransitionOption... options)

addPerson

public PersonState addPerson(org.gedcomx.conclusion.Person person,
                             StateTransitionOption... options)

addPerson

public PersonState addPerson(org.gedcomx.Gedcomx entity,
                             StateTransitionOption... options)

readPersonForCurrentUser

public PersonState readPersonForCurrentUser(StateTransitionOption... options)

readPerson

public PersonState readPerson(URI personUri,
                              StateTransitionOption... options)

searchForPersons

public PersonSearchResultsState searchForPersons(PersonSearchQueryBuilder query,
                                                 StateTransitionOption... options)

searchForPersons

public PersonSearchResultsState searchForPersons(String query,
                                                 StateTransitionOption... options)

readRelationships

public RelationshipsState readRelationships(StateTransitionOption... options)

addSpouseRelationship

public RelationshipState addSpouseRelationship(PersonState person1,
                                               PersonState person2,
                                               StateTransitionOption... options)

addSpouseRelationship

public RelationshipState addSpouseRelationship(PersonState person1,
                                               PersonState person2,
                                               org.gedcomx.conclusion.Fact fact,
                                               StateTransitionOption... options)

addParentChildRelationship

public RelationshipState addParentChildRelationship(PersonState parent,
                                                    PersonState child,
                                                    StateTransitionOption... options)

addParentChildRelationship

public RelationshipState addParentChildRelationship(PersonState parent,
                                                    PersonState child,
                                                    org.gedcomx.conclusion.Fact fact,
                                                    StateTransitionOption... options)

addRelationship

public RelationshipState addRelationship(org.gedcomx.conclusion.Relationship relationship,
                                         StateTransitionOption... options)

addRelationships

public RelationshipsState addRelationships(List<org.gedcomx.conclusion.Relationship> relationships,
                                           StateTransitionOption... options)

addArtifact

public SourceDescriptionState addArtifact(DataSource artifact,
                                          StateTransitionOption... options)

addArtifact

public SourceDescriptionState addArtifact(org.gedcomx.source.SourceDescription description,
                                          DataSource artifact,
                                          StateTransitionOption... options)

readSourceDescriptions

public SourceDescriptionsState readSourceDescriptions(StateTransitionOption... options)

addSourceDescription

public SourceDescriptionState addSourceDescription(org.gedcomx.source.SourceDescription source,
                                                   StateTransitionOption... options)

readCollection

public CollectionState readCollection(StateTransitionOption... options)

readSubcollections

public CollectionsState readSubcollections(StateTransitionOption... options)

addCollection

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

addCollection

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

addCollection

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

readResourcesById

public SourceDescriptionsState readResourcesById(StateTransitionOption... options)

readResourcesOfCurrentUser

public SourceDescriptionsState readResourcesOfCurrentUser(StateTransitionOption... options)

getSourceDescriptions

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

readSourceDescription

public SourceDescriptionState readSourceDescription(org.gedcomx.source.SourceDescription sourceDescription,
                                                    StateTransitionOption... options)

readPerson

public PersonState readPerson(org.gedcomx.conclusion.Person person,
                              StateTransitionOption... options)