Java Doc for EventModel.java in » Portal » Open-Portal » com » sun » portal » app » sharedevents » models » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » Open Portal » com.sun.portal.app.sharedevents.models

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

com.sun.portal.app.sharedevents.models .EventModel

EventModel

public class EventModel (Code)

EventModel class provides an interface to event's data
The EventModel provides all means of access machanisms such as load, add, modify, update, delete event data. It can load the event data given an event object or a event uid. If an event uid is given, it fetches the event data using backend service (thru CalendarBaseModel interface), and loads it. The view beans can use this as a model to event data and can perform any event related opeartions to backend store via this EventModel.

It provides following contexts for event's data
LOAD_EVENT_CONTEXT
ADD_EVENT_CONTEXT
MODIFY_EVENT_CONTEXT
UPDATE_EVENT_CONTEXT
DELETE_EVENT_CONTEXT

author:
Sai
author:

Field Summary
final public static String	OPAQUE Value for event's "TRANSP" property which says count this event time in free-busy calculation.
final public static String	TRANSPARENT Value for event's "TRANSP" property which says don't count this event time in free-busy calculation.
final public static String[]	attendeeParticipantStatusNames
final public static String[]	attendeeParticipantStatusValues

Constructor Summary
public	EventModel()
public	EventModel(String name)

Method Summary
public Attendee	getAttendeeForEventCalid() Gets the attendee associated with the current event's calid.
public Attendee[]	getAttendees() Gets the attendees associated with the current event.
public VEvent	getCurrentEvent() Gets the current event object contained in this model instance.
public String	getDescField()
public String	getEndHourField()
public String	getEndMinField()
public String	getEventCalid() Gets the current event associated calid contained in this model instance.
public String	getEventRID() Gets the current event rid contained in this model instance.
public TimeZone	getEventTimeZone(boolean defaultToGMT) Returns TimeZone for the time zone id set in FIELD_TIME_ZONE field.
public String	getEventUID() Gets the current event uid contained in this model instance.
public String	getLocationField()
public Organizer	getOrganizer() Gets the organizer associated with the current event.
public String	getRecurrenceModifier() Get the recurrence modifier that is being used during event additions, modifcations and deletions.
public RecurrencePattern	getRecurrencePattern() Gets the recurrence pattern object associated with the current event.
public String	getRepeatIntervalField()
public String	getRepeatLimitPeriodField()
public String	getRepeatLimitUnitField()
public String	getStartHourField()
public String	getStartMinField()
public String	getTitleField()
public void	insert(String context) Provides support for event insert operations. Following are the suppported event insert contexts. `ADD_EVENT_CONTEXT` -- Use this context to add an event.
public boolean	isRecurrenceChanged()
public void	retrieve(String context) Provides support for event retrieve operations. Following are the suppported event load contexts. `LOAD_EVENT_CONTEXT` -- Use this context to load an event data based on event uid or event object.
public void	setAttendeeForEventCalid(Attendee attendee) Sets the attendee of current event's calid.
public void	setAttendees(Attendee[] attendees) Sets the attendees in the current event.
public void	setCurrentEvent(VEvent event) Sets the current event object for which all the subsequent model methods are valid.
public void	setDefaultDates(DateTime start, DateTime end) Sets the event default dates.
public void	setDescField(String value)
public void	setEndHourField(String value)
public void	setEndMinField(String value)
public void	setEventCalid(String calid) Sets the current event's associated calid for which all the subsequent model methods are valid.
public void	setEventRID(String uid) Sets the current event rid for which all the subsequent model methods are valid.
public void	setEventUID(String uid) Sets the current event uid for which all the subsequent model methods are valid.
public void	setLocationField(String value)
public void	setRecurrenceChanged(boolean recurrenceChanged)
public void	setRecurrenceModifier(String modifier) Specify the recurrence modifier to be used during event additions, modifcations and deletions.
public void	setRecurrencePattern(RecurrencePattern recurrence) Sets the recurrence pattern object in the current event.
public void	setRepeatIntervalField(String value)
public void	setRepeatLimitPeriodField(String value)
public void	setRepeatLimitUnitField(String value)
public void	setStartDate(Date value)
public void	setStartHourField(String value)
public void	setStartMinField(String value)
public void	setTitleField(String value)

Field Detail

OPAQUE
final public static String OPAQUE(Code)
	Value for event's "TRANSP" property which says count this event time in free-busy calculation. Default value for "TRANSP" property is OPAQUE.

TRANSPARENT
final public static String TRANSPARENT(Code)
	Value for event's "TRANSP" property which says don't count this event time in free-busy calculation. TRANSPARENT makes event invisible to free-busy time searches. Default value for "TRANSP" property is OPAQUE.

attendeeParticipantStatusNames
final public static String[] attendeeParticipantStatusNames(Code)

attendeeParticipantStatusValues
final public static String[] attendeeParticipantStatusValues(Code)

Constructor Detail

EventModel
public EventModel()(Code)

EventModel
public EventModel(String name)(Code)

Method Detail

getAttendeeForEventCalid
public Attendee getAttendeeForEventCalid()(Code)
	Gets the attendee associated with the current event's calid.

getAttendees
public Attendee[] getAttendees()(Code)
	Gets the attendees associated with the current event.

getCurrentEvent
public VEvent getCurrentEvent()(Code)
	Gets the current event object contained in this model instance.

getDescField
public String getDescField()(Code)

getEndHourField
public String getEndHourField()(Code)

getEndMinField
public String getEndMinField()(Code)

getEventCalid
public String getEventCalid()(Code)
	Gets the current event associated calid contained in this model instance.

getEventRID
public String getEventRID()(Code)
	Gets the current event rid contained in this model instance.

getEventTimeZone
public TimeZone getEventTimeZone(boolean defaultToGMT)(Code)
	Returns TimeZone for the time zone id set in FIELD_TIME_ZONE field. If FIELD_TIME_ZONE value is null and 'defaultToGMT' is true then it returns TimeZone for GMT.

getEventUID
public String getEventUID()(Code)
	Gets the current event uid contained in this model instance.

getLocationField
public String getLocationField()(Code)

getOrganizer
public Organizer getOrganizer()(Code)
	Gets the organizer associated with the current event.

getRecurrenceModifier
public String getRecurrenceModifier()(Code)
	Get the recurrence modifier that is being used during event additions, modifcations and deletions.

getRecurrencePattern
public RecurrencePattern getRecurrencePattern()(Code)
	Gets the recurrence pattern object associated with the current event.

getRepeatIntervalField
public String getRepeatIntervalField()(Code)

getRepeatLimitPeriodField
public String getRepeatLimitPeriodField()(Code)

getRepeatLimitUnitField
public String getRepeatLimitUnitField()(Code)

getStartHourField
public String getStartHourField()(Code)

getStartMinField
public String getStartMinField()(Code)

getTitleField
public String getTitleField()(Code)

insert

public void insert(String context) throws Exception(Code)

Provides support for event insert operations.

Following are the suppported event insert contexts.
ADD_EVENT_CONTEXT -- Use this context to add an event. Before invoking this context the consumer shall set either attendees, recurrence pattern, alarm object (using the methods setAttendees(), setRecurrencePattern(), setAlarm()) in this model.
MODIFY_EVENT_CONTEXT -- Use this context to modify an event. Before invoking this context the consumer shall set either attendees, recurrence pattern, alarm object (using the methods setAttendees(), setRecurrencePattern(), setAlarm()) in this model.
DELETE_EVENT_CONTEXT -- Use this context to delete an event based on an event uid.

In case if context passed is 'null' then the default event insert context executed is ADD_EVENT_CONTEXT.

isRecurrenceChanged
public boolean isRecurrenceChanged()(Code)

retrieve

public void retrieve(String context) throws Exception(Code)

Provides support for event retrieve operations.

Following are the suppported event load contexts.
LOAD_EVENT_CONTEXT -- Use this context to load an event data based on event uid or event object. Before executing this context the consumer should set either event uid + event's assoicated calid (setEventUID() + setEventCalid()) or event object (setCurrentEvent()) in this model.
LOAD_EVENT_DEFAULTS_CONTEXT -- Use this context to load the event default data. Before executing this context the consumer should set event start and end times using the method setDefaultDates() method in this model.

In case if context passed is 'null' then the default event retrieve context executed is LOAD_EVENT_CONTEXT.

It will be like the below: (for the improvement in performance)
LOAD_EVENT_CONTEXT -- deals with processing event data that is only required for edit/view event

setAttendeeForEventCalid
public void setAttendeeForEventCalid(Attendee attendee)(Code)
	Sets the attendee of current event's calid.

setAttendees
public void setAttendees(Attendee[] attendees)(Code)
	Sets the attendees in the current event.

setCurrentEvent
public void setCurrentEvent(VEvent event)(Code)
	Sets the current event object for which all the subsequent model methods are valid. This will reset the event uid value because event-object and event-uid are mutually exclusive for any event CONTEXT operations.

setDefaultDates

public void setDefaultDates(DateTime start, DateTime end)(Code)

Sets the event default dates.

Parameters:
start - default event start time, if not given then assume current date-time
Parameters:
end - default event end time, if not given then set by advacing the 'start' by calendar preference 'ceInterval' ammount or by one hour.

These default dates are only useful for LOAD_EVENT_DEFAULTS_CONTEXT context.

setDescField
public void setDescField(String value)(Code)

setEndHourField
public void setEndHourField(String value)(Code)

setEndMinField
public void setEndMinField(String value)(Code)

setEventCalid
public void setEventCalid(String calid)(Code)
	Sets the current event's associated calid for which all the subsequent model methods are valid. This will reset the current event object value because event-object and event-associated-calid are mutually exclusive for any event CONTEXT operations. Also use the method `setEventUID(String uid)` when you use this method.

setEventRID
public void setEventRID(String uid)(Code)
	Sets the current event rid for which all the subsequent model methods are valid. This will reset the current event object value because event-object and event-rid are mutually exclusive for any event CONTEXT operations. Also use the method `setEventCalid(String calid)` when you use this method.

setEventUID
public void setEventUID(String uid)(Code)
	Sets the current event uid for which all the subsequent model methods are valid. This will reset the current event object value because event-object and event-uid are mutually exclusive for any event CONTEXT operations. Also use the method `setEventCalid(String calid)` when you use this method.

setLocationField
public void setLocationField(String value)(Code)

setRecurrenceChanged
public void setRecurrenceChanged(boolean recurrenceChanged)(Code)

setRecurrenceModifier
public void setRecurrenceModifier(String modifier)(Code)
	Specify the recurrence modifier to be used during event additions, modifcations and deletions. Recurrence modifier can be any one of RecurrencePattern.THIS_INSTANCE, RecurrencePattern.THIS_AND_FUTURE, RecurrencePattern.THIS_AND_PRIOR, RecurrencePattern.THIS_AND_ALL

setRecurrencePattern
public void setRecurrencePattern(RecurrencePattern recurrence)(Code)
	Sets the recurrence pattern object in the current event. Pass a `null` to remove the recurrence pattern from the current event, and pass a `non-null` value to set a recurrence pattern in the current event.

setRepeatIntervalField
public void setRepeatIntervalField(String value)(Code)

setRepeatLimitPeriodField
public void setRepeatLimitPeriodField(String value)(Code)

setRepeatLimitUnitField
public void setRepeatLimitUnitField(String value)(Code)

setStartDate
public void setStartDate(Date value)(Code)

setStartHourField
public void setStartHourField(String value)(Code)

setStartMinField
public void setStartMinField(String value)(Code)

setTitleField
public void setTitleField(String value)(Code)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.