Appendix A. Headless behaviour of UI-related APIs (informative)

The behaviour of certain APIs in headless mode (device without a directly connected display) requires a closer consideration. Some APIs were specifically designed for headless operation such as the PBP 1.1 specification, which defines a headless mode and provides methods to enquire the presence of a display.

Appendix B. VOID

Appendix C. Package org.oipf.download

Interface ApplicationDownloadRequest

package org.oipf.download;
import java.io.RandomAccessFile;
/**
 * Represents a content download to be performed by an application.
 * Requests of this type are handled totally by an application. They are
 * created in the PENDING_NO_CONFLICT_STATE. The application handling the
 * request is responsible for downloading the content and all resulting
 * state changes. 
 * Requests of this type shall always be visible to the application specified
 * when the corresponding ApplicationDownloadSpec was created regardless of
 * recording request specific security attributes.
 * The methods defined in this class shall always fail with a ApplicationDownloadException
 * if called by any application other than the one specified when
 * the corresponding ApplicationDownloadSpec was created.
 */
public interface ApplicationDownloadRequest 
   extends org.ocap.shared.dvr.LeafRecordingRequest {
	/**
	 * Return a file to which downloaded data can be written and from
	 * which downloaded data can be read.
	 * @return a File
 	 * @throws ApplicationDownloadException if the caller is not permitted
	 * to call this method as defined above
	 */
	RandomAccessFile getFile() throws ApplicationDownloadException;
	/**
	 * Set the state of the download.
	 * @param state the new state of the recording
	 * @throws ApplicationDownloadException if the caller is not permitted
	 * to call this method as defined above
	 */
	public void setState( int state );

	/**
	 * Set the reason to use for the exception returned by getFailedException.
	 * The reason must be one valid for the constructor of
	 * RecordingFailedException.
	 * @param reason the reason to use when constructing a
	 * RecordingFailedException 
	 */
	public void setFailedReason( int reason );
}

Class LocatorDownloadSpec

package org.oipf.download;

import javax.tv.service.selection.InvalidServiceComponentException;
import javax.tv.locator.Locator;
import java.util.Date;
import org.ocap.shared.dvr.RecordingProperties;
/**
 * Specifies a recording request in terms of a Locator to a file.
 * The identified file is asynchronously downloaded from the network.
 * When instances of this class are passed to RecordingManager.record(..),
 * the following additional failure mode shall apply - if the locator 
 * does not reference a file then the record method shall throw an
 * IllegalArgumentException.
 * No additional failure modes are defined for RecordingRequest.reschedule.
 * For recording requests resulting from a recording spec of this type, 
 * downloading shall start immediately. Such recording requests will never be
 * in a pending or a IN_PROGRESS_INCOMPLETE_STATE state.
 */

public class LocatorDownloadSpec extends org.ocap.shared.dvr.RecordingSpec
{
	/**
	 * Constructor
	 * @param source Source of content to be downloaded
	 * @param properties the definition of how the recording is to be done
	 */
	public LocatorDownloadSpec(Locator source, RecordingProperties properties)
		{ super(properties); }

	/**
	 * Returns the source of the content to be downloaded 
	 * @return the source passed into the constructor
	 */
	public Locator getSource()
		{ return null; }
}

Class ApplicationDownloadException

package org.oipf.download;
/**
 * Thrown when an application calls methods on ApplicationDownloadRequest
 * which it is not permitted to call. 
 **/
public class ApplicationDownloadException extends Exception {
	/**
	 * Constructs a <code>ApplicationDownloadException</code> with <code>null</code>
	 * as its error detail message.
	 */
	public ApplicationDownloadException() { super();}

	/**
	 * Constructs a <code>ApplicationDownloadException</code> with the specified detail
	 * message. The error message string <code>s</code> can later be
	 * retrieved by the <code>{@link java.lang.Throwable#getMessage}</code>
	 * method of class <code>java.lang.Throwable</code>.
	 *
	 * @param   s   the detail message.
	 */
	public ApplicationDownloadException(String s) { super(s); }
}

Class ApplicationDownloadSpec

package org.oipf.download;
import org.dvb.application.AppID;
import org.ocap.shared.dvr.RecordingProperties;
/**
 * Represents a content download to be performed by an application.
 * The application to handle the request and the source of the content
 * to download must be specified when the request is created.
 * No other application is permitted to handle the request.
 * The format of the source must be co-ordinated between the application
 * requesting the download and the application handling the download request.
 */
public class ApplicationDownloadSpec extends org.ocap.shared.dvr.RecordingSpec {
	/**
	 * Create a request for content download by application.
	 * @param app the application to perform the download
	 * @param source the source of the download
	 * @param properties the properties for the download
	 */
	public ApplicationDownloadSpec(AppID app, String source, 
				RecordingProperties properties)
		{super(properties);}
	/**
	 * Return the application ID specified.
	 * @return an application ID
	 */
	public AppID getAppID(){return null;}
	/**
	 * Return the source specified.
	 * @return a String
	 */
	public String getSource(){return null;}
}

Appendix D. Package org.oipf.service

Interface ServiceCreator

package org.oipf.service;
import javax.tv.locator.Locator;
import javax.tv.service.Service;
import javax.tv.locator.InvalidLocatorException;
/**
 * This interface extends javax.tv.service.SIManager with overloaded methods
 * for creating IPTV services.
 */
public interface ServiceCreator {
	/**
	 * Get a service from a locator for the streaming component
	 * and an XML AIT fragment for the application component.
	 * This permits service bound applications to be used without
	 * application signalling in-band in the A/V content. 
	 * @param locator A locator identifying a service
	 * @param ait An XML AIT fragment
	 * @return a Service
	 * @throws InvalidLocatorException If locator does not identify a valid
	 * Service. 
	 * java.lang.SecurityException If the caller does not have
	 * javax.tv.service.ReadPermission(locator).
	 */
	public abstract Service getService( Locator locator, String ait );

	/**
	 * Get a service from a piece of SDP information describing some A/V
	 * content.
	 * @param sdp the piece of SDP information
	 * @return a Service
	 * @throws InvalidLocatorException If locator n the SDP information 
	 * does not identify a valid Service. 
	 * @throws java.lang.SecurityException If the caller does not have
	 * javax.tv.service.ReadPermission for the locator in the SDP information
	 */
	public abstract Service getService( String sdp );

	/**
	 * Get a service from a piece of SDP information describing some A/V content and
	 * an XML AIT fragment for the application component. This permits service bound
	 * applications to be used without application signalling in-band in the A/V
	 * content.
	 * @param sdp the piece of SDP information
	 * @param ait An XML AIT fragment
	 * @return a Service
	 * @throws InvalidLocatorException If locator n the SDP information does not 
	 * identify a valid Service.
	 * @throws java.lang.SecurityException If the caller does not have
	 * javax.tv.service.ReadPermission for the locator in the SDP information
	 */
	public abstract Service getService( String sdp, String ait );
}

Appendix E. org.oipf.auth

Class HTTPDigestCredentials

package org.oipf.auth;
/**
 * Credentials to be used
 */
public class HTTPDigestCredentials extends UserCredentials
{
	/**
	 * Create an HTTPDigestCredentials.
	 * @param domain the domain
	 * @param realm	the realm
	 * @param username the username
	 * @param password the password
	 */
	public HTTPDigestCredentials( String domain, String realm, String username,
		String password ) {super(domain);}
	/**
	 *
	 */
	public String getRealm(){return null;}
	/**
	 *
	 */
	public String getUsername() {return null;}
	/**
	 *
	 */
	public String getPassword() { return null;}

}

Class UserAuthenticationPermission

package org.oipf.auth;
/**
 * This class represents a Permission to access user authentication information
 * for a particular domain.
 * The name string is a fully qualified domain name. The actions string is unused.
 */
public final class UserAuthenticationPermission extends java.security.BasicPermission {
	/**
	 * Creates a new UserAuthenticationPermission.
	 */
	public UserAuthenticationPermission() {super("toto");}

	/**
	 * Creates a new UserAuthenticationPermission. 
	 * The actions string is currently unused and should be null.
	 * The name string shall be a fully qualified domain name.
	 * @param name the name of the permission
	 * @param actions the actions string
	 */
	public UserAuthenticationPermission(String name, String actions)
		{super(name);}

	/**
	 * Returns the list of actions that had been passed to the
	 * constructor - it shall return null.
	 *
	 * @return a null String.
 	 */
	public String getActions() { return null;}

	/**
	 * Checks if this UserAuthenticationPermission object "implies" the 
	 * specified permission. 
	 * @param permission the specified permission to check.
	 * @return true if and only if the specified permission is an instanceof
	 * and the domain in this object domain-matches
	 * the domain in the specified permission as defined by RFC2965.
	 */
	public boolean implies(java.security.Permission permission) {return true;}

	/**
	 * Checks for equality against this UserAuthenticationPermission object. 
 	 * @param obj the object to test for equality with this 
	 * UserAuthenticationPermission object.
	 * @return true if and only if obj is an UserAuthenticationPermission and 
	 * the two domain names are equal.
	 */
	public boolean equals(Object obj) { return true;}

	/**
	 * Returns the hash code value for this object.
	 * @return the hash code value for this object.
	 */
	public int hashCode() { return 0 ;}
}

Class UserAuthenticationManager

package org.oipf.auth;
/**
 *
 */
public class UserAuthenticationManager {
	/*
	 */
	private UserAuthenticationManager() {}

	/**
	 * Return a UserAuthenticationManager
	 * @return a UserAuthenticationManager
	 */
	public static UserAuthenticationManager getUserAuthenticationManager()
		{return null;}
	/**
	 * Get credentials which authenticate the current user to the specified
	 * domain.
	 * @param domain the domain
	 * @return an array of credentials objects
	 * @throws SecurityException if the calling application does not have
	 * UserAuthenticationPermission for the domain
	 */
	public UserCredentials[] getCredentials( String domain ) { return null;}

	/**
	 * Set credentials
	 * @param credentials the credentials to set
	 * @throws SecurityException if the calling application is not permitted
	 * to set credentials for the domain
	 */
	public void setCredentials( UserCredentials credentials ){}
} 

Class UserCredentials

package org.oipf.auth;
/**
 * Base class for different kinds of credentials
 */
public abstract class UserCredentials
{
	/**
	 * Create a UserCredentials
	 * @param domain the domain to which the credentials apply
	 */
	public UserCredentials( String domain ){}
	/*
	 * Return the domain for which a set of credentials apply
	 * @return a domain
	 */
	public String getDomain() { return null ; }
} 

Class CookieCredentials

package org.oipf.auth;
import java.util.Date;
/**
 * Represents a HTTP Cookie.
 * This class is purely a container for the information passed in
 * through the constructor. No checking of the information is
 * performed. The accessor methods return the values passed in
 * through the constructor.
 */
public class CookieCredentials extends UserCredentials
{
	/**
	 * Construct a cookie
	 * @param domain the domain to which the cookie is sent
	 * @param path the path within the domain 
	 * @param name the name of the cookie
	 * @param value the value of the cookie
	 * @param expiry the expiry date of the cookie or null if none is set
	 */
	public CookieCredentials( String domain, String path, String name,
			String value, Date expiry )
		{super(domain); 	}
	/**
	 * return the name of the cookie
	 * @return the name as passed to the constructor
	 */
	public String getName() { return null;}
	/**
	 * return the value of the cookie
	 * @return the value as passed to the constructor
	 */
	public String getValue() { return null;}
	/**
	 * return the expiry date of the cookie
	 * @return the expiry date of the cookie or null if none is set
	 */
	public Date getExpiry() { return null;}
	/**
	 * return the path of the cookie
	 * @return the path as passed to the constructor
	 */
	public String getPath() { return null;}
} 

Appendix F. org.oipf.uiserver

Class UIServerManager

package org.oipf.uiserver;
/**
 * Enables applications to register as providing a remote UI.
 * This class is intended to be used as follows;>
 * - The application starts listening on one or more ports.
 * - For each service offered, the application constructs URLs
 *   from the IP address of the device, the port number and any 
 *   path element used by the application.
 * - For each service offered, the application constructs XML
 *   fragments as specified by CEA-2014.
 * - The remote UIs provided by all registered applications are combined
 *   into a single remote UI listing as defined by CEA-2014.
 * - The results are made available to remote UI clients as defined
 *   by CEA-2014.
 * 
 */
public class UIServerManager {
	/*
	 * Private constructor to stop javadoc generating one.
	 */
	private UIServerManager() {}
	/**
	 * Obtain a UIServerManager
	 */
	public static UIServerManager getManager(){ return null;}
	/**
	 * Register as providing a remote UI service.
	 * @param desc the entry for the service or services available on
	 * this port formatted according to CEA-2014.
	 * @throws IllegalArgumentException if there are errors in the 
	 * descriptions provided
	 */
	public void registerUIServer( String desc[]){}
	/**
	 * Unregister from providing a remote UI service
	 */
	public void unregisterUIServer(){}
}

Appendix G. org.oipf.drm

The DRM Systems names are defined as URNs with the DVB CA System ID (16 bit number) in there. A DRM System name shall be signaled by prefixing the decimal number format of CA_System_ID with "urn:dvb:casystemid:" as defined for the DRMSystemID attribute in [OIPF_META2]. Note that the decimal number format of CA_System_ID shall not have leading zeroes.

Class DRMAgentEvent

package org.oipf.drm;
/**
 * The <code>DRMAgentEvent</code> class reports events from
 * a DRM system.
 * @since   Release 1
 */
public class DRMAgentEvent extends java.util.EventObject{
	/**
	 * ID indicating the cause of the event was 
	 * success of a message sent to a DRM agent.
	 */
	static public final int SUCCESS = 0;
	/**
	 * ID indicating the cause of the event was
	 * failure of a message sent to a DRM agent
	 */
	static public final int FAILURE = 1;
	/**
	 * ID indicating the cause of the event 
	 * was something other than a message sent
	 * to a DRM Agent using this package.
	 */
	static public final int OTHER = 2;

	/**
	 * Reason for failure events - cannot process request.
	 * The request failed because the DRM agent was unable to 
	 * complete the necessary computations in the time allotted.
	 */
	static public final int TIMEOUT = 1;
	/**
	 * Reason for failure events - Unknown MIME type.
	 * The request failed because the specified Mime Type is 
	 * unknown for this DRM system.
	 */
	static public final int UNKNOWN_TYPE = 2;
	/**
	 * Reason for failure events - User Consent Needed.
	 * The request failed because user consent is needed for that action.
	 */
	static public final int USER_CONSENT = 3;
	/**
	 * Reason for failure events - other unspecified reason
	 * The request failed because an unspecified error occurred.
	 */
	static public final int UNSPECIFIED = 4;

	/**
	 * Create a new DRMAgentEvent object.
	 *   
	 * @param cause ID indicating the cause of the event being sent
	 * @param reason For FAILURE events, the reason for the failure, otherwise 0.
	 * @param source the DRM agent which is the source of the event
	 * @param msgID for SUCCESS or FAILURE events, the message id returned
	 * when the corresponding message was sent to the DRM agent otherwise
	 * null.
	 */
	public DRMAgentEvent(DRMAgent source, int msgID, int cause, int reason )
		{super((Object)source);}

	/**
	 * gets the message ID
	 * @return the message ID as passed to the class constructor
	 */
	public int getMsgID(){return 0;}

	/**
	 * gets the cause of the event
	 * @return one of the cause constants as defined in this class
	 */
	public int getCause(){return 0;}

	/**
	 * gets the reason for a failure
	 * @return one of the reason constants as defined in this class
	 */
	public int getReason(){return 0;}
}

Class DRMAgentPermission

package org.oipf.drm;

/**
 * This class represents a Permission to exchange messages with a DRM system.
 * The name string can be either a comma separated list of DRM system names
 * or "*". The actions string is unused.
 */
public final class DRMAgentPermission extends java.security.BasicPermission {
	/**
	 * Creates a new DRMAgentPermission.
	 */
	public DRMAgentPermission()
	{super("toto");}

	/**
	 * Creates a new DRMAgentPermission. 
	 * The actions string is currently unused and should be null. The name string 
	 * shall be either a comma separated list of DRM  * system names or "*".
	 * @param name the name of the permission
	 * @param actions the actions string
	 */
	public DRMAgentPermission(String name, String actions) {super(name);}

	/**
	 * Returns the list of actions that had been passed to the
	 * constructor - it shall return null.
	 *
	 * @return a null String.
 	 */
	public String getActions() { return null;}

	/**
	 * Checks if this DRMAgentPermission object "implies" the specified permission. 
	 * @param permission the specified permission to check.
	 * @return true if and only if the specified permission is an instanceof
	 * DRMAgentPermission
	 */
	public boolean implies(java.security.Permission permission) {return true;}

	/**
	 * Checks for equality against this DRMAgentPermission object. 
	 *
 	 * @param obj the object to test for equality with this DRMAgentPermission object.
	 * @return true if and only if obj is an DRMAgentPermission
	 */
	public boolean equals(Object obj) { return true;}

	/**
	 * Returns the hash code value for this object.
	 *
	 * @return the hash code value for this object.
	 */
	public int hashCode() { return 0;}
}

Interface DRMAgentListener

package org.oipf.drm; 
import java.util.*;

/**
 * The <code>DRMAgentListener</code> class allows an
 * application to be told about asynchronous events relating
 * to a DRM system. When a message is sent to a DRM agent,
 * success is always reported asynchronously and errors which
 * cannot be detected immediately are also reported asynchronously.
 *
 * @since   Release 1
 */  
public interface DRMAgentListener extends EventListener{
 	/**
	 * An operation triggered by a message sent through
	 * the DRMAgent has succeeded.
	 * @param resultMsg the DRM specific message result
	 * @param msgID the message ID provided when the message
	 * which triggered this operation was sent to the DRM agent
	 */
	public void success(String resultMsg, String msgID );

	/**
	 * An operation triggered by a message sent through the
	 * DRMAgent has failed.
	 * @param reason the reason for the failure
	 * @param msgID the message ID provided when the message
	 * which triggered this operation was sent to the DRM agent
	 */
	public void failed( String reason, String msgID );

	/**
	 * An event has happened unrelated to a message sent through
	 * the DRMAgent.
	 * @param evt the event
	 */
	public void receive( DRMAgentEvent evt );
}

Class DRMAgent

package org.oipf.drm;
import java.io.IOException;
/**
 * Represents a generic DRM Agent.
 */
public class DRMAgent {
	/*
	 * private constructor
	 */
	private DRMAgent(){}
	/**
	 * Obtain a DRM agent
	 * @param name the name of the DRM system to obtain an agent for
	 * @return a DRMAgent or null if the named DRM system is not supported
 	 * @throws SecurityException if the DRM system is supported but the
	 * calling application does not have either DRMAgentPermission with
	 * the name of the system or with "*"
	 */
	public static DRMAgent getAgent(String name){ return new DRMAgent(); }

	/**
	 * Obtain the list of supported DRM systems.
	 * @return an array of DRM system names. If no DRM systems are supported
	 * then an array of length zero shall be returned.
	 */
	public static String[] getAgents() { return null ; }
	/**
	 * Send a message to a DRM agent.
	 * @param msgType A globally unique message type as defined by the DRM
	 * system. For example:- application/vnd.marlin.drm.actiontoken+xml
	 * (i.e. MIME-type of Marlin Action Token)
	 * @param message The message to be provided to the underlying DRM agent
	 * formatted according to the message type as indicated by msgType
	 * @throws DRMAgentException If the message cannot be processed and this
	 * can be determined immediately without any network access. For example,
	 * a syntax error in the message.
	 * @return an ID which shall be part of all events associated with this message.
	 */
	public int sendMessage(String msgType, String message) 
		throws DRMAgentException { return 0; }

	/**
	 * Fetch a message from the network and send it to a DRM agent.
	 * Failure to process the message is reported asynchronously.
	 * @param message the URL of the message to fetch
	 * @param msgID A unique ID to identify the message, to be provided as
	 * part of all events posted as a consequence of this message
	 * @throws java.io.IOException if the message cannot be fetched
	 */
	public void fetchAndSendMessage(java.net.URL message, String msgID) 
		throws IOException {}

	/**
	 * Add a listener for DRMAgent events. 
	 * If the listener is already added then this method has no effect.
	 * @param l the listener to add
	 */
	public void addListener( DRMAgentListener l) {}

	/**
	 * Remove a listener for DRMAgent events.
	 * If the listener is not added then this method has no effect.
	 * @param l the listener to remove
	 */
	public void removeListener( DRMAgentListener l) {}
}

Class DRMAgentException

package org.oipf.drm; 
/**  
  * The <code>DRMAgent</code> exception is thrown if a   
  * message to be sent to a DRM agent contains an error and this can
  * be immediately detected. For example, a syntax error.
  * 
  * @since   Release 1
 */ 
public class DRMAgentException extends Exception { 	
    /*
     *
     * Construct a DRMAgentException with no detail message
     */
    public DRMAgentException() {} 
    /*
     *
     * Construct a DRMAgentException with a detail message
     * @param s detail message
     */
    public DRMAgentException(String s) {} 
}

Class DRMRightsErrorEvent

package org.oipf.drm;
/**
 * Represents an error event raised when a player
 * tries to play a protected content without a license
 * or with an invalid license 
 */
public class DRMRightsErrorEvent extends ControllerErrorEvent {
	/**
	 *  errorState valid values
	 */
	static public final int NOLICENSE = 0;
	static public final int LICENSEINVALID = 1;

	protected Integer errorState;

	/**
	 * The unique identifier of the protected content in the scope of the DRM
	 * system that raises the error
	 */
	protected String contentID;

	/**
	 * The DRM System name 
	 */
	protected String DRMSystemName;

	/**
	 * The rightsIssuerUrl optional element indicating the URL that
	 * can be used to non-silently obtain the rights for the content 
	 * item currently being played for which this DRM error is generated 
	 */
	protected String rightsIssuerUrl;

	/**
	 * Constructor
	 */
	public DRMRightsErrorEvent (Controller from, String message, Integer errorState,
			String contentID, String DRMSystemID, String rightsIssuerUrl) {
		super(from, message);
	}

	/**
	 * Gets the errorState value
	 * @return errorState describing the current state (NOLICENSE or LICENSEINVALID).
	 */
	public Integer getErrorState() {return errorState;}

	/**
	 * Gets the contentID value
	 * @return contentID of the content.
	 */
	public Integer getContentID () {return contentID;}

	/**
	 * Gets the DRM System name value 
	 * @return DRM System name describing the DRM System that generated
	 * the error.
	 */
	public String getDRMSystemID () {return DRMSystemID;}

	/**
	 * Gets the rightsIssuerUrl value
	 * @return rightsIssuerUrl for license retrieval.
	 */
	public String getRightsIssuerUrl () {return rightsIssuerUrl;} 
} 

Appendix H. org.oipf.pvr

Class RecordingAccessPermissions

package org.oipf.pvr;

/**
 * This class encapsulates permissions to access recordings.
 * World means all applications authorised to access persistent storage.
 * Owner means the application which created the file. Organisation is defined
 * as applications with the same organisation id as defined elsewhere in the
 * present document.
 * Additionally other organisation_ids may be permitted without providing world access.
 */

public class RecordingAccessPermissions extends org.dvb.io.persistent.FileAccessPermissions {
	
	/**
	 * This constructor encodes all the file access permissions as a set of booleans.
 	 *
	 * @param readWorldAccessRight read access for all applications
	 * @param writeWorldAccessRight write access for all applications
	 * @param readOrganisationAccessRight read access for organisation
	 * @param writeOrganisationAccessRight write access for organisation
	 * @param readApplicationAccessRight read access for the owner
	 * @param writeApplicationAccessRight write access for the owner
	 * @param readWhiteList read access for applications from these organisations
	 * @param writeWhiteList write access for applications from these organisations
	 */
	public RecordingAccessPermissions(boolean readWorldAccessRight, 
			boolean writeWorldAccessRight, 
			boolean readOrganisationAccessRight, 
			boolean writeOrganisationAccessRight,
			boolean readApplicationAccessRight, 
			boolean writeApplicationAccessRight,
			int[] readWhiteList, int[] writeWhiteList) 
		{ super(readWorldAccessRight, writeWorldAccessRight,
		readOrganisationAccessRight, writeOrganisationAccessRight,
		readApplicationAccessRight, writeApplicationAccessRight); }
	
	/**
	 * Query whether this permission includes read access for the organisation
	 * @param org_id the organisation
	 * @return true if applications in this organisation can have read access, 
	 *  otherwise false.
	 */
	public boolean hasReadOrganisationAccessRight(int org_id) {return false;}
	
	/**
	 * Query whether this permission includes write access for the organisation
	 * @param org_id the organisation
	 * @return true if applications in this organisation can have read access, 
	 *  otherwise false.
	 */
	public boolean hasWriteOrganisationAccessRight(int org_id) {return false;}
}

Class RecordingProperties

package org.oipf.pvr;

/**
 * Encapsulates the details about how a recording is to be made.
 */

public class RecordingProperties extends org.ocap.shared.dvr.RecordingProperties { 
	/**
	 * Constructor
	 * @param expirationPeriod the period in seconds after the initiation of
	 * recording when leaf recording requests with this recording
	 * property are deemed as expired.
	 * @param validityPeriod the period in seconds after the registration of the
	 * RecordingRequest before which recordings which have not been completed
	 * successfully shall not be discarded.
	 * @param requestedRecording the recording access permissions for recording
	 * requests
	 * @param completedRecording the recording access permissions for completed
	 * recordings
	 * @param priority the priority of this recording request
	 * @throws IllegalArgumentException if the expirationPeriod or the validityPeriod 
     * is negative
 	 */
	public RecordingProperties(long expirationPeriod,
		long validityPeriod, RecordingAccessPermissions requestedRecording,
		RecordingAccessPermissions completedRecording, int priority)
		throws IllegalArgumentException
	{
		super(expirationPeriod);
	}
	/**
	 * Return the period in seconds after the registration of
	 * the <code>RecordingRequest</code> after which recordings which have
	 * not been completed successfully should be discarded.
	 * Implementations may impose a upper bound on the validity period and 
	 * cap the validity period requested to that upper bound.
	 * @return the validity period that will be used for the recording
	 * after capping to any implementation defined upper bound
	 */
	public long getValidityPeriod() {return 0;}
	/**
	 * Return the recording access permissions for recording requests.
	 * @return the recording access permissions for recording requests
	 */
	public RecordingAccessPermissions getRequestedRecordingPermissions(){return null;}
	/**
	 * Return the recording access permissions for completed recordings
	 * @return the recording access permissions for completed recordings
	 */
	public RecordingAccessPermissions getCompletedRecordingPermissions() 
		{return null;}
	/**
	 * Return the priority for this recording request.
	 * @return the priority for this recording request.
	 */
	public int getPriority(){return 0;}
}