|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BusinessCalendarMBean
MBean for configuring business calendars.
Method Summary | |
---|---|
boolean |
calendarNameExists(String name)
Checks if a calendar with the given name exists. |
void |
createCalendar(String cDoc)
Creates a new calendar from the information passed in the CalendarDocument XML text. |
void |
deleteCalendar(String calendarName)
Delete the calendar with the given name. |
void |
deleteCalendars(String[] names)
Delete the named calendars. |
String[] |
getAllCalendarNames()
Get the names of all calendars in the system. |
String[] |
getAllCalendars()
Gets all calendars (as XML text that can be parsed into CalendarDocument), including rules info and mapped groups and users. |
int |
getAllCalendarsCount()
|
String |
getCalendar(String calendarName)
Retrieve the XML text for the calendar with the given name. |
String |
getGroupCalendar(String groupId)
Get the calendar XML text for the calendar that is associated with the given group (or null if no such association has been set). |
String |
getSystemCalendar()
Get the XML text for the system calendar if it exists. |
String |
getUserCalendar(String userId)
Get the calendar XML text for the calendar that is associated with the given user (or null if no such association has been set). |
void |
setGroupCalendar(String groupId,
String calendarName)
Set the group's calendar. |
void |
setUserCalendar(String userId,
String calendarName)
Set the user's calendar. |
boolean |
systemCalendarExists()
Does the system calendar exist yet? |
void |
unsetGroupCalendar(String groupId)
Clear the mapping from the named group's profile to any calendar. |
void |
unsetUserCalendar(String userId)
Clear the mapping of any calendar to the given user's profile. |
void |
updateCalendar(String oldCalendarName,
String cDoc)
Update the calendar - oldCalendarName, using the passed calendar XML text (from a CalendarDocument). |
void |
updateSystemCalendar(String cDoc)
Update the system calendar using the passed calendar XML text (from a CalendarDocument). |
Method Detail |
---|
boolean calendarNameExists(String name) throws MBeanException
name
-
MBeanException
void createCalendar(String cDoc) throws MBeanException
cDoc
- The XML from a CalendarDocument instance.
MBeanException
- - if a calendar with the given name exists or of the document is not valid.String getCalendar(String calendarName) throws MBeanException
calendarName
- Name of the calendar to retrieve XML for.
MBeanException
void updateCalendar(String oldCalendarName, String cDoc) throws MBeanException
oldCalendarName
- The existing/old name of the calendar to be
updated.cDoc
- The XML text for the calendar (from a CalendarDocument)
MBeanException
void updateSystemCalendar(String cDoc) throws MBeanException
cDoc
- The XML text for the calendar (from a CalendarDocument)
MBeanException
void deleteCalendar(String calendarName) throws MBeanException
calendarName
- Name of the calendar to delete.
MBeanException
void deleteCalendars(String[] names) throws MBeanException
MBeanException
boolean systemCalendarExists() throws MBeanException
MBeanException
String getSystemCalendar() throws MBeanException
MBeanException
String[] getAllCalendarNames() throws MBeanException
MBeanException
String[] getAllCalendars() throws MBeanException
MBeanException
void setUserCalendar(String userId, String calendarName) throws MBeanException
userId
- calendarName
-
MBeanException
void unsetUserCalendar(String userId) throws MBeanException
MBeanException
String getUserCalendar(String userId) throws MBeanException
MBeanException
void setGroupCalendar(String groupId, String calendarName) throws MBeanException
MBeanException
void unsetGroupCalendar(String groupId) throws MBeanException
groupId
-
MBeanException
String getGroupCalendar(String groupId) throws MBeanException
MBeanException
int getAllCalendarsCount() throws MBeanException
MBeanException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |