Package co.ecg.alpaca.toolkit.generated.services

Class UserCustomRingback

java.lang.Object

co.ecg.alpaca.toolkit.model.BroadWorksObject

co.ecg.alpaca.toolkit.model.BroadWorksService

co.ecg.alpaca.toolkit.model.BroadWorksUserService

co.ecg.alpaca.toolkit.generated.services.UserCustomRingback

All Implemented Interfaces:

Serializable

public class UserCustomRingback
extends BroadWorksUserService

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserCustomRingback.UserCustomRingbackUserAddCriteriaRequest	Add a criteria to the user's custom ringback service.
static class	UserCustomRingback.UserCustomRingbackUserDeleteCriteriaRequest	Delete a criteria from the user's custom ringback service.
static class	UserCustomRingback.UserCustomRingbackUserGetCriteriaListRequest	Get the user's custom ringback service criteria listing.
static class	UserCustomRingback.UserCustomRingbackUserGetCriteriaListResponse	Response to the UserCustomRingbackUserGetCriteriaListRequest.
static class	UserCustomRingback.UserCustomRingbackUserGetCriteriaRequest	Get a criteria for the user's custom ringback service.
static class	UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse	Response to the UserCustomRingbackUserGetCriteriaRequest21.
static class	UserCustomRingback.UserCustomRingbackUserModifyActiveCriteriaListRequest	Modify the user's custom ringback service criteria's active setting.
static class	UserCustomRingback.UserCustomRingbackUserModifyCriteriaRequest	Modify a criteria for the user's custom ringback service.

Field Summary

Fields

Modifier and Type	Field	Description
List<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse>	customRingbackUserCriteria
UserCustomRingback.UserCustomRingbackUserGetCriteriaListResponse	customRingbackUserCriteriaList
static ServiceTag<UserCustomRingback>	tag

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUserService

user

Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

broadWorksServer, populated

Constructor Summary

Constructors

Constructor	Description
UserCustomRingback()	The serializable constructor for the UserService
UserCustomRingback(BroadWorksProcess broadWorksProcess, BroadWorksUser user)	Returns a UserService Object with the User Assigned

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getClassName()
List<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse>	getCustomRingbackUserCriteria()	Response to the UserCustomRingbackUserGetCriteriaRequest21.
UserCustomRingback.UserCustomRingbackUserGetCriteriaListResponse	getCustomRingbackUserCriteriaList()	Response to the UserCustomRingbackUserGetCriteriaListRequest.
int	hashCode()
DefaultResponse	populate()	Populates all available service data
void	push(BroadWorksProcess broadWorksProcess, BroadWorksUser user)	Adds all available service data to a User

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksService

getProcess, getRequestContext, isPopulated, isPrimary, mapRequestAndFire, mapRequestAndFire, mapRequestAndFire, setBroadWorksProcess, setPrimary, waitForLoad

Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject

getBroadWorksServer, hasPopulated, setBroadWorksServer, setPopulated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

tag

@Expose(deserialize=false)
public static final ServiceTag<UserCustomRingback> tag

customRingbackUserCriteriaList

public UserCustomRingback.UserCustomRingbackUserGetCriteriaListResponse customRingbackUserCriteriaList

customRingbackUserCriteria

public List<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse> customRingbackUserCriteria

Constructor Detail

UserCustomRingback

public UserCustomRingback(BroadWorksProcess broadWorksProcess,
                          BroadWorksUser user)

Returns a UserService Object with the User Assigned

Parameters:

user -

UserCustomRingback

public UserCustomRingback()

The serializable constructor for the UserService

Method Detail

getClassName

public String getClassName()

getCustomRingbackUserCriteriaList

public UserCustomRingback.UserCustomRingbackUserGetCriteriaListResponse getCustomRingbackUserCriteriaList()

Response to the UserCustomRingbackUserGetCriteriaListRequest. The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension". The following columns are only returned in AS data mode: "Calls To Type", "Calls To Number" and "Calls To Extension" The possible values for the "Calls To Type" column are the following or a combination of them separated by comma: - Primary - Alternate X (where x is a number between 1 and 10) - Mobility The possible values for the "Calls To Number" column are the following or a combination of them separated by comma: - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number. - When no number is available a blank space is provided instead. The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma: - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension. - For Mobility Calls To Type, this is always blank. - When no extension is available a blank space is provided instead.

Returns:

the UserCustomRingbackUserGetCriteriaListResponse for this service

getCustomRingbackUserCriteria

public List<UserCustomRingback.UserCustomRingbackUserGetCriteriaResponse> getCustomRingbackUserCriteria()

Response to the UserCustomRingbackUserGetCriteriaRequest21.

Returns:

the UserCustomRingbackUserGetCriteriaResponse for this service

populate

public DefaultResponse populate()

Populates all available service data

Specified by:

populate in class BroadWorksObject

push

public void push(BroadWorksProcess broadWorksProcess,
                 BroadWorksUser user)

Adds all available service data to a User

Specified by:

push in class BroadWorksUserService

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object