001: /* Copyright 2005 The JA-SIG Collaborative. All rights reserved.
002: * See license distributed with this file and
003: * available online at http://www.uportal.org/license.html
004: */
005:
006: package org.jasig.portal.services.stats;
007:
008: /**
009: * Interface for objects conveying a bundle of boolean flags configuring what
010: * IStatsRecorder events should propogate.
011: * @version $Revision: 35944 $ $Date: 2005-07-15 14:45:43 -0700 (Fri, 15 Jul 2005) $
012: */
013: public interface IStatsRecorderFlags {
014: /**
015: * Returns true if we should record when a channel is added to a layout;
016: * false otherwise.
017: * @return Returns the recordChannelAddedToLayout.
018: */
019: public boolean isRecordChannelAddedToLayout();
020:
021: /**
022: * Returns true if we should record when a channel definition is modified.
023: * @return Returns whether we should record when a channel definition is modified.
024: */
025: public boolean isRecordChannelDefinitionModified();
026:
027: /**
028: * Returns true if we should record when a channel definition is published, false otherwise.
029: * @return Returns true iff we should record when a channel definition is published.
030: */
031: public boolean isRecordChannelDefinitionPublished();
032:
033: /**
034: * Returns true iff we should record when a channel definition is removed.
035: * @return Returns true iff we should record when a channel definition is removed.
036: */
037: public boolean isRecordChannelDefinitionRemoved();
038:
039: /**
040: * Returns whether we should record when a channel is instantiated.
041: * @return Returns whether we should record when a channel is instantiated.
042: */
043: public boolean isRecordChannelInstantiated();
044:
045: /**
046: * Returns whether we should record a channel being moved within a layout.
047: * @return Returns true iff we should record a channel being moved within a layout.
048: */
049: public boolean isRecordChannelMovedInLayout();
050:
051: /**
052: * Returns true if we should record a channel being removed from a layout, false otherwise.
053: * @return true if we should record a channel being removed from a layout, false otherwise.
054: */
055: public boolean isRecordChannelRemovedFromLayout();
056:
057: /**
058: * Returns true if we should record when a channel is rendered, false otherwise.
059: * @return Returns true iff we should record when a channel is rendered.
060: */
061: public boolean isRecordChannelRendered();
062:
063: /**
064: * Returns true if we should record when a channel is targetted, false otherwise.
065: * @return Returns true iff we should record when a channel is targetted.
066: */
067: public boolean isRecordChannelTargeted();
068:
069: /**
070: * Returns true if we should record when a channel is updated within a layout, false otherwise.
071: * @return Returns true iff we should record when a channel is updated in a layout.
072: */
073: public boolean isRecordChannelUpdatedInLayout();
074:
075: /**
076: * Returns true if we should record when a folder is added to a layout, false otherwise.
077: * @return Returns true iff we should record when a folder is added to a layout.
078: */
079: public boolean isRecordFolderAddedToLayout();
080:
081: /**
082: * Returns true if we should record that a folder is moved in a layout, false otherwise.
083: * @return Returns true iff we should record that a folder is moved in a layout.
084: */
085: public boolean isRecordFolderMovedInLayout();
086:
087: /**
088: * Returns true iff we should record a folder being removed from a layout.
089: * @return Returns true if a folder is removed from a layout.
090: */
091: public boolean isRecordFolderRemovedFromLayout();
092:
093: /**
094: * Returns true if we should record a folder being updated within a layout, false otherwise.
095: * @return true iff we should record a folder being updated within a layout.
096: */
097: public boolean isRecordFolderUpdatedInLayout();
098:
099: /**
100: * Returns true iff we should record a user logging in.
101: * @return true iff we should record a user logging in.
102: */
103: public boolean isRecordLogin();
104:
105: /**
106: * Returns true iff we should record a user logging out.
107: * @return true iff we should record a user logging out.
108: */
109: public boolean isRecordLogout();
110:
111: /**
112: * Returns true if we should record a session being created, false otherwise.
113: * @return true iff we should record when a session is created.
114: */
115: public boolean isRecordSessionCreated();
116:
117: /**
118: * Return true iff we should record a session being destroyed.
119: * @return true iff we should record a session being destroyed.
120: */
121: public boolean isRecordSessionDestroyed();
122: }
|