com.crystaldecisions.sdk.plugin.desktop.calendar
Interface ICalendarBase

All Known Subinterfaces:

ICalendar

public interface ICalendarBase

This interface provides methods that allow you to access a collection of business calendars and information related to their run days.

Method Summary

IBusinessCalendarDays	getDays() Returns a collection that contains calendar objects.
java.lang.String[]	getGroupDescriptions(int groupID, java.util.Locale locale) Returns a collection that contains calendar run day descriptions.
int[]	getGroupIDs(int inDay, int inMonth, int inYear) Returns a collection that contains calendar run day identifiers.
boolean	hasMoreThanOneDay(int groupID) Determines whether a certain group contains more than one run day.
boolean	isRunDay(int inDay, int inMonth, int inYear) Returns a boolean that indicates whether a specified date is a run day.
void	remove(int startDay, int startMonth, int startYear, int endDay, int endMonth, int endYear) Removes the specified run day from the business calendar collection.
void	removeGroup(int groupID) Removes the group specified by the given group ID from the calendar collection.

Method Detail

getDays

public IBusinessCalendarDays getDays()
                              throws SDKException

Returns a collection that contains calendar objects.

Returns:

A IBusinessCalendarDays collection.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IBusinessCalendarDays

isRunDay

public boolean isRunDay(int inDay,
                        int inMonth,
                        int inYear)
                 throws SDKException

Returns a boolean that indicates whether a specified date is a run day.

Parameters:

inDay - A int specifies the day (1 - 31)

inMonth - Aint specifies the month (0-11)

inYear - Aint specifies the year (1 - 0x10000000)

Returns:

return Aboolean if the specified date is a run day throws SDKException if passing parameters are not valid

SDKException

remove

public void remove(int startDay,
                   int startMonth,
                   int startYear,
                   int endDay,
                   int endMonth,
                   int endYear)
            throws SDKException

Removes the specified run day from the business calendar collection.

Parameters:

startDay - A int specifies the start day (1 - 31)

startMonth - Aint specifies the start month (0-11)

startYear - Aint specifies the start year (1 - 0x10000000)

endDay - A int specifies the end day (1 - 31)

endMonth - Aint specifies the end month (0-11)

endYear - Aint specifies the end year (1 - 0x10000000)

Throws:

SDKException - This is thrown if the process is unsuccessful.

removeGroup

public void removeGroup(int groupID)
                 throws SDKException

Removes the group specified by the given group ID from the calendar collection.

Parameters:

groupID - Aint specifies the id of a group

Throws:

SDKException - This is thrown if the process is unsuccessful.

getGroupIDs

public int[] getGroupIDs(int inDay,
                         int inMonth,
                         int inYear)
                  throws SDKException

Returns a collection that contains calendar run day identifiers.

Parameters:

inDay - An int that specifies the day (1 - 31).

inMonth - An int that specifies the month (0 - 11).

inYear - An int that specifies the year (1 - 0x10000000).

Returns:

return An int array that contains all the group IDs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getGroupDescriptions

public java.lang.String[] getGroupDescriptions(int groupID,
                                               java.util.Locale locale)
                                        throws SDKException

Returns a collection that contains calendar run day descriptions.

Parameters:

groupID - A int specifies a group id

Returns:

return AString array that contains all the descriptions.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasMoreThanOneDay

public boolean hasMoreThanOneDay(int groupID)
                          throws SDKException

Determines whether a certain group contains more than one run day.

Parameters:

groupID - A int specifies a group id

Returns:

return Aboolean if a group contains more than one day

Throws:

SDKException - This is thrown if the process is unsuccessful.