Portlet template based on a state design pattern

• US 7,266,806 B2
• Filed: 03/02/2004
• Issued: 09/04/2007
• Est. Priority Date: 03/02/2004
• Status: Expired due to Fees

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Shaouy, William P., Miller, Martin L. III, Lemire, Tina M., Choi, Elliot M.
• Primary Examiner(s): Dam; Tuan
• Assistant Examiner(s): Wei; Zheng
• Application Number:
  US10/790,913
• Publication Number:
  US 20050198615A1
• Time in Patent Office: 1,281 Days
• Field of Search: 717/108
• US Class Current: 717/108
• CPC Class Codes: G06F 8/24 Object-oriented

Abstract

A method for designing object-oriented software for implementing portlets, and an associated computer system and computer program product. The portlets are available to a user of the software who clicks on a link of a first page to identify an action object of an Action class and a state object of a State class. The software includes the State class, the Action class, and program code. The State class includes a method for displaying a view of a page. The Action class includes an actionPerformed method for performing an action and a setState method for setting the state object into the session. The program code is adapted to execute: the actionPerformed method of the action object to perform the action; the setState method of the second page.

Claims

1. A method for designing object-oriented software for implementing portlets of a portal, said portlets adapted to be available to a user of the software during a session in which the user clicks on a link of a first page to identify an action object of an Action class and a state object of a State class, said method comprising designing the software followed by storing the designed software in a computer usable medium from which the software may be executed on a processor of a computer system to implement portlets of a portal, said designing the software comprising:

including in the software a Portlet Template that comprises the State class, the Action class, and program code;

including in the State class a perform view method for displaying a view of a page;

including in the Action class an action performed method for performing an action and a set state method for setting the state object into the session;

adapting the program code to execute;

(a) the action performed method of the action object to perform the action,

(b) the set state method of the action object to set the state object into the session, and

(c) the perform view method of the state object to display a view of a second page that is associated with the action;

including a portlet code module and a controller code module in the program code, wherein the portlet code module and a controller code module are different modules, wherein the portlet code module is adapted to execute the action performed method and the set state method, and wherein the controller code module is adapted to execute the perform view method;

including a BasePortlet class and a TemplatePortlet class in the portlet code module, wherein the BasePortlet class does not include a portlet specific method and includes the action performed method and the set state method, and wherein the TemplatePortlet class is a child of the BasePortlet class and includes at least one portlet specific method; and

including a BaseController class and a TemplateControllerForHtml class in the controller code module,

wherein the BaseController class does not include a portlet specific method and includes the perform view method,

wherein the TemplateControllerForHtml class is a child of the BaseController class and includes at least one portlet specific method, and

wherein the BasePortlet class and the BaseController class are different classes.

2. The method of claim 1, wherein said designing the software further comprises including an action listener method in the BasePortlet class, wherein the action object resulting from the user clicking on the link of the first page is communicated from the portal to the action listener method in response to the action listener method extracting the action object from an input parameter associated with the link, wherein the extracted action object includes an action performed method for performing an action and a set state method for setting a destination of the State class into the session, and wherein the destination state includes a display method to be executed for displaying a next page following the action.

3. The method of claim 1, wherein a first object of the State class includes a first perform view method for displaying a first portlet state of a given page, wherein a second object of the State class includes a second perform view method for displaying a second portlet state of the given page, wherein the first and second portlet states are different portlet states, and wherein the first and second perform view methods are different perform view methods.

4. The method of claim 3,

wherein the first and second portlet states are each selected from the group consisting of a Normal portlet state, a Maximized portlet state, and a Minimized portlet state;

wherein in the Normal portlet state, a portlet of the portlets is arranged on a displayed portal page with other portlets of the portlets;

wherein in the Maximized portlet state, the portlet of the portlets is displayed in the entire body of the displayed portal page. replacing a view of the other portlets; and

wherein in the Minimized portlet state, only a portlet title bar is displayed on the displayed portal page with the other portlets.

5. The method of claim 1, wherein the software comprises JAVA software.

6. The method of claim 1, wherein the portal comprises a portal server.

7. A computer system comprising a processor and a computer readable memory unit coupled to the processor, said memory unit containing object-oriented software adapted to be executed by the processor to implement portlets of a portal,

said portlets adapted to be available to a user of the software during a session in which the user clicks on a link of a first page to identify an action object of an Action class and a state object of a State class;

said software including a Portlet Template that includes the State class, the Action class, and program code;

said State class comprising a perform view method for displaying a view of a page;

said Action class comprising an action performed method for performing an action and a set state method for setting the state object into the session;

said program code adapted to execute;

(a) the action performed method of the action object to perform the action,

(b) the set state method of the action object to set the state object into the session, and

(c) the perform view method of the state object to display a view of a second page that is associated with the action,

wherein the program code includes a portlet code module and a controller code module,

wherein the portlet code module and a controller code module are different modules,

wherein the portlet code module is adapted to execute the action performed method and the set state method,

wherein the controller code module is adapted to execute the perform view method,

wherein the portlet code module comprises a BasePortlet class and a TemplatePortlet class,

wherein the BasePortlet class does not include a portlet specific method and includes the action performed method and the set state method,

wherein the TemplatePortlet class is a child of the BasePortlet class and includes at least one portlet specific method,

wherein the controller code module comprises a BaseController class and a TemplateControllerForHtml class,

wherein the BaseController class does not include a portlet specific method and includes the perform view method,

wherein the TemplateControllerForHtml class is a child of the BaseController class and includes at least one portlet specific method, and

wherein the BasePortlet class and the BaseController class are different classes.

8. The computer system of claim 7, wherein the BasePortlet class includes an action listener method, and wherein the action object resulting from the user clicking on the link of the first page is communicated from the portal to the action listener method in response to the action listener method extracting the action object from an input parameter associated with the link, wherein the extracted action object includes an action performed method for performing an action and a set state method for setting a destination of the State class into the session, and wherein the destination state includes a display method to be executed for displaying a next page following the action.

9. The computer system of claim 7, wherein a first object of the State class includes a first perform view method for displaying a first portlet state of a given page, wherein a second object of the State class includes a second perform view method for displaying a second portlet state of the given page, wherein the first and second portlet states are different portlet states, and wherein the first and second perform view methods are different perform view methods.

10. The computer system of claim 9,

wherein the first and second portlet states are each selected from the group consisting of a Normal portlet state, a Maximized portlet state, and a Minimized portlet state;

wherein in the Normal portlet state, a portlet of the portlets is arranged on a displayed portal page with other portlets of the portlets;

wherein in the Maximized portlet state, the portlet of the portlets is displayed in the entire body of the displayed portal page. replacing a view of the other portlets; and

wherein in the Minimized portlet state, only a portlet title bar is displayed on the displayed portal page with the other portlets.

11. The computer system of claim 7, wherein the software comprises JAVA software.

12. The computer system of claim 7, wherein the portal comprises a portal server.

13. A computer program product, comprising a computer usable medium having computer readable object-oriented software embodied therein, said computer readable object-oriented software containing program code that when executed by a processor of a computer system implements portlets of a portal,

said portlets adapted to be available to a user of the software during a session in which the user clicks on a link of a first page to identify an action object of an Action class and a state object of a State class;

said software including a Portlet Template that includes the State class, the Action class, and program code;

said State class comprising a perform view method for displaying a view of a page;

said Action class comprising an action performed method for performing an action and a set state method for setting the state object into the session;

said program code adapted to execute;

(a) the action performed method of the action object to perform the action,

(b) the set state method of the action object to set the state object into the session, and

(c) the perform view method of the state object to display a view of a second page that is associated with the action,

wherein the program code includes a portlet code module and a controller code module,

wherein the portlet code module and a controller code module are different modules,

wherein the portlet code module is adapted to execute the action performed method and the set state method,

wherein the controller code module is adapted to execute the perform view method,

wherein the portlet code module comprises a BasePortlet class and a TemplatePortlet class,

wherein the BasePortlet class does not include a portlet specific method and includes the action performed method and the set state method, and

wherein the TemplatePortlet class is a child of the BasePortlet class and includes at least one portlet specific methods,

wherein the controller code module comprises a BaseController class and a TemplateControllerForHtml class,

wherein the BaseController class does not include a portlet specific method and includes the perform view method,

wherein the TemplateControllerForHtml class is a child of the BaseController class and includes at least one portlet specific method, and

wherein the BasePortlet class and the BaseController class are different classes.

14. The computer program product of claim 13, wherein the BasePortlet class includes an action listener method, and wherein the action object resulting from the user clicking on the link of the first page is communicated from the portal to the action listener method in response to the action listener method extracting the action object from an input parameter associated with the link, wherein the extracted action object includes an action performed method for performing an action and a set state method for setting a destination of the State class into the session, and wherein the destination state includes a display method to be executed for displaying a next page following the action.

15. The computer program product of claim 13, wherein a first object of the State class includes a first perform view method for displaying a first portlet state of a given page, wherein a second object of the state class includes a second perform view method for displaying a second portlet state of the given page, wherein the first and second portlet states are different portlet states, and wherein the first and second perform view methods are different perform view methods.

16. The computer program product of claim 15,

wherein the first and second portlet states are each selected from the group consisting of a Normal portlet state, a Maximized portlet state, and a Minimized portlet state;

wherein in the Normal portlet state, a portlet of the portlets is arranged on a displayed portal page with other portlets of the portlets;

wherein in the Maximized portlet state, the portlet of the portlets is displayed in the entire body of the displayed portal page, replacing a view of the other portlets; and

wherein in the Minimized portlet state, only a portlet title bar is displayed on the displayed portal page with the other portlets.

17. The computer program product of claim 13, wherein the software comprises JAVA software.

18. The computer program product of claim 13, wherein the portal comprises a portal server.