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

Fields

Modifier and Type	Field and Description
static String	PROP_NET_RECORDING_ENTRY Key for returning the property which indicates that this entry is a NetRecordingEntry.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRecordingContentItem(RecordingContentItem item) Adds a local RecordingContentItem to this recording object
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

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

Field Detail

PROP_NET_RECORDING_ENTRY

static final String PROP_NET_RECORDING_ENTRY

Key for returning the property which indicates that this entry is a NetRecordingEntry. Values returned for this key will be represented as a Boolean.

See Also:

Constant Field Values

Method Detail

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