01: /* Copyright 2004 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal;
07:
08: /**
09: * An anchoring serializer allows an external client to control
10: * its anchor identifier. When set (when it isn't null), it should
11: * append this anchor identifier to its URLs so that when a user
12: * clicks on one of the URLs, the user's browser will jump
13: * down to the anchor. The original use of this interface will be
14: * to make it possible to add anchors to channel links and forms
15: * where the anchor is set to the channel's subscribtion ID.
16: * @author Ken Weiner, kweiner@unicon.net
17: * @version $Revision: 34803 $
18: */
19: public interface IAnchoringSerializer {
20:
21: /**
22: * Signify that the serializer should begin to
23: * append the anchor ID to URLs of its choosing.
24: * @param anchorId the anchor identifier
25: */
26: public void startAnchoring(String anchorId);
27:
28: /**
29: * Signify that anchoring is no longer desired by
30: * the serializer.
31: */
32: public void stopAnchoring();
33:
34: }
|