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.

Field Summary

static java.lang.String	KIND The Kind used to query for Calendar objects.
static java.lang.String	PROGID The ProgID for the Calendar Class.

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.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for Calendar objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the Calendar Class.

ProgID	CrystalEnterprise.Calendar
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.calendar.ICalendar

Query syntax:

SELECT
	SI_DESCRIPTION, SI_NAME, SI_ID
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.Calendar'

The ICalendar interface does not contain any methods or properties that require specific CePropertyIDs to be referenced in the SELECT Statement. However, you can access general InfoObject properties, such as the SI_NAME, SI_DESCRIPTION, and SI_ID from the objects returned by the query. For more information, see calendar.

See Also:

Constant Field Values

Method Detail

getDays

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

InfoObject properties to query for:

SI_TEMPLATE_DAYS

isRunDay

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

Throws:

SDKException

InfoObject properties to query for:

SI_TEMPLATE_DAYS

remove

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.

InfoObject properties to query for:

SI_TEMPLATE_DAYS

removeGroup

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.

InfoObject properties to query for:

SI_TEMPLATE_DAYS

getGroupIDs

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.

InfoObject properties to query for:

SI_TEMPLATE_DAYS

getGroupDescriptions

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.

InfoObject properties to query for:

SI_TEMPLATE_DAYS

hasMoreThanOneDay

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.

InfoObject properties to query for:

SI_TEMPLATE_DAYS