com.accela.aa.emse.dom

Class CalendarScript

java.lang.Object

com.accela.aa.emse.dom.service.BaseAAScript

com.accela.aa.emse.dom.CalendarScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.CalendarScriptService, com.accela.aa.emse.dom.service.ScriptAble

public class CalendarScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.CalendarScriptService

 
 Accela Automation
 File: CalendarScriptEJB.java
 
 Accela, Inc.
 Copyright (C): 2001-2014
 
 Description:
 Provides the "aa.calendar" object through which script writers can
 operate on an retrieve calendars.
 
 Notes:
 $Id: CalendarScript.java 270462 2014-04-28 10:05:58Z ..\rain.wang $
 
 Revision History:
 20Apr2002  Johnny Zhou, Initial Version
 11/19/2002 Owen Yang, modify the method getCalendar();
 04/02/2005, Kenry Zou  public Collection getCalendars(...): add parameter: isForCreateCalendar,
 to distinct pure calendar query from the query for next step of calendar creation, here isForCreateCalendar is false.
 07/31/2006 Winter Jiang Added methods for inspection scheduling EMSE
 08/22/2006 Witner Jiang Modified getEventSeriesByCalendarID method
 11/01/2006 Michael Mao cache service object.
 
 

Constructor Summary

Constructors

Constructor and Description
CalendarScript() Constructor for CalendarScript.
CalendarScript(java.lang.String serviceProviderCode, java.lang.String auditID, com.accela.aa.emse.dom.service.CachedService cachedService) Constructor for CalendarScript.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	addCalendar(long calendarID, java.lang.String calendarName, com.accela.aa.calendar.calendar.XGStructureCalendarModel xGStructureCalendarModel, java.lang.String calendarType) Add one calendar.
ScriptResult	addCalendar(java.lang.String calendarName, com.accela.aa.calendar.calendar.XGStructureCalendarModel xGStructureCalendarModel, java.lang.String calendarType) Added calendar
ScriptResult	addEvent(long calendarID, java.lang.String eventName, java.lang.String eventType, java.lang.String eventDate) Add event for inspector calendar
ScriptResult	addInspectorCalendar(long calendarID, long groupID, java.lang.String userID, java.lang.String calendarLevel) Get inspector calendar
ScriptResult	deleteEventByEventID(long calendarID, long eventID) Delete event by event ID
ScriptResult	deleteInspectorCalendar(long inspectorCalendarNbr) Delete inspector calendar by inspector calendar nbr
ScriptResult	getAvailableHearing(java.lang.String hearingBody, double duration, java.lang.String startTime, com.accela.aa.emse.util.ScriptDateTime dateFrom, com.accela.aa.emse.util.ScriptDateTime dateTo, java.lang.String dayOfWeek, java.lang.String location) Get available hearing.
ScriptResult	getAvailableHearingItem(java.lang.String hearingBody, double duration, java.lang.String calendarName, com.accela.aa.emse.util.ScriptDateTime dateFrom, com.accela.aa.emse.util.ScriptDateTime dateTo, java.lang.String dayOfWeek, java.lang.String location) Get available hearing item.
ScriptResult	getCalendar(long calendarID) Get one calendar by calendarID.
ScriptResult	getCalendarNames() Get one collection of Calendar names.
ScriptResult	getCalendars(java.lang.String calendarName, java.lang.String calendarType) Find out all calendars according to a certain condition
ScriptResult	getEventByEventID(long calendarID, long eventID) Get event by event ID
ScriptResult	getEventSeriesByCalendarID(long calendarID, int year, int month) Get event by calendarID
ScriptResult	getInspectorCalendars(long calendarID, java.lang.String calendarLevel) Add inspector calendar
ScriptResult	getNextWorkDay() Get the next working date from today based on Inspection Blockout Calendar
ScriptResult	getNextWorkDay(com.accela.aa.emse.util.ScriptDateTime date) Get the next working date from the specified date based on Inspection Blockout Calendar
ScriptResult	getPreviousWorkDay(com.accela.aa.emse.util.ScriptDateTime date) Get the previous working date from the specified date based on Inspection Blockout Calendar
ScriptResult	scheduleHearing(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String hearingID, java.lang.String duration) Method scheduleHearing.
ScriptResult	scheduleHearing4V360(com.accela.aa.aamain.cap.CapIDModel capID, java.lang.String calendarID, java.lang.String eventID, java.lang.String duration, java.lang.String reason, java.lang.String comments) Schedule hearing for V360,This hearing will be stored into table "XAPP_EVENT"
ScriptResult	updateEvent(long calendarID, long eventID, java.lang.String eventName, java.lang.String eventType, java.lang.String eventDate) Add event for inspector calendar

Methods inherited from class com.accela.aa.emse.dom.service.BaseAAScript

initScript

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.accela.aa.emse.dom.service.ScriptAble

initScript

Constructor Detail

CalendarScript

public CalendarScript(java.lang.String serviceProviderCode,
              java.lang.String auditID,
              com.accela.aa.emse.dom.service.CachedService cachedService)
               throws com.accela.aa.exception.AAException

Constructor for CalendarScript.

Parameters:

serviceProviderCode - agency code

auditID - the caller id

Throws:

com.accela.aa.exception.AAException - the AA exception

CalendarScript

public CalendarScript()
               throws com.accela.aa.exception.AAException

Constructor for CalendarScript.

Throws:

com.accela.aa.exception.AAException - the AA exception

Method Detail

addCalendar

public ScriptResult addCalendar(long calendarID,
                       java.lang.String calendarName,
                       com.accela.aa.calendar.calendar.XGStructureCalendarModel xGStructureCalendarModel,
                       java.lang.String calendarType)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Add one calendar.

Specified by:

addCalendar in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

calendarID - calendar id

calendarName - calendar name

xGStructureCalendarModel - xGStructureCalendarModel

calendarType - calendar type

Returns:

ScriptResult

getCalendar

public ScriptResult getCalendar(long calendarID)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get one calendar by calendarID.

Specified by:

getCalendar in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

calendarID - calendar id

Returns:

ScriptResult

getCalendarNames

public ScriptResult getCalendarNames()

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get one collection of Calendar names.

Specified by:

getCalendarNames in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult

getAvailableHearing

public ScriptResult getAvailableHearing(java.lang.String hearingBody,
                               double duration,
                               java.lang.String startTime,
                               com.accela.aa.emse.util.ScriptDateTime dateFrom,
                               com.accela.aa.emse.util.ScriptDateTime dateTo,
                               java.lang.String dayOfWeek,
                               java.lang.String location)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get available hearing.

Specified by:

getAvailableHearing in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

hearingBody - hearing body

duration - duration

startTime - start time

dateFrom - the from date

dateTo - the to date

dayOfWeek - day of week

location - location

Returns:

ScriptResult

getAvailableHearingItem

public ScriptResult getAvailableHearingItem(java.lang.String hearingBody,
                                   double duration,
                                   java.lang.String calendarName,
                                   com.accela.aa.emse.util.ScriptDateTime dateFrom,
                                   com.accela.aa.emse.util.ScriptDateTime dateTo,
                                   java.lang.String dayOfWeek,
                                   java.lang.String location)

Get available hearing item.

Parameters:

hearingBody -

duration -

startTime -

dateFrom -

dateTo -

dayOfWeek -

location -

Returns:

scheduleHearing

public ScriptResult scheduleHearing(com.accela.aa.aamain.cap.CapIDModel capID,
                           java.lang.String hearingID,
                           java.lang.String duration)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Method scheduleHearing.

Specified by:

scheduleHearing in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

capID - CapIDModel

hearingID - hearing id

duration - duration

Returns:

ScriptResult

getCalendars

public ScriptResult getCalendars(java.lang.String calendarName,
                        java.lang.String calendarType)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Find out all calendars according to a certain condition

Specified by:

getCalendars in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

calendarName - Calendar Name

calendarType - Calendar Type

Returns:

ScriptResult output object is collection of calendar records

addCalendar

public ScriptResult addCalendar(java.lang.String calendarName,
                       com.accela.aa.calendar.calendar.XGStructureCalendarModel xGStructureCalendarModel,
                       java.lang.String calendarType)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Added calendar

Specified by:

addCalendar in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

calendarName - Calendar Name

xGStructureCalendarModel - This parameter for structure calendar

calendarType - Calendar Type

Returns:

ScriptResult output object is null

getInspectorCalendars

public ScriptResult getInspectorCalendars(long calendarID,
                                 java.lang.String calendarLevel)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Add inspector calendar

Specified by:

getInspectorCalendars in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

calendarID - Calendar ID

calendarLevel - Calendar level ,The value is User or User Group

Returns:

ScriptResult output object is null

addInspectorCalendar

public ScriptResult addInspectorCalendar(long calendarID,
                                long groupID,
                                java.lang.String userID,
                                java.lang.String calendarLevel)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get inspector calendar

Specified by:

addInspectorCalendar in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

calendarID - Calendar ID

calendarLevel - Calendar level ,The value is User or User Group

Returns:

ScriptResult output object is null

deleteInspectorCalendar

public ScriptResult deleteInspectorCalendar(long inspectorCalendarNbr)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Delete inspector calendar by inspector calendar nbr

Specified by:

deleteInspectorCalendar in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult output object is null

addEvent

public ScriptResult addEvent(long calendarID,
                    java.lang.String eventName,
                    java.lang.String eventType,
                    java.lang.String eventDate)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Add event for inspector calendar

Specified by:

addEvent in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult output object is Collection fo event ID

deleteEventByEventID

public ScriptResult deleteEventByEventID(long calendarID,
                                long eventID)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Delete event by event ID

Specified by:

deleteEventByEventID in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult output object is null

getEventByEventID

public ScriptResult getEventByEventID(long calendarID,
                             long eventID)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get event by event ID

Specified by:

getEventByEventID in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult output object is null

getEventSeriesByCalendarID

public ScriptResult getEventSeriesByCalendarID(long calendarID,
                                      int year,
                                      int month)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get event by calendarID

Specified by:

getEventSeriesByCalendarID in interface com.accela.aa.emse.dom.service.CalendarScriptService

year - event year

month - event month

Returns:

ScriptResult output object is Collection of event list

updateEvent

public ScriptResult updateEvent(long calendarID,
                       long eventID,
                       java.lang.String eventName,
                       java.lang.String eventType,
                       java.lang.String eventDate)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Add event for inspector calendar

Specified by:

updateEvent in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult output object is Collection fo event ID

getNextWorkDay

public ScriptResult getNextWorkDay()

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get the next working date from today based on Inspection Blockout Calendar

Specified by:

getNextWorkDay in interface com.accela.aa.emse.dom.service.CalendarScriptService

Returns:

ScriptResult

getNextWorkDay

public ScriptResult getNextWorkDay(com.accela.aa.emse.util.ScriptDateTime date)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get the next working date from the specified date based on Inspection Blockout Calendar

Specified by:

getNextWorkDay in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

date - the specified date

Returns:

ScriptResult

getPreviousWorkDay

public ScriptResult getPreviousWorkDay(com.accela.aa.emse.util.ScriptDateTime date)

Description copied from interface: com.accela.aa.emse.dom.service.CalendarScriptService

Get the previous working date from the specified date based on Inspection Blockout Calendar

Specified by:

getPreviousWorkDay in interface com.accela.aa.emse.dom.service.CalendarScriptService

Parameters:

date - the specified date

Returns:

ScriptResult

scheduleHearing4V360

public ScriptResult scheduleHearing4V360(com.accela.aa.aamain.cap.CapIDModel capID,
                                java.lang.String calendarID,
                                java.lang.String eventID,
                                java.lang.String duration,
                                java.lang.String reason,
                                java.lang.String comments)

Schedule hearing for V360,This hearing will be stored into table "XAPP_EVENT"

Parameters:

capID - the cap ID model

calendarID - the calendar ID

eventID - the event ID

duration - the duration

reason - the hearing reason

comments - the hearing comments

Returns: