org.ocap.hn.recording
Interface NetRecordingEntry

All Superinterfaces:

ContentEntry

public interface NetRecordingEntry
extends ContentEntry

This ContentEntry represents a series recording that has been scheduled on the home network.

Field Summary

static String	PROP_CDS_REFERENCE Key constant for retrieving the CDS reference of this recording entry from this entry's metadata.
static String	PROP_RCI_LIST Key constant for retrieving the RCI list of this recording entry from this entry's metadata.
static String	PROP_SCHEDULED_CDS_ENTRY_ID Key constant for retrieving the scheduled CDS entry ID of this recording entry from this entry's metadata.

Method Summary

void	addRecordingContentItem(RecordingContentItem item) Adds a local RecordingContentItem to this recording object
boolean	deleteEntry() Deletes this NetRecordingEntry if and only if it contains no RecordingContentItems.
String[]	getRecordingContentItemIDs() Retrieves ObjectIDs of the individual RecordingContentItems that make up this series recording.
RecordingContentItem[]	getRecordingContentItems() Retrieves the local individual RecordingContentItems that make up this series recording.
void	removeRecordingContentItem(RecordingContentItem item) Removes a local RecordingContentItem from this recording object.

Methods inherited from interface org.ocap.hn.content.ContentEntry

getContentSize, getCreationDate, getEntryParent, getExtendedFileAccessPermissions, getID, getParentID, getRootMetadataNode, getServer, isLocal

Field Detail

PROP_CDS_REFERENCE

static final String PROP_CDS_REFERENCE

Key constant for retrieving the CDS reference of this recording entry from this entry's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_RCI_LIST

static final String PROP_RCI_LIST

Key constant for retrieving the RCI list of this recording entry from this entry's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

PROP_SCHEDULED_CDS_ENTRY_ID

static final String PROP_SCHEDULED_CDS_ENTRY_ID

Key constant for retrieving the scheduled CDS entry ID of this recording entry from this entry's metadata. Values returned for this key will be represented as a String.

See Also:

Constant Field Values

Method Detail

deleteEntry

boolean deleteEntry()
                    throws IOException

Deletes this NetRecordingEntry if and only if it contains no RecordingContentItems. Deletes a local NetRecordingEntry only. If the #isLocal method returns false an exception is thrown.

Specified by:

deleteEntry in interface ContentEntry

Returns:

True if this NetRecordingEntry was deleted, otherwise returns false.

Throws:

SecurityException - if the application does not have write ExtendedFileAccessPermission.

IOException - if the NetRecordingEntry is not local.

getRecordingContentItems

RecordingContentItem[] getRecordingContentItems()
                                                throws IOException

Retrieves the local individual RecordingContentItems that make up this series recording.

Returns:

the RecordingContentItems in this series

Throws:

IOException - if this isLocal() method of this object does not return true

addRecordingContentItem

void addRecordingContentItem(RecordingContentItem item)
                             throws IOException

Adds a local RecordingContentItem to this recording object

Parameters:

item - The recording content item to add to this series

Throws:

IOException - if this isLocal() method of this object does not return true

IllegalStateException - if this recording object is not associated with a UPnP AV Scheduled Recording Service Object (RerordSchedule)

IllegalArgumentException - if the RecordingContentItem paramter has the associated UPnP AV Scheduled Recording Service Object (RecordTask)

SecurityException - if the caller does not have HomeNetPermission("recordinghandler")

removeRecordingContentItem

void removeRecordingContentItem(RecordingContentItem item)
                                throws IOException

Removes a local RecordingContentItem from this recording object. If the RecordingContentItem passed into this method is not contained in this NetRecordingObject, this method has no effect.

Parameters:

item - The recording content item to remove from this series

Throws:

IOException - if this isLocal() method of this object does not return true

IllegalArgumentException - if the RecordingContentItem paramter has the associated UPnP AV Scheduled Recording Service Object (RecordTask)

SecurityException - if the caller does not have HomeNetPermission("recordinghandler")

getRecordingContentItemIDs

String[] getRecordingContentItemIDs()

Retrieves ObjectIDs of the individual RecordingContentItems that make up this series recording.

Returns:

the ObjectIDs of the RecordingContentItems in this series