com.adobe.connectpro.telephony.adaptor
Class AdaptorField

java.lang.Object
  com.adobe.connectpro.telephony.adaptor.AdaptorField

public class AdaptorField
extends java.lang.Object

Data class containing schema information about an adaptor field needed for telephony profiles of provider represented by the adaptor. For example, it will tell if the field value is required to be input from user? should it be displayed in connect pro meeting UI? etc.

Nested Class Summary

static class	AdaptorField.InMeetingDisplayLevel Level of restriction that determines which meeting participants can view the field.
static class	AdaptorField.UIType UI Type of the field used when getting user input or label type to use when displaying the field in the meeting..

Constructor Summary

AdaptorField(AdaptorField field)

AdaptorField(java.lang.String fieldId, java.lang.String name)
Constructor.

AdaptorField(java.lang.String fieldId, java.lang.String name, AdaptorField.UIType uIType, AdaptorField.InMeetingDisplayLevel inMeetingDisplayLevel, boolean required, boolean userDefined)
Constructor with all the fields for convenience.

Method Summary

java.lang.String	getFieldId() Gets the field-id of the field used in profile value communication between adaptor and Connect Pro..
AdaptorField.InMeetingDisplayLevel	getInMeetingDisplayLevel() Level of restriction that determines which meeting participants can view the field.
java.lang.String	getName() Gets the display name of the field.
AdaptorField.UIType	getUIType() Sets the UI Type of the input field used when getting user input or label type to use when displaying the field in the meeting.
boolean	isRequired() Returns a Boolean value that specifies whether users are required to provide info in this field while creating a profile.
boolean	isUserDefined() Returns a Boolean value that specifies whether users can provide info in this field.
void	setFieldId(java.lang.String fieldId) Sets the display name of the field.
void	setInMeetingDisplayLevel(AdaptorField.InMeetingDisplayLevel inMeetingDisplayLevel) Level of restriction that determines which meeting participants can view the field.
void	setName(java.lang.String name) Sets the display name of the field.
void	setRequired(boolean required) Sets whether users are required to provide info in this field while creating a profile.
void	setUIType(AdaptorField.UIType uIType) Sets the UI Type of the input field used when getting user input or label type to use when displaying the field in the meeting.
void	setUserDefined(boolean userDefined) Sets whether users can provide info in this field.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdaptorField

public AdaptorField(java.lang.String fieldId,
                    java.lang.String name)

Constructor.

Parameters:

fieldId - field-id of the field to be used in name-value pairs while passing profile info to adaptor in different TelephonyAdaptor method calls. Can't be null or empty.

name - Display name of the field. Can't be null or empty.

AdaptorField

public AdaptorField(java.lang.String fieldId,
                    java.lang.String name,
                    AdaptorField.UIType uIType,
                    AdaptorField.InMeetingDisplayLevel inMeetingDisplayLevel,
                    boolean required,
                    boolean userDefined)

Constructor with all the fields for convenience.

Parameters:

fieldId - field-id of the field to be used in name-value pairs while passing profile info to adaptor in different TelephonyAdaptor method calls. Can't be null or empty.

name - Display name of the field. Can't be null or empty.

uIType - UI Type of the input field used when getting user input or label type to use when displaying the field in the meeting.

inMeetingDisplayLevel - Level of restriction that determines which meeting participants can view the field. In Connect Pro 7.5 SP1 only NONE and PARTICIPANTS are supported.

required - Boolean value that specifies whether users are required to provide info in this field while creating a profile. This is applicable only if isUserDefined is true.

userDefined - Boolean value that specifies whether users can provide info in this field

AdaptorField

public AdaptorField(AdaptorField field)

Method Detail

getFieldId

public java.lang.String getFieldId()

Gets the field-id of the field used in profile value communication between adaptor and Connect Pro..

getName

public java.lang.String getName()

Gets the display name of the field.

getUIType

public AdaptorField.UIType getUIType()

Sets the UI Type of the input field used when getting user input or label type to use when displaying the field in the meeting.

getInMeetingDisplayLevel

public AdaptorField.InMeetingDisplayLevel getInMeetingDisplayLevel()

Level of restriction that determines which meeting participants can view the field. In Connect Pro 7.5 SP1 only NONE and PARTICIPANTS are supported.

isRequired

public boolean isRequired()

Returns a Boolean value that specifies whether users are required to provide info in this field while creating a profile. This is applicable only if isUserDefined is true.

isUserDefined

public boolean isUserDefined()

Returns a Boolean value that specifies whether users can provide info in this field.

setFieldId

public void setFieldId(java.lang.String fieldId)

Sets the display name of the field. Use curly braces, {message-id} if you need it localized

setName

public void setName(java.lang.String name)

Sets the display name of the field. Use curly braces, {message-id} if you need it localized

setRequired

public void setRequired(boolean required)

Sets whether users are required to provide info in this field while creating a profile. This is applicable only if isUserDefined is true.

setUserDefined

public void setUserDefined(boolean userDefined)

Sets whether users can provide info in this field.

setUIType

public void setUIType(AdaptorField.UIType uIType)

Sets the UI Type of the input field used when getting user input or label type to use when displaying the field in the meeting.

setInMeetingDisplayLevel

public void setInMeetingDisplayLevel(AdaptorField.InMeetingDisplayLevel inMeetingDisplayLevel)

Level of restriction that determines which meeting participants can view the field. In Connect Pro 7.5 SP1 only NONE and PARTICIPANTS are supported.