Formspider APIs


Package api_calendar


Type Summary
 RECORD t_activity(activityid_tx varchar2(4000), startdate_dt date, enddate_dt date, title_tx varchar2(4000), editable_yn varchar2(1), fontcolor_cd varchar2(200), backgroundcolor_cd varchar2(200))
           Record type for the Activity object.

Method Summary
  addactivity(in_paneldotcalendarname_tx IN varchar2, in_activity_r IN api_calendar.t_activity)
           Adds acitivity to calendar.
 t_activity createactivity(in_activityid_tx IN varchar2, in_startdate_dt IN date, in_enddate_dt IN date, in_title_tx IN varchar2, in_editable_yn IN varchar2, in_fontcolor_cd IN varchar2, in_backgroundcolor_cd IN varchar2)
           Returns a new activity.
 t_activity getactivity(in_paneldotcalendarname_tx IN varchar2, in_activityid_tx IN varchar2)
           Returns the activity object
 t_activity getclickedactivity(in_paneldotcalendarname_tx IN varchar2)
           Returns the activity object which is clicked.
 varchar2 getclickedactivityid(in_paneldotcalendarname_tx IN varchar2)
           Returns the activity ID which is clicked.
 date getclickeddate(in_paneldotcalendarname_tx IN varchar2)
           Returns the date which is clicked on calendar.
 t_activity getrescheduledactivity(in_paneldotcalendarname_tx IN varchar2)
           Returns the activity object which is rescheduled.
 varchar2 getrescheduledactivityid(in_paneldotcalendarname_tx IN varchar2)
           Returns the activity ID which is rescheduled
  refresh(in_paneldotcalendarname_tx IN varchar2)
           Refresh activities on calendar
  removeactivity(in_paneldotcalendarname_tx IN varchar2, in_activityid_tx IN varchar2)
           Removes specified acitivity from calendar.
  setactivity(in_paneldotcalendarname_tx IN varchar2, in_activity_r IN api_calendar.t_activity)
           Replaces acitivity with specified activity object on calendar.

Type Detail

t_activity

public RECORD t_activity(activityid_tx varchar2(4000), 
startdate_dt date,
enddate_dt date,
title_tx varchar2(4000),
editable_yn varchar2(1),
fontcolor_cd varchar2(200),
backgroundcolor_cd varchar2(200))
Record type for the Activity object.
Parameters:
activityid_tx - ID of activity
startdate_dt - Start date of activity
enddate_dt - End date of activity
title_tx - Title of activity
editable_yn - Editable state of activity
fontcolor_cd - Font color of activity
backgroundcolor_cd - Background color of activity


Method Detail

addactivity

public  addactivity(in_paneldotcalendarname_tx IN varchar2, 
in_activity_r IN api_calendar.t_activity)
Adds acitivity to calendar.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


createactivity

public t_activity createactivity(in_activityid_tx IN varchar2, 
in_startdate_dt IN date,
in_enddate_dt IN date,
in_title_tx IN varchar2,
in_editable_yn IN varchar2,
in_fontcolor_cd IN varchar2,
in_backgroundcolor_cd IN varchar2)
Returns a new activity.

Use addActivity to add the newly created activity to a calendar.

Throws:
e_invalidcolor - Raised when fontColor_cd or backgroundcolor_cd is invalid


getactivity

public t_activity getactivity(in_paneldotcalendarname_tx IN varchar2, 
in_activityid_tx IN varchar2)
Returns the activity object
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
in_activityid_tx - The ID of requested activity
Returns:
The acitivity object
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.
e_invalidactivity - Raised when the activity ID does not exist


getclickedactivity

public t_activity getclickedactivity(in_paneldotcalendarname_tx IN varchar2)
Returns the activity object which is clicked.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Returns:
The activity object which is clicked
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


getclickedactivityid

public varchar2 getclickedactivityid(in_paneldotcalendarname_tx IN varchar2)
Returns the activity ID which is clicked.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Returns:
The ID of the activity which is clicked
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


getclickeddate

public date getclickeddate(in_paneldotcalendarname_tx IN varchar2)
Returns the date which is clicked on calendar.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Returns:
the date which is clicked on calendar
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


getrescheduledactivity

public t_activity getrescheduledactivity(in_paneldotcalendarname_tx IN varchar2)
Returns the activity object which is rescheduled.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Returns:
The activity object which is rescheduled
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


getrescheduledactivityid

public varchar2 getrescheduledactivityid(in_paneldotcalendarname_tx IN varchar2)
Returns the activity ID which is rescheduled
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Returns:
The ID of the activity which is rescheduled
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


refresh

public  refresh(in_paneldotcalendarname_tx IN varchar2)
Refresh activities on calendar
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


removeactivity

public  removeactivity(in_paneldotcalendarname_tx IN varchar2, 
in_activityid_tx IN varchar2)
Removes specified acitivity from calendar.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.


setactivity

public  setactivity(in_paneldotcalendarname_tx IN varchar2, 
in_activity_r IN api_calendar.t_activity)
Replaces acitivity with specified activity object on calendar.
Parameters:
in_paneldotcalendarname_tx - The fully qualified name of the calendar in panelName.calendarName format. Example: panel1.calendar1
Throws:
e_invalidcalendarname - Raised when the calendar does not exist
e_invalidinputformat - Raised when the value of the in_panelDotCalendarName_tx parameter is in incorrect format.
e_invalidactivity - Raised when the activity ID does not exist


Formspider APIs