BusinessCalendarConfigurationMBean Interface

com.bea.wli.management.configuration
BusinessCalendarConfigurationMBean Interface

public interface BusinessCalendarConfigurationMBean

    extends ConfigurationMBean

MBean for configuring business calendars.


All Superinterfaces
ConfigurationMBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, WebLogicMBean

Field Summary

public static final long
CACHING_STUB_SVUID
The magic number that is used to generate the serialVersionUID of the generated MBean Stub (xxxMBean_Stub).
   
Fields from interface weblogic.management.configuration.ConfigurationMBean
CACHING_STUB_SVUID, DEFAULT_EMPTY_BYTE_ARRAY
 

Method Summary

public boolean
calendarNameExists(String name)
Checks if a calendar with the given name exists.
public void
createCalendar(CalendarDocument cDoc)
Creates a new calendar from the information passed in the CalendarDocument.
public void
deleteCalendar(String calendarName)
public void
deleteCalendars(String[] names)
public String[]
getAllCalendarNames()
public CalendarDocument[]
getAllCalendars()
Gets all calendars, includin rules info and mapped groups and users
public CalendarDocument
getCalendar(String calendarName)
public CalendarDocument
getGroupCalendar(String groupId)
public CalendarDocument
getSystemCalendar()
public CalendarDocument
getUserCalendar(String userId)
public void
setGroupCalendar(String groupId, String calendarName)
public void
setUserCalendar(String userId, String calendarName)
Set the user's calendar.
public boolean
systemCalendarExists()
public void
unsetGroupCalendar(String groupId)
public void
unsetUserCalendar(String userId)
public void
updateCalendar(String oldCalendarName, CalendarDocument cDoc)
Update the calendar - oldCalendarName, using the passed CalendarDocument.
public void
updateSystemCalendar(CalendarDocument cDoc)
Update the system calendar using the passed CalendarDocument.
 
Methods from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getAttributeStringValue, getComments, getNotes, getSetFields, getXml, getXmlConverter, isDefaultedMBean, isPersistenceEnabled, preDeregister, registerConfigMBean, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, touch, unRegisterConfigMBean
 
Methods from interface javax.management.DynamicMBean
getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes
 
Methods from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
   

Field Detail

CACHING_STUB_SVUID

public static final long CACHING_STUB_SVUID
The magic number that is used to generate the serialVersionUID of the generated MBean Stub (xxxMBean_Stub). You must change this value whenever you make one of the changes to this interface:

- remove an existing method.
- change the signature of an existing "getter" or "setter" method.
- change the signature of an existing "boolean getter", i.e, "boolean isEnabled()"

Otherwise you don't need to change this value. For instance you can add new methods, or you can change the signature of methods that don't start with "get", "set" or "is". If you are in doubt then change the SVUID. It is a good idea to increment this value when changing.

 

Method Detail

calendarNameExists(String) Method

public boolean calendarNameExists(String name)
throws MBeanException
Checks if a calendar with the given name exists.

Exceptions

MBeanException

createCalendar(CalendarDocument) Method

public void createCalendar(CalendarDocument cDoc)
throws MBeanException
Creates a new calendar from the information passed in the CalendarDocument.

Exceptions

MBeanException
- if a calendar with the given name exists or of the document is not valid.

deleteCalendar(String) Method

public void deleteCalendar(String calendarName)
throws MBeanException

Exceptions

MBeanException

deleteCalendars(String[]) Method

public void deleteCalendars(String[] names)
throws MBeanException

Exceptions

MBeanException

getAllCalendarNames() Method

public String[] getAllCalendarNames()
throws MBeanException

Exceptions

MBeanException

getAllCalendars() Method

public CalendarDocument[] getAllCalendars()
throws MBeanException
Gets all calendars, includin rules info and mapped groups and users

Exceptions

MBeanException

getCalendar(String) Method

public CalendarDocument getCalendar(String calendarName)
throws MBeanException

Returns

The CalendarDocument or null if a calendar with the given name does not exist.

Exceptions

MBeanException

getGroupCalendar(String) Method

public CalendarDocument getGroupCalendar(String groupId)
throws MBeanException

Exceptions

MBeanException

getSystemCalendar() Method

public CalendarDocument getSystemCalendar()
throws MBeanException

Exceptions

MBeanException

getUserCalendar(String) Method

public CalendarDocument getUserCalendar(String userId)
throws MBeanException

Exceptions

MBeanException

setGroupCalendar(String, String) Method

public void setGroupCalendar(String groupId, 
                             String calendarName)
throws MBeanException

Exceptions

MBeanException

setUserCalendar(String, String) Method

public void setUserCalendar(String userId, 
                            String calendarName)
throws MBeanException
Set the user's calendar. Does not do anything is either the given user or the calendar does not exist. A user can have only one calendar, so if a calendar is already mapped to the user then it is unmapped.

Exceptions

MBeanException

systemCalendarExists() Method

public boolean systemCalendarExists()
throws MBeanException

Exceptions

MBeanException

unsetGroupCalendar(String) Method

public void unsetGroupCalendar(String groupId)
throws MBeanException

Exceptions

MBeanException

unsetUserCalendar(String) Method

public void unsetUserCalendar(String userId)
throws MBeanException

Exceptions

MBeanException

updateCalendar(String, CalendarDocument) Method

public void updateCalendar(String oldCalendarName, 
                           CalendarDocument cDoc)
throws MBeanException
Update the calendar - oldCalendarName, using the passed CalendarDocument. The name of the calendar is also updated based on the name passed in. Use updateSystemCalendar to update the system calendar.

Exceptions

MBeanException

updateSystemCalendar(CalendarDocument) Method

public void updateSystemCalendar(CalendarDocument cDoc)
throws MBeanException
Update the system calendar using the passed CalendarDocument. If the name of the calendar is differnt than the name of the existing system calendar, then the existing system calendar is changed to non-system calendar. If a calendar with this name does not exist then it is created.

Exceptions

MBeanException