org.mythtv.services.api.v026.impl
Class DvrTemplate

java.lang.Object
  org.mythtv.services.api.AbstractOperations
      org.mythtv.services.api.v026.impl.DvrTemplate

All Implemented Interfaces:

DvrOperations

public class DvrTemplate
extends AbstractOperations
implements DvrOperations

Nested Class Summary

static class

DvrTemplate.Endpoint

Field Summary

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

formatter

Constructor Summary

DvrTemplate(org.springframework.web.client.RestOperations restOperations, java.lang.String apiUrlBase)

Method Summary

org.springframework.http.ResponseEntity<Int>	addRecordingSchedule(int channelId, org.joda.time.DateTime startTime, int parentId, boolean interactive, int season, int episode, java.lang.String inetRef, int findId, java.lang.String type, java.lang.String searchType, int recordingPriority, int perferredInput, int startOffset, int endOffset, java.lang.String duplicateMethod, java.lang.String duplicateIn, int filter, java.lang.String recordingProfile, java.lang.String recordingGroup, java.lang.String storageGroup, java.lang.String playGroup, boolean autoExpire, int maxEpisodes, boolean maxNewest, boolean autoCommercialFlag, boolean autoTranscode, boolean autoMetadataLookup, boolean autoUserJob1, boolean autoUserJob2, boolean autoUserJob3, boolean autoUserJob4, int transcoder) - POST
org.springframework.http.ResponseEntity<Bool>	disableRecordingSchedule(int recordingId) - POST
org.springframework.http.ResponseEntity<Bool>	enableRecordingSchedule(int recordingId) - POST
protected java.lang.String	getApiUrlBase()
org.springframework.http.ResponseEntity<ProgramList>	getConflictList(int startIndex, int count, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<EncoderList>	getEncoderList(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getExpiringList(int startIndex, int count, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getFiltererRecordedList(boolean descending, int startIndex, int count, java.lang.String titleRegEx, java.lang.String recordingGroup, java.lang.String storageGroup, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramWrapper>	getRecorded(int channelId, org.joda.time.DateTime startTime, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getRecordedList(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getRecordedList(int startIndex, int count, boolean descending, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<RecRuleWrapper>	getRecordSchedule(int recordId, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<RecRuleList>	getRecordScheduleList(int startIndex, int count, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<ProgramList>	getUpcomingList(int startIndex, int count, boolean showAll, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<Bool>	removeRecorded(int channelId, org.joda.time.DateTime startTime) - GET
org.springframework.http.ResponseEntity<Bool>	removeRecordingSchedule(int recordingId) - POST

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

buildUri, buildUri, buildUri, convertUtcAndFormat, getRequestEntity, handleResponseEtag, setLogLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

DvrTemplate

public DvrTemplate(org.springframework.web.client.RestOperations restOperations,
                   java.lang.String apiUrlBase)

Parameters:

restOperations -

apiUrlBase -

Method Detail

addRecordingSchedule

public org.springframework.http.ResponseEntity<Int> addRecordingSchedule(int channelId,
                                                                         org.joda.time.DateTime startTime,
                                                                         int parentId,
                                                                         boolean interactive,
                                                                         int season,
                                                                         int episode,
                                                                         java.lang.String inetRef,
                                                                         int findId,
                                                                         java.lang.String type,
                                                                         java.lang.String searchType,
                                                                         int recordingPriority,
                                                                         int perferredInput,
                                                                         int startOffset,
                                                                         int endOffset,
                                                                         java.lang.String duplicateMethod,
                                                                         java.lang.String duplicateIn,
                                                                         int filter,
                                                                         java.lang.String recordingProfile,
                                                                         java.lang.String recordingGroup,
                                                                         java.lang.String storageGroup,
                                                                         java.lang.String playGroup,
                                                                         boolean autoExpire,
                                                                         int maxEpisodes,
                                                                         boolean maxNewest,
                                                                         boolean autoCommercialFlag,
                                                                         boolean autoTranscode,
                                                                         boolean autoMetadataLookup,
                                                                         boolean autoUserJob1,
                                                                         boolean autoUserJob2,
                                                                         boolean autoUserJob3,
                                                                         boolean autoUserJob4,
                                                                         int transcoder)
                                                                  throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- POST

Specified by:

addRecordingSchedule in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

disableRecordingSchedule

public org.springframework.http.ResponseEntity<Bool> disableRecordingSchedule(int recordingId)
                                                                       throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- POST

Specified by:

disableRecordingSchedule in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

enableRecordingSchedule

public org.springframework.http.ResponseEntity<Bool> enableRecordingSchedule(int recordingId)
                                                                      throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- POST

Specified by:

enableRecordingSchedule in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getConflictList

public org.springframework.http.ResponseEntity<ProgramList> getConflictList(int startIndex,
                                                                            int count,
                                                                            ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getConflictList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getEncoderList

public org.springframework.http.ResponseEntity<EncoderList> getEncoderList(ETagInfo etag)
                                                                    throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getEncoderList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getExpiringList

public org.springframework.http.ResponseEntity<ProgramList> getExpiringList(int startIndex,
                                                                            int count,
                                                                            ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getExpiringList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getFiltererRecordedList

public org.springframework.http.ResponseEntity<ProgramList> getFiltererRecordedList(boolean descending,
                                                                                    int startIndex,
                                                                                    int count,
                                                                                    java.lang.String titleRegEx,
                                                                                    java.lang.String recordingGroup,
                                                                                    java.lang.String storageGroup,
                                                                                    ETagInfo etag)
                                                                             throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getFiltererRecordedList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getRecordSchedule

public org.springframework.http.ResponseEntity<RecRuleWrapper> getRecordSchedule(int recordId,
                                                                                 ETagInfo etag)
                                                                          throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getRecordSchedule in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getRecordScheduleList

public org.springframework.http.ResponseEntity<RecRuleList> getRecordScheduleList(int startIndex,
                                                                                  int count,
                                                                                  ETagInfo etag)
                                                                           throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getRecordScheduleList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getRecorded

public org.springframework.http.ResponseEntity<ProgramWrapper> getRecorded(int channelId,
                                                                           org.joda.time.DateTime startTime,
                                                                           ETagInfo etag)
                                                                    throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getRecorded in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getRecordedList

public org.springframework.http.ResponseEntity<ProgramList> getRecordedList(ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getRecordedList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getRecordedList

public org.springframework.http.ResponseEntity<ProgramList> getRecordedList(int startIndex,
                                                                            int count,
                                                                            boolean descending,
                                                                            ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getRecordedList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getUpcomingList

public org.springframework.http.ResponseEntity<ProgramList> getUpcomingList(int startIndex,
                                                                            int count,
                                                                            boolean showAll,
                                                                            ETagInfo etag)
                                                                     throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

getUpcomingList in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

removeRecordingSchedule

public org.springframework.http.ResponseEntity<Bool> removeRecordingSchedule(int recordingId)
                                                                      throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- POST

Specified by:

removeRecordingSchedule in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

removeRecorded

public org.springframework.http.ResponseEntity<Bool> removeRecorded(int channelId,
                                                                    org.joda.time.DateTime startTime)
                                                             throws MythServiceApiRuntimeException

Description copied from interface: DvrOperations

- GET

Specified by:

removeRecorded in interface DvrOperations

Returns:

Throws:

MythServiceApiRuntimeException

getApiUrlBase

protected java.lang.String getApiUrlBase()

Overrides:

getApiUrlBase in class AbstractOperations

Returns: