com.hcl.domino.person

Interface OutOfOffice

public interface OutOfOffice

Out of Office information for a single user

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OutOfOffice.OOOType

Method Summary

Modifier and Type	Method and Description
DominoDateRange	getAwayPeriod() This function returns time parameters that control OOO.
String	getGeneralMessage() OOO supports two sets of messages.
String	getGeneralSubject() OOO supports two sets of messages. They are called General message/subject and Special message/subject. This function gets the general subject. This is string that will appear as the subject line of the OOO notification.
Person	getParentPerson()
void	getState(Ref<OutOfOffice.OOOType> retType, Ref<Boolean> retIsEnabled) This function returns the version (agent, service) and the state (disabled, enabled) of the out of office functionality. The version information can be used to show or hide UI elements that might not be supported for a given version. For example, the agent does not support durations of less than 1 day and some clients might choose not to show the hours in the user interface. When you need to make getState(Ref, Ref) as efficient as possible, call Person.openOutOfOffice(String, boolean, Database) with the home mail server and the opened mail database. This function is read only and does not return an error if user ACL rights are below Editor (which are required to turn on/off the Out of office functionality). If getState(Ref, Ref) is called immediately following setEnabled(boolean) it will not reflect the state set by the setEnabled(boolean). To see the current state, start a new operation using Person.openOutOfOffice(String, boolean, Database), getState(Ref, Ref).
OutOfOffice.OOOType	getType() Convenience method to read which kind of OOO system is used (agent or service).
boolean	isEnabled() Convenience method to check whether the OOO functionality is enabled.
boolean	isExcludeInternet() This function returns a flag which defines how to treat internet emails. This functional call is optional. If this flag is set to true OOO notifications will not be generated for email originating from the internet.
void	setAwayPeriod(TemporalAccessor tdStartAway, TemporalAccessor tdEndAway) This function validates and sets the time parameters that control OOO. This information is required for enabling the OOO. If you want turn on OOO functionality for a given period of time the sequence of calls needed is: Person.openOutOfOffice(String, boolean, Database), setAwayPeriod(TemporalAccessor, TemporalAccessor), and setEnabled(boolean). When you need to enable OOO (i.e.
void	setEnabled(boolean enabled) This function changes the state of the OOO functionality as indicated by the enabled variable. If the OOO functionality is already in the state indicated by the enabled flag, this function does nothing. When you need to enable OOO (i.e.
void	setExcludeInternet(boolean exclude) This function sets a flag which defines how to treat internet emails. This functional call is optional. If this flag is set to true OOO notifications will not be generated for email originating from the internet. The default for this flag is true.
void	setGeneralMessage(String msg) OOO supports two sets of notification messages. They are called General message/subject and Special message/subject. The following text is always appended to the body of the message, where the "Message subject" is obtained from the message which caused the notification to be generated. "Note: This is an automated response to your message "Message subject" sent on 2/12/2009 10:12:17 AM.
void	setGeneralSubject(String subject, boolean displayReturnDate) OOO supports two sets of notification messages. They are called General message/subject and Special message/subject. The rest of the people will receive the general message/subject message. This function sets the general subject. If this field is not specified in by this API call, the value defined using Notes Client will be used, otherwise the default for this field is the following text AUTO: Katherine Smith is out of the office (returning 02/23/2009 10:12:17 AM).

Method Detail

getParentPerson

Person getParentPerson()

getAwayPeriod

DominoDateRange getAwayPeriod()

This function returns time parameters that control OOO.

Returns:

away period

isExcludeInternet

boolean isExcludeInternet()

This function returns a flag which defines how to treat internet emails.
This functional call is optional.
If this flag is set to true OOO notifications will not be generated for email originating from the internet. The default for this flag is true.

Returns:

true if excluded

setExcludeInternet

void setExcludeInternet(boolean exclude)

This function sets a flag which defines how to treat internet emails.

This functional call is optional.
If this flag is set to true OOO notifications will not be generated for email originating from the internet.
The default for this flag is true.

Parameters:

exclude - true to exclude

isEnabled

boolean isEnabled()

Convenience method to check whether the OOO functionality is enabled. Calls getState(Ref, Ref) internally.

Returns:

true if enabled

getType

OutOfOffice.OOOType getType()

Convenience method to read which kind of OOO system is used (agent or service). Calls getState(Ref, Ref) internally.

Returns:

type

getState

void getState(Ref<OutOfOffice.OOOType> retType,
              Ref<Boolean> retIsEnabled)

This function returns the version (agent, service) and the state (disabled, enabled) of the out of office functionality.
The version information can be used to show or hide UI elements that might not be supported for a given version.
For example, the agent does not support durations of less than 1 day and some clients might choose not to show the hours in the user interface.
When you need to make getState(Ref, Ref) as efficient as possible, call Person.openOutOfOffice(String, boolean, Database) with the home mail server and the opened mail database.
This function is read only and does not return an error if user ACL rights are below Editor (which are required to turn on/off the Out of office functionality).
If getState(Ref, Ref) is called immediately following setEnabled(boolean) it will not reflect the state set by the setEnabled(boolean).
To see the current state, start a new operation using Person.openOutOfOffice(String, boolean, Database), getState(Ref, Ref).

Parameters:

retType - returns the type of the OOO system (agent or service)

retIsEnabled - returns whether the service is enabled for the user

getGeneralSubject

String getGeneralSubject()

OOO supports two sets of messages.

They are called General message/subject and Special message/subject.
This function gets the general subject.
This is string that will appear as the subject line of the OOO notification.

Returns:

subject

getGeneralMessage

String getGeneralMessage()

OOO supports two sets of messages. They are called General message/subject and Special message/subject.
This function returns the text of the general message.

Returns:

message

setAwayPeriod

void setAwayPeriod(TemporalAccessor tdStartAway,
                   TemporalAccessor tdEndAway)

This function validates and sets the time parameters that control OOO.

This information is required for enabling the OOO.
If you want turn on OOO functionality for a given period of time the sequence of calls needed is:
Person.openOutOfOffice(String, boolean, Database), setAwayPeriod(TemporalAccessor, TemporalAccessor), and setEnabled(boolean).

When you need to enable OOO (i.e. call it with enabled flag set to true) you should call setAwayPeriod(TemporalAccessor, TemporalAccessor) prior to calling setEnabled(boolean).

If you need to change the length of the away period after OOO has already been enabled, the sequence of calls needed to perform this action is Person.openOutOfOffice(String, boolean, Database), setAwayPeriod(TemporalAccessor, TemporalAccessor).

If the Domino server is configured to run an OOO agent, it can only be turned on for full days, the time portion of the date parameter will not be used.

Parameters:

tdStartAway - This is date and time when Out of office will begin.

tdEndAway - This is date and time when Out of office will end.

setEnabled

void setEnabled(boolean enabled)

This function changes the state of the OOO functionality as indicated by the enabled variable.
If the OOO functionality is already in the state indicated by the enabled flag, this function does nothing.

When you need to enable OOO (i.e. call it with enabled flag set to true) you should call setAwayPeriod(TemporalAccessor, TemporalAccessor) prior to calling setEnabled(boolean).

If setAwayPeriod(TemporalAccessor, TemporalAccessor) is not called, setEnabled(boolean) will use the previous value for start and end.

If they are in the past then the OOO functionality will not be enabled.
When you need to disable OOO (i.e. call it with enabled set to false) setAwayPeriod(TemporalAccessor, TemporalAccessor) does not need to be called.

When setEnabled(boolean) is called with the enabled set to false it means you want to disable OOO immediately.
If you don’t want to disable OOO functionality immediately, but rather you just want to change the time when OOO should stop operating, the sequence of calls is: Person.openOutOfOffice(String, boolean, Database), setAwayPeriod(TemporalAccessor, TemporalAccessor).
If OOO is configured to run as a service and setEnabled(boolean) is used to disable, the OOO service will be auto-disabled immediately.

The summary report will be generated on the first email received after the disable has been requested, or if no messages are received it will generated during the nightly router maintenance.

If OOO is configured as an agent, the user will receive a summary report and a request to disable the agent on the next scheduled run of the agent will occur.

Parameters:

enabled - true to enable

setGeneralSubject

void setGeneralSubject(String subject,
                       boolean displayReturnDate)

OOO supports two sets of notification messages.

They are called General message/subject and Special message/subject.
The rest of the people will receive the general message/subject message.
This function sets the general subject.
If this field is not specified in by this API call, the value defined using Notes Client will be used, otherwise the default for this field is the following text AUTO: Katherine Smith is out of the office (returning 02/23/2009 10:12:17 AM).

Parameters:

subject - string that will appear as the subject line of the OOO notification

displayReturnDate - Boolean which controls whether (“returning <date>”) appears on the subject line

setGeneralMessage

void setGeneralMessage(String msg)

OOO supports two sets of notification messages.
They are called General message/subject and Special message/subject.
The following text is always appended to the body of the message, where the "Message subject" is obtained from the message which caused the notification to be generated.
"Note: This is an automated response to your message "Message subject" sent on 2/12/2009 10:12:17 AM. This is the only notification you will receive while this person is away."

Parameters:

msg - message, max 65535 bytes LMBCS encoded (WORD datatype for length)