6.2.2 load method

This method loads and recovers suspend information in Suspend/Resume Plugins, by loading the suspend information associated with the Operational Content ID specified by a parameter.

This method is invoked only if the return value of the contains() method is true. Therefore, if the return value of this method is null, a plugin error message is displayed in the dialog box. If no suspend information is found, throw the UCNPPluginException exception for which a message is set.

If this method throws the UCNPPluginException exception, Navigation Platform displays the message for the UCNPPluginException exception in the dialog box. A message ID is not appended to the message displayed in the dialog box.

If the return value of this method is invalid or if this method throws the UCNPPluginException exception, a message appears in the dialog box, and then the operation starts from the beginning.

Organization of this subsection

(1) Format
(2) Arguments
(3) Return values
(4) Exception
(5) Invocation timing

(1) Format

public ISuspendInfo load(String contentId, HttpSession session)
                throws UCNPPluginException;

To Page Top

(2) Arguments

(a) contentId

This argument indicates the Operational Content ID.

(b) session

This argument stores the current session. To execute the setAttribute() method for the HttpSession object acquired in a plugin, do not specify any of the following names for the name argument of the setAttribute() method:

Name beginning with "ucnp"
Name beginning with "java."
Name beginning with "javax."
Name beginning with "javax.portlet."
Name beginning with "hptl"
Name beginning with "com.cosminexus"
Name beginning with "jp.co.hitachi.soft.portal"

You can also acquire and use the URL request parameter. To use this parameter, you must acquire the ucnpOptions parameter by using the following key:

ucnp.request.options key

This key is used to acquire the value of the ucnpOptions parameter specified for the URL from the session. By specifying this key in the HttpSession.getAttribute() method, you can acquire the URL decoded value of the ucnpOptions parameter. If the ucnpOptions parameter is not specified for the URL, null is returned.

For details about a specification example of the ucnp.request.options key, see the specification example of the inputFromNode method in 5.2 IIoPluginController (server processing implementation interface).

To Page Top

(3) Return values

Suspend information associated with the Operational Content ID

To Page Top

(4) Exception

UCNPPluginException - An error occurred while, for example, suspend information was being loaded.

Navigation Platform displays the detailed message for the UCNPPluginException exception thrown by this method in the dialog box in the Operational Content Execution Window. For the UCNPPluginException exception to be thrown, set the message that helps users understand what kind of error occurred and what action to take. If the error message output by the Suspend/Resume Plugin contains many linefeeds, part of the message dialog box might not be displayed in the window because a JavaScript Alert is used to display the error message. Therefore, make sure that the error message size does not exceed the limit that can be displayed in the window.

To Page Top

(5) Invocation timing

Navigation Platform invokes this method if the following occurs:

After the contains() method of the implementation class that inherits the suspend/resume action controller interface was invoked, that contains() method returns true.

If the contains() method returns false or if the UCNPPluginException exception is thrown, this method is not invoked. For details about the time that the contains() method is invoked, see the description of the contains method in 6.2 ISuspendActionController (suspend/resume action controller interface).

To Page Top