com.portal.browse

Class EventBrowserData

java.lang.Object

com.portal.browse.EventBrowserData

All Implemented Interfaces:

Serializable

public class EventBrowserData
extends Object
implements Serializable

This a data object used for passing information between the panels and controllers.

Version:

%version: 16 % %date_modified: Fri Feb 09 18:06:50 2001 %

Author:

Monica Gaines

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD_MARKED_ITEM Indicates an update to the list of marked items.
static int	ADJUST_EVENTS Indicates an event adjustment.
static int	CLEAR_SEARCH_DATA Indicates a need to clear out the adjusmtment information stored for a current search.
static int	CLOSE_CONTEXT Indicates a request to close open contexts
static int	CREDENTIALS Indicates the setting of credentials for branding.
static int	DISPLAY_EVENT Indicates an update to the detail view of an event.
static int	DISPLAY_OBJECT Indicates an update to the detail view of an object.
static int	ESTIMATE_ADJUSTMENT Indicates a request to estimate event adjustments.
static int	EXPORT_DATA Indicates the saving of the selected events to a file.
static int	HISTORY_ITEMS Indicates a retrieval of the history items.
static int	INIT_ADJUST_EVENTS Indicates the initialization of the adjust event dialog.
static int	INIT_RESULTS Indicates the handling of search results.
static int	PERMISSIONS Indicates the reading of the permissions object.
static int	PRINT Indicates a print operation, event details are sent to the printer.
static int	REMOVE_MARKED_ITEM Indicates a remove from the list of marked items.

Constructor Summary

Constructors

Constructor and Description
EventBrowserData(int type) Create an instance of this object using information for reading permissions for the current user.
EventBrowserData(int type, AdjustEventData data, Properties res) Create an instance of this object using information for adjusting events.
EventBrowserData(int type, ArrayList subValues, DataTemplate dt) Create an instance of this object using information for updating the object details.
EventBrowserData(int type, File f, Vector fields, Properties res, HistoryItem[] items) Create an instance of this object using information for saving events/objects to a file.
EventBrowserData(int type, Hashtable mData) Create an instance of this object using information for retrieving data for marking events.
EventBrowserData(int type, int[] r, boolean b) Create an instance of this object using information for marking and unmarking events.
EventBrowserData(int type, int[] r, DataTemplate[] dt) Create an instance of this object using information for retrieving HistoryItems.
EventBrowserData(int type, Properties res) Create an instance of this object using information for inititalizing search results.
EventBrowserData(int type, Properties res, DataTemplate dt) Create an instance of this object using information for object details and printing.
EventBrowserData(int type, Properties res, int r) Create an instance of this object using information for retrieving data for displaying events or objects.
EventBrowserData(int type, String acl, String group) Create an instance of this object using information for setting credentials - used for branding
EventBrowserData(Properties res, ArrayList arList) Create an instance of this object using information for object details.

Method Summary

Modifier and Type	Method and Description
String	getACL()
ArrayList	getAdjustData()
AdjustEventData	getAdjustEventData()
boolean	getAdjustEvents() Indicates whether or not the user has permission to adjuste events.
com.portal.browse.AdjustmentInfo[]	getAdjustmentInfo()
DataTemplate	getDataTemplate()
DataTemplate[]	getDataTemplates()
File	getFile()
ArrayList	getGenericData()
String	getGroup()
PModelHandle[]	getHandle()
HistoryItem[]	getItems()
HashMap	getMarkedData()
Hashtable	getMarkedEvents()
Vector	getMaskedFields()
PrintData	getPrintData()
Properties	getResources()
ResultData[]	getResultData()
ArrayList	getResultsList()
int	getRow()
Integer[]	getRows()
boolean	getSearchData()
int[]	getSelectedRows()
ArrayList	getSubstituteValues()
String	getTitle()
int	getType()
void	setAdjustData(ArrayList aData) Sets the adjustment data
void	setAdjustEvents(boolean b) Set the adjustEvent property.
void	setAdjustmentInfo(com.portal.browse.AdjustmentInfo[] aInfo) Sets the adjustment info.
void	setDataTemplate(DataTemplate dt) Set the DataTemplate object
void	setItems(HistoryItem[] items) Sets the history item object
void	setMarkedData(HashMap mData) Sets the marked data
void	setMarkedEvents(Hashtable mData) Sets the marked events
void	setMaskedFields(Vector mFields) Sets the maskedFields vector.
void	setPrintData(PrintData pData) Sets the print information retrieved from the controller.
void	setResources(Properties res) Sets the resources to the given properties object.
void	setResultsList(ArrayList rList) Sets the adjustment data
void	setRows(Integer[] r)
void	setTitle(String str) Set the title for the object details

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISPLAY_OBJECT

public static final int DISPLAY_OBJECT

Indicates an update to the detail view of an object.

See Also:

Constant Field Values

PERMISSIONS

public static final int PERMISSIONS

Indicates the reading of the permissions object.

See Also:

Constant Field Values

EXPORT_DATA

public static final int EXPORT_DATA

Indicates the saving of the selected events to a file.

See Also:

Constant Field Values

INIT_ADJUST_EVENTS

public static final int INIT_ADJUST_EVENTS

Indicates the initialization of the adjust event dialog.

See Also:

Constant Field Values

CREDENTIALS

public static final int CREDENTIALS

Indicates the setting of credentials for branding.

See Also:

Constant Field Values

INIT_RESULTS

public static final int INIT_RESULTS

Indicates the handling of search results.

See Also:

Constant Field Values

DISPLAY_EVENT

public static final int DISPLAY_EVENT

Indicates an update to the detail view of an event.

See Also:

Constant Field Values

ADD_MARKED_ITEM

public static final int ADD_MARKED_ITEM

Indicates an update to the list of marked items.

See Also:

Constant Field Values

REMOVE_MARKED_ITEM

public static final int REMOVE_MARKED_ITEM

Indicates a remove from the list of marked items.

See Also:

Constant Field Values

HISTORY_ITEMS

public static final int HISTORY_ITEMS

Indicates a retrieval of the history items.

See Also:

Constant Field Values

CLEAR_SEARCH_DATA

public static final int CLEAR_SEARCH_DATA

Indicates a need to clear out the adjusmtment information stored for a current search.

See Also:

Constant Field Values

ADJUST_EVENTS

public static final int ADJUST_EVENTS

Indicates an event adjustment.

See Also:

Constant Field Values

PRINT

public static final int PRINT

Indicates a print operation, event details are sent to the printer.

See Also:

Constant Field Values

ESTIMATE_ADJUSTMENT

public static final int ESTIMATE_ADJUSTMENT

Indicates a request to estimate event adjustments.

See Also:

Constant Field Values

CLOSE_CONTEXT

public static final int CLOSE_CONTEXT

Indicates a request to close open contexts

See Also:

Constant Field Values

Constructor Detail

EventBrowserData

public EventBrowserData(int type,
                        File f,
                        Vector fields,
                        Properties res,
                        HistoryItem[] items)

Create an instance of this object using information for saving events/objects to a file.

Parameters:

type - the type of operation

f - the file to save

fields - the fields that are supposed to be masked

res - contains the required strings for the controller

items - an array of events/objects

EventBrowserData

public EventBrowserData(int type,
                        Properties res)

Create an instance of this object using information for inititalizing search results.

Parameters:

type - the type of operation

res - contains the required strings for the controller

EventBrowserData

public EventBrowserData(int type,
                        Properties res,
                        DataTemplate dt)

Create an instance of this object using information for object details and printing.

Parameters:

type - the type of operation

res - contains the required strings for the controller

dt - the data template

EventBrowserData

public EventBrowserData(Properties res,
                        ArrayList arList)

Create an instance of this object using information for object details.

Parameters:

res - contains the required strings for the controller

arList - the array list containing the object

EventBrowserData

public EventBrowserData(int type,
                        int[] r,
                        DataTemplate[] dt)

Create an instance of this object using information for retrieving HistoryItems.

Parameters:

type - the type of operation

r - the array of selected rows

dt - the array of data templates

EventBrowserData

public EventBrowserData(int type,
                        int[] r,
                        boolean b)

Create an instance of this object using information for marking and unmarking events.

Parameters:

type - the type of operation

r - the array of selected rows

b - indicates if the information is from the search results

EventBrowserData

public EventBrowserData(int type,
                        ArrayList subValues,
                        DataTemplate dt)

Create an instance of this object using information for updating the object details.

Parameters:

type - the type of operation

subValues - the list of substitute values

dt - the DataTemplate object

EventBrowserData

public EventBrowserData(int type)

Create an instance of this object using information for reading permissions for the current user.

Parameters:

type - the type of operation

EventBrowserData

public EventBrowserData(int type,
                        Hashtable mData)

Create an instance of this object using information for retrieving data for marking events.

Parameters:

type - the type of operation

mdata - contains the marked events

EventBrowserData

public EventBrowserData(int type,
                        AdjustEventData data,
                        Properties res)

Create an instance of this object using information for adjusting events.

Parameters:

type - the type of operation

data - contains the information required for event adjustments

res - contains the required strings for the controller

EventBrowserData

public EventBrowserData(int type,
                        String acl,
                        String group)

Create an instance of this object using information for setting credentials - used for branding

Parameters:

type - the type of operation

acl - string representation of acl poid

group - string representation of group poid

EventBrowserData

public EventBrowserData(int type,
                        Properties res,
                        int r)

Create an instance of this object using information for retrieving data for displaying events or objects.

Parameters:

type - the type of operation

res - contains the required strings for the controller

r - the selected row containing the event

Method Detail

getFile

public File getFile()

Returns:

the file used for saving events/objects

setItems

public void setItems(HistoryItem[] items)

Sets the history item object

Parameters:

items - the array of HistoryItems

getItems

public HistoryItem[] getItems()

Returns:

an array of events/objects

setMaskedFields

public void setMaskedFields(Vector mFields)

Sets the maskedFields vector.

Parameters:

mFields - the new masked fields value

getMaskedFields

public Vector getMaskedFields()

Returns:

a vector of masked fields

getResources

public Properties getResources()

Returns:

the object that contains the required strings for the controller

setResources

public void setResources(Properties res)

Sets the resources to the given properties object.

Parameters:

res - contains the requried strings for the controller

getHandle

public PModelHandle[] getHandle()

Returns:

the PModelHandle

getResultData

public ResultData[] getResultData()

Returns:

the array of ResultData for the search

setTitle

public void setTitle(String str)

Set the title for the object details

Parameters:

str - the title

getTitle

public String getTitle()

Returns:

the title for the object details

setDataTemplate

public void setDataTemplate(DataTemplate dt)

Set the DataTemplate object

Parameters:

dt - the DataTemplate

getDataTemplate

public DataTemplate getDataTemplate()

Returns:

the DataTemplate

getGenericData

public ArrayList getGenericData()

Returns:

the DataTemplate

getAdjustData

public ArrayList getAdjustData()

Returns:

the adjustment data

setAdjustData

public void setAdjustData(ArrayList aData)

Sets the adjustment data

Parameters:

aData - the adjustment data

getResultsList

public ArrayList getResultsList()

Returns:

the results data

setResultsList

public void setResultsList(ArrayList rList)

Sets the adjustment data

Parameters:

rData - the results data

getSelectedRows

public int[] getSelectedRows()

Returns:

the array of selected rows

getMarkedData

public HashMap getMarkedData()

Returns:

the marked data

setMarkedData

public void setMarkedData(HashMap mData)

Sets the marked data

Parameters:

mData - the marked data

getMarkedEvents

public Hashtable getMarkedEvents()

Returns:

the marked events

setMarkedEvents

public void setMarkedEvents(Hashtable mData)

Sets the marked events

Parameters:

mData - the marked events

getAdjustmentInfo

public com.portal.browse.AdjustmentInfo[] getAdjustmentInfo()

Returns:

the array of adjustment info

setAdjustmentInfo

public void setAdjustmentInfo(com.portal.browse.AdjustmentInfo[] aInfo)

Sets the adjustment info.

Parameters:

aInfo - the array containing adjusment info

getSubstituteValues

public ArrayList getSubstituteValues()

Returns:

the list of substitue values

setAdjustEvents

public void setAdjustEvents(boolean b)

Set the adjustEvent property. This indicates whether or not a permission has been set for adjusting events.

Parameters:

b - true if the user has permission to adjust events

getAdjustEvents

public boolean getAdjustEvents()

Indicates whether or not the user has permission to adjuste events.

Returns:

true if the user has permission to adjust events

getType

public int getType()

Returns:

the type of operation this object is used for

getACL

public String getACL()

Returns:

the acl string used for branding

getGroup

public String getGroup()

Returns:

the group string used for branding

getRow

public int getRow()

Returns:

the selected row

setRows

public void setRows(Integer[] r)

getRows

public Integer[] getRows()

Returns:

the selected row

getSearchData

public boolean getSearchData()

Returns:

indicates whether the data came from the current search results

setPrintData

public void setPrintData(PrintData pData)

Sets the print information retrieved from the controller.

Parameters:

pData - the print information

getPrintData

public PrintData getPrintData()

Returns:

the print information from the controller

getAdjustEventData

public AdjustEventData getAdjustEventData()

Returns:

data required to adjust events

getDataTemplates

public DataTemplate[] getDataTemplates()

Returns:

data required to print/export events