|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OcapRecordingRequest
This interface represents a LeafRecordingRequest in OCAP.
When the implementation detects a schedule conflict, it either resolves
the conflict using the Application priority of the conflicting recordings,
or invokes the
ResourceContentionHandler
if one is set. The
resolution of the conflict by the implementation or the
ResourceContentionHandler will result in some of the overlapping
recordings to be pending without conflict and some to be pending
with conflict.
Field Summary | |
---|---|
static int |
CANCELLED_STATE
This recording request was cancelled. |
static int |
TEST_STATE
This recording request is a test recording request. |
Fields inherited from interface org.ocap.shared.dvr.LeafRecordingRequest |
---|
COMPLETED_STATE, DELETED_STATE, FAILED_STATE, IN_PROGRESS_INCOMPLETE_STATE, IN_PROGRESS_INSUFFICIENT_SPACE_STATE, IN_PROGRESS_STATE, IN_PROGRESS_WITH_ERROR_STATE, INCOMPLETE_STATE, PENDING_NO_CONFLICT_STATE, PENDING_WITH_CONFLICT_STATE |
Method Summary | |
---|---|
void |
cancel()
Cancels a pending recording request. |
RecordingList |
getOverlappingEntries()
Gets any other RecordingRequest that overlaps with the duration of this recording request. |
long |
getSpaceRequired()
Gets the estimated space, in bytes, required for the recording. |
boolean |
isStorageReady()
Returns whether the destined MediaStorageVolume for this
recording is present and ready or not. |
void |
setParent(ParentRecordingRequest parent,
int resolutionParentState)
Sets the parent for this recording request. |
Methods inherited from interface org.ocap.shared.dvr.LeafRecordingRequest |
---|
getDeletionDetails, getFailedException, getService, stop |
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 TEST_STATE
static final int CANCELLED_STATE
Method Detail |
---|
void cancel() throws AccessDeniedException
cancel
in interface LeafRecordingRequest
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 state of the recording is not in
PENDING_STATE_NO_CONFLICT_STATE or PENDING_WITH_CONFLICT_STATE.long getSpaceRequired()
RecordingList getOverlappingEntries()
boolean isStorageReady()
MediaStorageVolume
for this
recording is present and ready or not.
MediaStorageVolume
destination of this
recording request can be written to, assuming write permission,
then this method returns true, otherwise it returns
false. If the getDestination
method returns null then
the destination MediaStorageVolume
is a default volume
on a default storage device as determined by the implementation.void setParent(ParentRecordingRequest parent, int resolutionParentState)
OcapRecordingRequest
is removed from a
ParentRecordingRequest
which is in the
COMPLETELY_RESOLVED_STATE, and which contains no other
RecordingRequest
s, that ParentRecordingRequest
SHALL be transitioned to the PARTIALLY_RESOLVED_STATE.
If, as a result of this method invocation, this
OcapRecordingRequest
is removed from a ParentRecordingRequest
which is in the
CANCELLED_STATE and which contains no additional
RecordingRequest
s,
that ParentRecordingRequest
SHALL be deleted from the
recording database.
parent
- The new parent of this leaf recording request or null if the
leaf is to be orphaned.resolutionParentState
- The state into which the parent recording
parameter shall be transitioned to as a result of this method
invocation. If the parent parameter in this method is null, this
parameter is ignored.
java.lang.SecurityException
- if the calling application does not have
RecordingPermission("modify",..) or RecordingPermission("*",..).
java.lang.IllegalStateException
- if the parent parameter is in the
CANCELLED_STATE.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |