public interface SchedConf
SchedConfFactory
to create an instance of the class.
Then, the various attributes are set to their desired values. Finally, the schedule method is called to cause the conference to be
scheduled on the conference service.
After a conference has been scheduled, the getUrl and getDialIn methods can be called to retrieve the "join" link/number,
which can be distributed to attendees so they can join the conference using either a browser or a phone.
SchedConfFactory
will change the state of the instance from the "to be scheduled" state to the
already scheduled state. Instances of this class returned by the SchedConfFactory methods retrieveConf and
retrieveListConf are always in the already scheduled state.
The various "set" methods can only be invoked for a "to be scheduled" conference. Some of the "get" methods (like getUrl) are only
valid after a successful call to the schedule method. Finally, it is only valid to invoke the schedule method for a
"to be scheduled" conference. Attempts to invoke state-dependent methods when a class instance is in the "wrong" state will result in a
an IllegalStateException
being thrown.
The class SampleSchedConf for an example of how to use this class.
Modifier and Type | Method and Description |
---|---|
int |
getConfId()
Returns the conference ID of the conference.
|
String |
getDescription()
Returns the description of the conference.
|
String |
getDialIn()
Returns the dial-in number for the conference.
|
Duration |
getDuration()
Returns the duration of the conference.
|
int |
getMaxParticipants()
Returns the number of reserved participant ports.
|
int |
getModeratorPin()
Returns the moderator PIN for the conference.
|
int |
getNumber()
Deprecated.
|
String |
getNumberAsString()
Returns the conference Number of the conference.
|
int |
getParticipantPin()
Returns the participant PIN for the conference.
|
Calendar |
getStartTime()
Returns the start time of the conference.
|
String |
getStatus()
Returns the status of the conference.
|
String |
getSubject()
Returns the subject of the conference.
|
String |
getUrl()
Returns the URL for the conference.
|
void |
schedule()
Schedules a conference with the attribute values that have been set on the instance of this class.
|
SchedConf |
setDescription(String description)
(Optional) - Sets the conference description.
|
SchedConf |
setDuration(Duration duration)
(Optional) - Sets the duration for the conference.
|
SchedConf |
setDuration(int days,
int hours,
int minutes)
(Optional) - Sets the duration for the conference.
|
SchedConf |
setMaxParticipants(int num)
(Optional) - Sets the number of conference participants.
|
SchedConf |
setModeratorPin(int pin)
(Optional) - Sets the moderator pin.
|
SchedConf |
setParticipantPin(int pin)
(Optional) - Sets the participant pin.
|
SchedConf |
setStartTime(Calendar startTime)
(Optional) - Sets the start time for the conference.
|
SchedConf |
setSubject(String subject)
Sets the subject.
|
SchedConf setMaxParticipants(int num)
num
- The number of particpant ports to reserve for the conference.IllegalArgumentException
- if num <= 0.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.int getMaxParticipants()
SchedConf setModeratorPin(int pin)
pin
- The value to set the pin to.IllegalArgumentException
- if pin < -1.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.int getModeratorPin()
SchedConf setParticipantPin(int pin)
pin
- The value to set the pin to.IllegalArgumentException
- if pin < -1.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.int getParticipantPin()
SchedConf setSubject(String subject)
SchedConfOperations
for a way to
validate the characters in the description.subject
- The subject of the conference.IllegalArgumentException
- if subject is null or blank.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.String getSubject()
SchedConf setDescription(String description)
SchedConfOperations
for a way to
validate the characters in the description.description
- The description of the conference.IllegalArgumentException
- if description is null.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.String getDescription()
SchedConf setStartTime(Calendar startTime)
startTime
- A Calendar
instance representing the start time of the conference.IllegalArgumentException
- if startTime is null.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.Calendar getStartTime()
Calendar
instance representing the start time of the conference; if the start time has not been explicitly set and
the state of the instance of this class is "to be scheduled", this method returns null.SchedConf setDuration(int days, int hours, int minutes)
days
- The number of days for the conference durationhours
- The number of hours for the conference duration.minutes
- The number of minutes for the conference duration.IllegalArgumentException
- if any of the parameters is < 0 or the duration is < 1 minute or the duration is greater than 30 days.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.SchedConf setDuration(Duration duration)
duration
- A Duration
instance representing the conference duration.IllegalArgumentException
- if the duration is < 1 minute or the duration is greater than 30 days.IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.Duration getDuration()
Duration
instance representing the conference duration.int getConfId()
IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.int getNumber()
IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.ArithmeticException
- if the value to be returned is larger than 9 digits.String getNumberAsString()
IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.void schedule()
IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked. This condition can occur, for
example, if required attributes of this class have not been set.SchedConfException
- if an error occurs during the operation.String getUrl()
IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.String getDialIn()
IllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.String getStatus()
SchedconfFactory
methods retrieveConf or retrieveListConfIllegalStateException
- if the state of the instance of this class does not allow this method to be invoked.Copyright © 2016 Avaya. All Rights Reserved.