org.gedcomx.rs.client

Class RelationshipState

java.lang.Object

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

org.gedcomx.rs.client.RelationshipState

public class RelationshipState
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	RelationshipState(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
RelationshipState	addEvidenceReference(org.gedcomx.common.EvidenceReference reference, StateTransitionOption... options)
RelationshipState	addEvidenceReference(RelationshipState evidence, StateTransitionOption... options)
RelationshipState	addEvidenceReferences(org.gedcomx.common.EvidenceReference[] refs, StateTransitionOption... options)
RelationshipState	addFact(org.gedcomx.conclusion.Fact fact, StateTransitionOption... options)
RelationshipState	addFacts(org.gedcomx.conclusion.Fact[] facts, StateTransitionOption... options)
RelationshipState	addMediaReference(SourceDescriptionState description, StateTransitionOption... options)
RelationshipState	addMediaReference(org.gedcomx.source.SourceReference reference, StateTransitionOption... options)
RelationshipState	addMediaReferences(org.gedcomx.source.SourceReference[] refs, StateTransitionOption... options)
RelationshipState	addNote(org.gedcomx.common.Note note, StateTransitionOption... options)
RelationshipState	addNotes(org.gedcomx.common.Note[] notes, StateTransitionOption... options)
RelationshipState	addSourceReference(SourceDescriptionState source, StateTransitionOption... options)
RelationshipState	addSourceReference(org.gedcomx.source.SourceReference reference, StateTransitionOption... options)
RelationshipState	addSourceReferences(org.gedcomx.source.SourceReference[] refs, StateTransitionOption... options)
protected RelationshipState	clone(com.sun.jersey.api.client.ClientRequest request, com.sun.jersey.api.client.ClientResponse response)
protected org.gedcomx.conclusion.Relationship	createEmptySelf()
RelationshipState	delete(StateTransitionOption... options)
RelationshipState	deleteEvidenceReference(org.gedcomx.common.EvidenceReference reference, StateTransitionOption... options)
RelationshipState	deleteFact(org.gedcomx.conclusion.Fact fact, StateTransitionOption... options)
RelationshipState	deleteMediaReference(org.gedcomx.source.SourceReference reference, StateTransitionOption... options)
RelationshipState	deleteNote(org.gedcomx.common.Note note, StateTransitionOption... options)
RelationshipState	deleteSourceReference(org.gedcomx.source.SourceReference reference, StateTransitionOption... options)
RelationshipState	get(StateTransitionOption... options)
org.gedcomx.conclusion.Conclusion	getConclusion()
org.gedcomx.common.EvidenceReference	getEvidenceReference()
org.gedcomx.conclusion.Fact	getFact()
protected String	getLocalSelfId()
protected org.gedcomx.links.SupportsLinks	getMainDataElement()
org.gedcomx.source.SourceReference	getMediaReference()
org.gedcomx.common.Note	getNote()
org.gedcomx.conclusion.Relationship	getRelationship()
String	getSelfRel()
org.gedcomx.source.SourceReference	getSourceReference()
RelationshipState	head(StateTransitionOption... options)
RelationshipState	ifSuccessful()
RelationshipState	inject(com.sun.jersey.api.client.ClientRequest request)
RelationshipState	loadConclusions(StateTransitionOption... options)
RelationshipState	loadEmbeddedResources(StateTransitionOption... options)
RelationshipState	loadEmbeddedResources(String[] rels, StateTransitionOption... options)
protected org.gedcomx.Gedcomx	loadEntity(com.sun.jersey.api.client.ClientResponse response)
RelationshipState	loadEvidenceReferences(StateTransitionOption... options)
RelationshipState	loadMediaReferences(StateTransitionOption... options)
RelationshipState	loadNotes(StateTransitionOption... options)
RelationshipState	loadSourceReferences(StateTransitionOption... options)
RelationshipState	options(StateTransitionOption... options)
RelationshipState	post(org.gedcomx.Gedcomx entity, StateTransitionOption... options)
RelationshipState	put(org.gedcomx.Gedcomx e, StateTransitionOption... options)
CollectionState	readCollection(StateTransitionOption... options)
RelationshipState	readNote(org.gedcomx.common.Note note, StateTransitionOption... options)
PersonState	readPerson1(StateTransitionOption... options)
PersonState	readPerson2(StateTransitionOption... options)
SourceDescriptionState	readSourceDescription(org.gedcomx.source.SourceReference sourceReference, StateTransitionOption... options)
protected RelationshipState	updateConclusions(org.gedcomx.conclusion.Relationship relationship, StateTransitionOption... options)
RelationshipState	updateEvidenceReference(org.gedcomx.common.EvidenceReference reference, StateTransitionOption... options)
RelationshipState	updateEvidenceReferences(org.gedcomx.common.EvidenceReference[] refs, StateTransitionOption... options)
protected RelationshipState	updateEvidenceReferences(org.gedcomx.conclusion.Relationship relationship, StateTransitionOption... options)
RelationshipState	updateFact(org.gedcomx.conclusion.Fact fact, StateTransitionOption... options)
RelationshipState	updateFacts(org.gedcomx.conclusion.Fact[] facts, StateTransitionOption... options)
RelationshipState	updateMediaReference(org.gedcomx.source.SourceReference reference, StateTransitionOption... options)
protected RelationshipState	updateMediaReferences(org.gedcomx.conclusion.Relationship relationship, StateTransitionOption... options)
RelationshipState	updateMediaReferences(org.gedcomx.source.SourceReference[] refs, StateTransitionOption... options)
RelationshipState	updateNote(org.gedcomx.common.Note note, StateTransitionOption... options)
RelationshipState	updateNotes(org.gedcomx.common.Note[] notes, StateTransitionOption... options)
protected RelationshipState	updateNotes(org.gedcomx.conclusion.Relationship relationship, StateTransitionOption... options)
RelationshipState	updateSourceReference(org.gedcomx.source.SourceReference reference, StateTransitionOption... options)
protected RelationshipState	updateSourceReferences(org.gedcomx.conclusion.Relationship relationship, StateTransitionOption... options)
RelationshipState	updateSourceReferences(org.gedcomx.source.SourceReference[] refs, 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, getSelfUri, getUri, getWarnings, hasClientError, hasError, hasServerError, hasStatus, includeEmbeddedResources, 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

RelationshipState

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

Method Detail

getSelfRel

public String getSelfRel()

Overrides:

getSelfRel in class GedcomxApplicationState<org.gedcomx.Gedcomx>

clone

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

Overrides:

ifSuccessful in class GedcomxApplicationState<org.gedcomx.Gedcomx>

head

public RelationshipState head(StateTransitionOption... options)

Overrides:

head in class GedcomxApplicationState<org.gedcomx.Gedcomx>

options

public RelationshipState options(StateTransitionOption... options)

Overrides:

options in class GedcomxApplicationState<org.gedcomx.Gedcomx>

get

public RelationshipState get(StateTransitionOption... options)

Overrides:

get in class GedcomxApplicationState<org.gedcomx.Gedcomx>

delete

public RelationshipState delete(StateTransitionOption... options)

Overrides:

delete in class GedcomxApplicationState<org.gedcomx.Gedcomx>

put

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

Overrides:

put in class GedcomxApplicationState<org.gedcomx.Gedcomx>

post

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

Overrides:

post in class GedcomxApplicationState<org.gedcomx.Gedcomx>

inject

public RelationshipState inject(com.sun.jersey.api.client.ClientRequest request)

Overrides:

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

getRelationship

public org.gedcomx.conclusion.Relationship getRelationship()

getConclusion

public org.gedcomx.conclusion.Conclusion getConclusion()

getFact

public org.gedcomx.conclusion.Fact getFact()

getNote

public org.gedcomx.common.Note getNote()

getSourceReference

public org.gedcomx.source.SourceReference getSourceReference()

getEvidenceReference

public org.gedcomx.common.EvidenceReference getEvidenceReference()

getMediaReference

public org.gedcomx.source.SourceReference getMediaReference()

readCollection

public CollectionState readCollection(StateTransitionOption... options)

readPerson1

public PersonState readPerson1(StateTransitionOption... options)

readPerson2

public PersonState readPerson2(StateTransitionOption... options)

loadEmbeddedResources

public RelationshipState loadEmbeddedResources(StateTransitionOption... options)

loadEmbeddedResources

public RelationshipState loadEmbeddedResources(String[] rels,
                                               StateTransitionOption... options)

loadConclusions

public RelationshipState loadConclusions(StateTransitionOption... options)

loadSourceReferences

public RelationshipState loadSourceReferences(StateTransitionOption... options)

loadMediaReferences

public RelationshipState loadMediaReferences(StateTransitionOption... options)

loadEvidenceReferences

public RelationshipState loadEvidenceReferences(StateTransitionOption... options)

loadNotes

public RelationshipState loadNotes(StateTransitionOption... options)

createEmptySelf

protected org.gedcomx.conclusion.Relationship createEmptySelf()

getLocalSelfId

protected String getLocalSelfId()

addFact

public RelationshipState addFact(org.gedcomx.conclusion.Fact fact,
                                 StateTransitionOption... options)

addFacts

public RelationshipState addFacts(org.gedcomx.conclusion.Fact[] facts,
                                  StateTransitionOption... options)

updateFact

public RelationshipState updateFact(org.gedcomx.conclusion.Fact fact,
                                    StateTransitionOption... options)

updateFacts

public RelationshipState updateFacts(org.gedcomx.conclusion.Fact[] facts,
                                     StateTransitionOption... options)

updateConclusions

protected RelationshipState updateConclusions(org.gedcomx.conclusion.Relationship relationship,
                                              StateTransitionOption... options)

deleteFact

public RelationshipState deleteFact(org.gedcomx.conclusion.Fact fact,
                                    StateTransitionOption... options)

addSourceReference

public RelationshipState addSourceReference(SourceDescriptionState source,
                                            StateTransitionOption... options)

addSourceReference

public RelationshipState addSourceReference(org.gedcomx.source.SourceReference reference,
                                            StateTransitionOption... options)

addSourceReferences

public RelationshipState addSourceReferences(org.gedcomx.source.SourceReference[] refs,
                                             StateTransitionOption... options)

updateSourceReference

public RelationshipState updateSourceReference(org.gedcomx.source.SourceReference reference,
                                               StateTransitionOption... options)

updateSourceReferences

public RelationshipState updateSourceReferences(org.gedcomx.source.SourceReference[] refs,
                                                StateTransitionOption... options)

updateSourceReferences

protected RelationshipState updateSourceReferences(org.gedcomx.conclusion.Relationship relationship,
                                                   StateTransitionOption... options)

deleteSourceReference

public RelationshipState deleteSourceReference(org.gedcomx.source.SourceReference reference,
                                               StateTransitionOption... options)

readSourceDescription

public SourceDescriptionState readSourceDescription(org.gedcomx.source.SourceReference sourceReference,
                                                    StateTransitionOption... options)

addMediaReference

public RelationshipState addMediaReference(SourceDescriptionState description,
                                           StateTransitionOption... options)

addMediaReference

public RelationshipState addMediaReference(org.gedcomx.source.SourceReference reference,
                                           StateTransitionOption... options)

addMediaReferences

public RelationshipState addMediaReferences(org.gedcomx.source.SourceReference[] refs,
                                            StateTransitionOption... options)

updateMediaReference

public RelationshipState updateMediaReference(org.gedcomx.source.SourceReference reference,
                                              StateTransitionOption... options)

updateMediaReferences

public RelationshipState updateMediaReferences(org.gedcomx.source.SourceReference[] refs,
                                               StateTransitionOption... options)

updateMediaReferences

protected RelationshipState updateMediaReferences(org.gedcomx.conclusion.Relationship relationship,
                                                  StateTransitionOption... options)

deleteMediaReference

public RelationshipState deleteMediaReference(org.gedcomx.source.SourceReference reference,
                                              StateTransitionOption... options)

addEvidenceReference

public RelationshipState addEvidenceReference(RelationshipState evidence,
                                              StateTransitionOption... options)

addEvidenceReference

public RelationshipState addEvidenceReference(org.gedcomx.common.EvidenceReference reference,
                                              StateTransitionOption... options)

addEvidenceReferences

public RelationshipState addEvidenceReferences(org.gedcomx.common.EvidenceReference[] refs,
                                               StateTransitionOption... options)

updateEvidenceReference

public RelationshipState updateEvidenceReference(org.gedcomx.common.EvidenceReference reference,
                                                 StateTransitionOption... options)

updateEvidenceReferences

public RelationshipState updateEvidenceReferences(org.gedcomx.common.EvidenceReference[] refs,
                                                  StateTransitionOption... options)

updateEvidenceReferences

protected RelationshipState updateEvidenceReferences(org.gedcomx.conclusion.Relationship relationship,
                                                     StateTransitionOption... options)

deleteEvidenceReference

public RelationshipState deleteEvidenceReference(org.gedcomx.common.EvidenceReference reference,
                                                 StateTransitionOption... options)

readNote

public RelationshipState readNote(org.gedcomx.common.Note note,
                                  StateTransitionOption... options)

addNote

public RelationshipState addNote(org.gedcomx.common.Note note,
                                 StateTransitionOption... options)

addNotes

public RelationshipState addNotes(org.gedcomx.common.Note[] notes,
                                  StateTransitionOption... options)

updateNote

public RelationshipState updateNote(org.gedcomx.common.Note note,
                                    StateTransitionOption... options)

updateNotes

public RelationshipState updateNotes(org.gedcomx.common.Note[] notes,
                                     StateTransitionOption... options)

updateNotes

protected RelationshipState updateNotes(org.gedcomx.conclusion.Relationship relationship,
                                        StateTransitionOption... options)

deleteNote

public RelationshipState deleteNote(org.gedcomx.common.Note note,
                                    StateTransitionOption... options)