org.mythtv.services.api.capture.impl
Class CaptureTemplate

java.lang.Object
  org.mythtv.services.api.AbstractOperations
      org.mythtv.services.api.capture.impl.CaptureTemplate

All Implemented Interfaces:

CaptureOperations

public class CaptureTemplate
extends AbstractOperations
implements CaptureOperations

Author:

Daniel Frey

Nested Class Summary

static class

CaptureTemplate.Endpoint

Field Summary

Fields inherited from class org.mythtv.services.api.AbstractOperations

formatter

Constructor Summary

CaptureTemplate(org.springframework.web.client.RestOperations restOperations, String apiUrlBase)

Method Summary

org.springframework.http.ResponseEntity<Int>	addCaptureCard(CaptureCard captureCard) - POST
org.springframework.http.ResponseEntity<Int>	addCardInput(CardInput cardInput) - POST
protected String	getApiUrlBase()
org.springframework.http.ResponseEntity<CaptureCardWrapper>	getCaptureCard(int cardId, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<CaptureCardList>	getCaptureCardList(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<CaptureCardList>	getCaptureCardList(String hostName, String cardType, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<Bool>	removeCaptureCard(int cardId, ETagInfo etag) - POST
org.springframework.http.ResponseEntity<Bool>	removeCardInput(int cardInputId) - POST
org.springframework.http.ResponseEntity<Bool>	updateCaptureCard(int cardId, String setting, String value) - POST
org.springframework.http.ResponseEntity<Bool>	updateCardInput(int cardInputId, String setting, String value) - POST

Methods inherited from class org.mythtv.services.api.AbstractOperations

buildUri, buildUri, buildUri, convertUtcAndFormat, getRequestEntity, handleResponseEtag

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptureTemplate

public CaptureTemplate(org.springframework.web.client.RestOperations restOperations,
                       String apiUrlBase)

Method Detail

addCaptureCard

public org.springframework.http.ResponseEntity<Int> addCaptureCard(CaptureCard captureCard)
                                                            throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- POST

Specified by:

addCaptureCard in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

addCardInput

public org.springframework.http.ResponseEntity<Int> addCardInput(CardInput cardInput)
                                                          throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- POST

Specified by:

addCardInput in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

getCaptureCard

public org.springframework.http.ResponseEntity<CaptureCardWrapper> getCaptureCard(int cardId,
                                                                                  ETagInfo etag)
                                                                           throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- GET

Specified by:

getCaptureCard in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

getCaptureCardList

public org.springframework.http.ResponseEntity<CaptureCardList> getCaptureCardList(ETagInfo etag)
                                                                            throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- GET

Specified by:

getCaptureCardList in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

getCaptureCardList

public org.springframework.http.ResponseEntity<CaptureCardList> getCaptureCardList(String hostName,
                                                                                   String cardType,
                                                                                   ETagInfo etag)
                                                                            throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- GET

Specified by:

getCaptureCardList in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

removeCaptureCard

public org.springframework.http.ResponseEntity<Bool> removeCaptureCard(int cardId,
                                                                       ETagInfo etag)
                                                                throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- POST

Specified by:

removeCaptureCard in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

removeCardInput

public org.springframework.http.ResponseEntity<Bool> removeCardInput(int cardInputId)
                                                              throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- POST

Specified by:

removeCardInput in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

updateCaptureCard

public org.springframework.http.ResponseEntity<Bool> updateCaptureCard(int cardId,
                                                                       String setting,
                                                                       String value)
                                                                throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- POST

Specified by:

updateCaptureCard in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

updateCardInput

public org.springframework.http.ResponseEntity<Bool> updateCardInput(int cardInputId,
                                                                     String setting,
                                                                     String value)
                                                              throws MythServiceApiRuntimeException

Description copied from interface: CaptureOperations

- POST

Specified by:

updateCardInput in interface CaptureOperations

Returns:

Throws:

MythServiceApiRuntimeException

getApiUrlBase

protected String getApiUrlBase()

Overrides:

getApiUrlBase in class AbstractOperations

Returns: