microsoft.exchange.webservices.data
Class OofSettings

java.lang.Object
  extended by microsoft.exchange.webservices.data.ComplexProperty
      extended by microsoft.exchange.webservices.data.OofSettings

public final class OofSettings
extends ComplexProperty

Represents a user's Out of Office (OOF) settings.


Constructor Summary
OofSettings()
          Initializes a new instance of OofSettings.
 
Method Summary
 OofExternalAudience getAllowExternalOof()
          Gets a value indicating the authorized external OOF notifications.
 TimeWindow getDuration()
          Gets the duration of the OOF status when State is set to OofState.Scheduled.
 OofExternalAudience getExternalAudience()
          Gets a value indicating who should receive external OOF messages.
 OofReply getExternalReply()
          Gets the OOF response sent to addresses outside the user's domain or trusted domain.
 OofReply getInternalReply()
          Gets the OOF response sent other users in the user's domain or trusted domain.
 OofState getState()
          Gets the user's OOF state.
 void setAllowExternalOof(OofExternalAudience allowExternalOof)
          Sets a value indicating the authorized external OOF notifications.
 void setDuration(TimeWindow duration)
          Sets the duration of the OOF status when State is set to OofState.Scheduled.
 void setExternalAudience(OofExternalAudience externalAudience)
          Sets a value indicating who should receive external OOF messages.
 void setExternalReply(OofReply externalReply)
          Sets the OOF response sent to addresses outside the user's domain or trusted domain.
 void setInternalReply(OofReply internalReply)
          Sets the OOF response sent other users in the user's domain or trusted domain.
 void setState(OofState state)
          Sets the user's OOF state.
protected  boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
          Tries to read element from XML.
 void validate()
          Validates this instance.
protected  void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes elements to XML.
 
Methods inherited from class microsoft.exchange.webservices.data.ComplexProperty
addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, func, getNamespace, internalValidate, loadFromXml, loadFromXml, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXmlToPatch, updateFromXml, updateFromXml, writeAttributesToXml, writeToXml, writeToXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OofSettings

public OofSettings()
Initializes a new instance of OofSettings.

Method Detail

tryReadElementFromXml

protected boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                 throws java.lang.Exception
Tries to read element from XML.

Overrides:
tryReadElementFromXml in class ComplexProperty
Parameters:
reader - The reader
Returns:
True if appropriate element was read.
Throws:
java.lang.Exception - the exception

writeElementsToXml

protected void writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                           throws java.lang.Exception
Writes elements to XML.

Overrides:
writeElementsToXml in class ComplexProperty
Parameters:
writer - The writer
Throws:
java.lang.Exception - the exception

getState

public OofState getState()
Gets the user's OOF state.

Returns:
The user's OOF state.

setState

public void setState(OofState state)
Sets the user's OOF state.

Parameters:
state - the new state

getExternalAudience

public OofExternalAudience getExternalAudience()
Gets a value indicating who should receive external OOF messages.

Returns:
the external audience

setExternalAudience

public void setExternalAudience(OofExternalAudience externalAudience)
Sets a value indicating who should receive external OOF messages.

Parameters:
externalAudience - the new external audience

getDuration

public TimeWindow getDuration()
Gets the duration of the OOF status when State is set to OofState.Scheduled.

Returns:
the duration

setDuration

public void setDuration(TimeWindow duration)
Sets the duration of the OOF status when State is set to OofState.Scheduled.

Parameters:
duration - the new duration

getInternalReply

public OofReply getInternalReply()
Gets the OOF response sent other users in the user's domain or trusted domain.

Returns:
the internal reply

setInternalReply

public void setInternalReply(OofReply internalReply)
Sets the OOF response sent other users in the user's domain or trusted domain.

Parameters:
internalReply - the new internal reply

getExternalReply

public OofReply getExternalReply()
Gets the OOF response sent to addresses outside the user's domain or trusted domain.

Returns:
the external reply

setExternalReply

public void setExternalReply(OofReply externalReply)
Sets the OOF response sent to addresses outside the user's domain or trusted domain.

Parameters:
externalReply - the new external reply

getAllowExternalOof

public OofExternalAudience getAllowExternalOof()
Gets a value indicating the authorized external OOF notifications.

Returns:
the allow external oof

setAllowExternalOof

public void setAllowExternalOof(OofExternalAudience allowExternalOof)
Sets a value indicating the authorized external OOF notifications.

Parameters:
allowExternalOof - the new allow external oof

validate

public void validate()
              throws java.lang.Exception
Validates this instance.

Overrides:
validate in class ComplexProperty
Throws:
java.lang.Exception - the exception