org.ocap.application.OcapAppAttributes.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ocap-api Show documentation

There is a newer version: 1.3.1







OcapAppAttributes























  
      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD









org.ocap.application


Interface OcapAppAttributes

All Superinterfaces: 
AppAttributes



public interface OcapAppAttributesextends AppAttributes





 This interface represents various information about an application 
 registered in the AppsDatabase. 
 This interface extends the org.dvb.application.AppAttributes in the 
 points of following: 
 

  Defining the OCAP Application types.
 

  Adding the getControlFlag method to get the application_control_code 
    flag as signaled in an AIT or an XAIT.
 
 
 For applications which are signaled in the AIT or the XAIT, the 
 mapping between the values returned by methods 
 in this interface and the fields and descriptors of the AIT or the 
 XAIT shall be as specified in this specification. 
 Instance of the class implementing this interface are immutable. 
 

 org.dvb.application.AppsDatabase MUST return an instance of OcapAppAttributes by the 
 getAppAttributes methods.
 












Field Summary



static int
AUTOSTART



          This represents the application control code "AUTOSTART" 
 defined for the application_control_code in an AIT or a XAIT.



static int
BACKGROUND_MODE



          This represents the "background" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.



static int
CROSSENVIRONMENT_MODE



          This represents the "cross-environment" application mode defined for the
 application_mode_descriptor in an or XAIT.



static int
DESTROY



          This represents the application control code "DESTROY" 
 defined for the application_control_code in an AIT or a XAIT.



static int
KILL



          This represents the application control code "KILL" 
 defined for the application_control_code in an AIT or a XAIT.



static int
LEGACY_MODE



          This represents the "legacy" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.



static int
NORMAL_MODE



          This represents the "normal" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.



static int
OCAP_J



          The OCAP registered value for all OCAP-J applications.



static int
PAUSED_MODE



          This represents the "paused" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.



static int
PREFETCH



          The application control code "PREFETCH" is only used
 for DVB-HTML applications.



static int
PRESENT



          This represents the application control code "PRESENT" 
 defined for the application_control_code in an AIT or a XAIT.



static int
REMOTE



          This represents the application control code "REMOTE" 
 defined for the application_control_code in an AIT.


 


Fields inherited from interface org.dvb.application.AppAttributes


DVB_HTML_application, DVB_J_application


 






Method Summary



 int
getApplicationControlCode()



          This method returns the application_control_code of the 
 application represented by this interface.



 int
getApplicationMode()



          Returns the signaled application mode for this application.



 int
getStoragePriority()



          This method returns the currently set storage priority for the application.



 boolean
hasNewVersion()



          Indicates that a new version of the application is stored that 
 will replace the currently launched version when a new lifecycle
 for this application starts.



 boolean
isNewVersionSignaled()



          Indicates that a new version of the application is available and 
 will replace the currently launched version when a new lifecycle
 for this application starts.


 


Methods inherited from interface org.dvb.application.AppAttributes


getAppIcon, getIdentifier, getIsServiceBound, getName, getName, getNames, getPriority, getProfiles, getProperty, getServiceLocator, getType, getVersions, isStartable, isVisible


 








Field Detail




OCAP_J
static final int OCAP_J

The OCAP registered value for all OCAP-J applications.


See Also:
Constant Field Values




AUTOSTART
static final int AUTOSTART

This represents the application control code "AUTOSTART" 
 defined for the application_control_code in an AIT or a XAIT.


See Also:
Constant Field Values




PRESENT
static final int PRESENT

This represents the application control code "PRESENT" 
 defined for the application_control_code in an AIT or a XAIT.


See Also:
Constant Field Values




DESTROY
static final int DESTROY

This represents the application control code "DESTROY" 
 defined for the application_control_code in an AIT or a XAIT.


See Also:
Constant Field Values




KILL
static final int KILL

This represents the application control code "KILL" 
 defined for the application_control_code in an AIT or a XAIT.


See Also:
Constant Field Values




PREFETCH
static final int PREFETCH

The application control code "PREFETCH" is only used
 for DVB-HTML applications.


See Also:
Constant Field Values




REMOTE
static final int REMOTE

This represents the application control code "REMOTE" 
 defined for the application_control_code in an AIT.


See Also:
Constant Field Values




LEGACY_MODE
static final int LEGACY_MODE

This represents the "legacy" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.


See Also:
Constant Field Values




NORMAL_MODE
static final int NORMAL_MODE

This represents the "normal" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.


See Also:
Constant Field Values




CROSSENVIRONMENT_MODE
static final int CROSSENVIRONMENT_MODE

This represents the "cross-environment" application mode defined for the
 application_mode_descriptor in an or XAIT.


See Also:
Constant Field Values




BACKGROUND_MODE
static final int BACKGROUND_MODE

This represents the "background" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.


See Also:
Constant Field Values




PAUSED_MODE
static final int PAUSED_MODE

This represents the "paused" application mode defined for the
 application_mode_descriptor in an AIT or XAIT.


See Also:
Constant Field Values








Method Detail




getApplicationControlCode
int getApplicationControlCode()

This method returns the application_control_code of the 
 application represented by this interface.






Returns:
int The application_control_code of the application 
             represented by this interface.





getStoragePriority
int getStoragePriority()

This method returns the currently set storage priority for the application.






Returns:
int  The storage priority for a currently stored application
              or zero if the application is not stored.





hasNewVersion
boolean hasNewVersion()

Indicates that a new version of the application is stored that 
 will replace the currently launched version when a new lifecycle
 for this application starts.
 
 This method SHALL return true if getStoragePriority()
 would return non-zero for the newer version of the application after 
 it replaces the currently launched version.
 This method SHALL return false if isNewVersionSignaled()
 would return false.






Returns:
True, if the application is currently launched but a new
          version is signaled and stored.
          False, if the application is not currently launched, if
          the currently signaled version matches the currently launched
          version, or the new version is not yet stored.





isNewVersionSignaled
boolean isNewVersionSignaled()

Indicates that a new version of the application is available and 
 will replace the currently launched version when a new lifecycle
 for this application starts.






Returns:
True, if the application is currently launched but a new
          version is signaled.
          False, if the application is not currently launched or if
          the currently signaled version matches the currently launched
          version.





getApplicationMode
int getApplicationMode()

Returns the signaled application mode for this application.
 That is, the application mode that this application would run
 in when the application's home environment is not 
 selected or
 presenting.
 
 A value of NORMAL_MODE indicates that the application
 will be terminated when the home environment is not selected
 or presenting.  Any other value indicates the mode that the
 application would run in.
 

 Where no application_mode_descriptor was signaled,
 the default value of LEGACY_MODE SHALL be returned.
 

 The current application mode can be determined by consulting
 Environment.getState() in addition to considering the signaled
 application mode.






Returns:
one of LEGACY_MODE, NORMAL_MODE,
                CROSSENVIRONMENT_MODE,
                BACKGROUND_MODE, or
                PAUSED_MODE














  
      Overview 
      Package 
    Class 
      Tree 
      Deprecated 
      Index 
      Help 
  









 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`static int`	`AUTOSTART` This represents the application control code "AUTOSTART" defined for the application_control_code in an AIT or a XAIT.
`static int`	`BACKGROUND_MODE` This represents the "background" application mode defined for the `application_mode_descriptor` in an AIT or XAIT.
`static int`	`CROSSENVIRONMENT_MODE` This represents the "cross-environment" application mode defined for the `application_mode_descriptor` in an or XAIT.
`static int`	`DESTROY` This represents the application control code "DESTROY" defined for the application_control_code in an AIT or a XAIT.
`static int`	`KILL` This represents the application control code "KILL" defined for the application_control_code in an AIT or a XAIT.
`static int`	`LEGACY_MODE` This represents the "legacy" application mode defined for the `application_mode_descriptor` in an AIT or XAIT.
`static int`	`NORMAL_MODE` This represents the "normal" application mode defined for the `application_mode_descriptor` in an AIT or XAIT.
`static int`	`OCAP_J` The OCAP registered value for all OCAP-J applications.
`static int`	`PAUSED_MODE` This represents the "paused" application mode defined for the `application_mode_descriptor` in an AIT or XAIT.
`static int`	`PREFETCH` The application control code "PREFETCH" is only used for DVB-HTML applications.
`static int`	`PRESENT` This represents the application control code "PRESENT" defined for the application_control_code in an AIT or a XAIT.
`static int`	`REMOTE` This represents the application control code "REMOTE" defined for the application_control_code in an AIT.

Method Summary
`int`	`getApplicationControlCode()` This method returns the application_control_code of the application represented by this interface.
`int`	`getApplicationMode()` Returns the signaled application mode for this application.
`int`	`getStoragePriority()` This method returns the currently set storage priority for the application.
`boolean`	`hasNewVersion()` Indicates that a new version of the application is stored that will replace the currently launched version when a new lifecycle for this application starts.
`boolean`	`isNewVersionSignaled()` Indicates that a new version of the application is available and will replace the currently launched version when a new lifecycle for this application starts.

org.ocap.application.OcapAppAttributes.html Maven / Gradle / Ivy

org.ocap.application Interface OcapAppAttributes

OCAP_J

AUTOSTART

PRESENT

DESTROY

KILL

PREFETCH

REMOTE

LEGACY_MODE

NORMAL_MODE

CROSSENVIRONMENT_MODE

BACKGROUND_MODE

PAUSED_MODE

getApplicationControlCode

getStoragePriority

hasNewVersion

isNewVersionSignaled

getApplicationMode

org.ocap.application
Interface OcapAppAttributes