|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LeafRecordingRequest
This interface represents information corresponding to a leaf level recording request. The recording request represented by this interface corresponds to a recording request that has been completely resolved to a single recording.
A leaf recording request may be pending (i.e. waiting for the start-time to occur), in-progress, completed, incomplete, or failed.
While in pending state, a recording request may be in conflict for resources with other recordings. Any such conflicts must be resolved before the scheduled start time of the recording, if not, the pending recording request is expected to result in a failed recording.
Field Summary | |
---|---|
static int |
COMPLETED_STATE
Recording for this recording request has completed successfully. |
static int |
DELETED_STATE
The recorded service corresponding to this recording request has been deleted. |
static int |
FAILED_STATE
The recording request has failed. |
static int |
IN_PROGRESS_INCOMPLETE_STATE
The recording request is in progress and recording, but cannot be completed because it was started after the start_time or it was interrupted and re-started. |
static int |
IN_PROGRESS_INSUFFICIENT_SPACE_STATE
Recording has been initiated for this recording request and is ongoing, but the implementation has detected that storage space may not be sufficient to complete the recording. |
static int |
IN_PROGRESS_STATE
Recording has been initiated for this recording request and is ongoing. |
static int |
IN_PROGRESS_WITH_ERROR_STATE
The recording request is in progress but recording cannot take place due to some error; e.g. lack of resources. |
static int |
INCOMPLETE_STATE
Recording for this recording request was initiated but failed. |
static int |
PENDING_NO_CONFLICT_STATE
The recording request is Pending. |
static int |
PENDING_WITH_CONFLICT_STATE
The recording request may not be intiated due to resource conflicts. |
Method Summary | |
---|---|
void |
cancel()
Cancels a pending recording request. |
DeletionDetails |
getDeletionDetails()
Gets detailed information about the deletion of the recorded service corresponding to this recording request. |
java.lang.Exception |
getFailedException()
Gets the exception that caused the recording request to enter the FAILED_STATE ,
or INCOMPLETE_STATE or IN_PROGRESS_WITH_ERROR_STATE , or
IN_PROGRESS_INCOMPLETE_STATE . |
SegmentedRecordedService |
getService()
Returns the SegmentedRecordedService corresponding to the recording request. |
void |
stop()
Stops the recording for an in-progress recording request regardless of how much of the duration has been recorded. |
Methods inherited from interface org.ocap.shared.dvr.RecordingRequest |
---|
addAppData, delete, getAppData, getAppID, getId, getKeys, getParent, getRecordingSpec, getRoot, getState, isRoot, removeAppData, reschedule, setRecordingProperties |
Field Detail |
---|
static final int PENDING_NO_CONFLICT_STATE
static final int PENDING_WITH_CONFLICT_STATE
static final int IN_PROGRESS_STATE
static final int IN_PROGRESS_INSUFFICIENT_SPACE_STATE
static final int INCOMPLETE_STATE
static final int COMPLETED_STATE
static final int FAILED_STATE
static final int DELETED_STATE
static final int IN_PROGRESS_WITH_ERROR_STATE
static final int IN_PROGRESS_INCOMPLETE_STATE
Method Detail |
---|
void cancel() throws java.lang.IllegalStateException, AccessDeniedException
AccessDeniedException
- if the calling application is not permitted to
perform this operation by RecordingRequest specific security attributes.
java.lang.SecurityException
- if the calling application does not have
RecordingPermission("cancel",..) or RecordingPermission("*",..)
java.lang.IllegalStateException
- if the stateof the recording is not in
PENDING_NO_CONFLICT_STATE or PENDING_WITH_CONFLICT_STATE.void stop() throws java.lang.IllegalStateException, AccessDeniedException
AccessDeniedException
- if the calling application is not permitted to perform
this operation by RecordingRequest specific security attributes.
java.lang.SecurityException
- if the calling application does not have
RecordingPermission("cancel",..) or RecordingPermission("*",..)
java.lang.IllegalStateException
- if the recording is not in the
IN_PROGRESS_STATE, or IN_PROGRESS_INSUFFICIENT_SPACE_STATE
or IN_PROGRESS_WITH_ERROR_STATE, or IN_PROGRESS_INCOMPLETE_STATE..java.lang.Exception getFailedException() throws java.lang.IllegalStateException
FAILED_STATE
,
or INCOMPLETE_STATE
or IN_PROGRESS_WITH_ERROR_STATE
, or
IN_PROGRESS_INCOMPLETE_STATE
.
java.lang.IllegalStateException
- if the recording request is not in the
FAILED_STATE or INCOMPLETE_STATE or IN_PROGRESS_WITH_ERROR_STATE,
or IN_PROGRESS_INCOMPLETE_STATE.SegmentedRecordedService getService() throws java.lang.IllegalStateException, AccessDeniedException
SegmentedRecordedService
corresponding to the recording request.
java.lang.IllegalStateException
- if the recording request is not in
INCOMPLETE_STATE, IN_PROGRESS_STATE, IN_PROGRESS_INSUFFICIENT_SPACE_STATE,
IN_PROGRESS_WITH_ERROR_STATE, IN_PROGRESS_INCOMPLETE_STATE,
or COMPLETED_STATE.
AccessDeniedException
- if the calling application is not permitted
to perform this operation by RecordingRequest specific security attributes.DeletionDetails getDeletionDetails() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if the recording request is not in the
DELETED_STATE.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |