Package co.ecg.alpaca.toolkit.generated
Class User
- java.lang.Object
-
- co.ecg.alpaca.toolkit.model.BroadWorksObject
-
- co.ecg.alpaca.toolkit.model.BroadWorksUser
-
- co.ecg.alpaca.toolkit.generated.User
-
- All Implemented Interfaces:
Serializable
public class User extends BroadWorksUser
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
User.UserAccessDeviceFileGetListRequest
Request to get the list of Device Management user modifiable files.static class
User.UserAccessDeviceFileGetListResponse
Response to UserAccessDeviceFileGetListRequest.static class
User.UserAccessDeviceFileGetRequest
Request to get a user modifiable file.static class
User.UserAccessDeviceFileGetResponse
Response to UserAccessDeviceFileGetRequest.static class
User.UserAccessDeviceFileModifyRequest
Request to modify a user modifiable access device file.static class
User.UserAccessDeviceResetRequest
Reset a specific user SIP device that supports the reset operation.static class
User.UserAccessDeviceTagsGetRequest
Request to get all the device tag names and values for a specific device.static class
User.UserAccessDeviceTagsGetResponse
Response to UserAccessDeviceTagsGetRequest.static class
User.UserAddRequest
Request to add a user.static class
User.UserAlternateUserIdAddRequest
Request to add an alternate user Id to an user.static class
User.UserAlternateUserIdDeleteRequest
Request to delete an alternate user id of a user.static class
User.UserAlternateUserIdGetListRequest
Request to get the user id and the list of alternate user ids of an user.static class
User.UserAlternateUserIdGetListResponse
Response to UserAlternateUserIdGetListRequest.static class
User.UserAlternateUserIdModifyRequest
Request to modify an alternate user id of a user.static class
User.UserAnnouncementFileAddRequest
Add an announcement to the user announcement repository The response is either a SuccessResponse or an ErrorResponse.static class
User.UserAnnouncementFileDeleteListRequest
Delete one or more announcements from the user announcement repository The response is either a SuccessResponse or an ErrorResponse.static class
User.UserAnnouncementFileGetAvailableListRequest
Get the list of available announcement files for a User from the Announcement Repository, for Virtual subscribers the list will also include the announcements for it's group.static class
User.UserAnnouncementFileGetAvailableListResponse
Response to UserAnnouncementFileGetAvailableListRequest.static class
User.UserAnnouncementFileGetListRequest
Get the list of announcement names with associated media type and filesize for a User and given Announcement Repository Type The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse.static class
User.UserAnnouncementFileGetListResponse
Response to UserAnnouncementFileGetListRequest.static class
User.UserAnnouncementFileGetRequest
Request to get the announcement repository file information.static class
User.UserAnnouncementFileGetResponse
Response to UserAnnouncementFileGetRequest.static class
User.UserAnnouncementFileModifyRequest
This command is used to change the name of the file or upload a new announcement file for an existing announcement in the user repository.static class
User.UserAnnouncementRepositoryGetSettingsRequest
Return the disk space being used.static class
User.UserAnnouncementRepositoryGetSettingsResponse
Response to UserAnnouncementRepositoryGetSettingsRequest.static class
User.UserAssignedServicesGetListRequest
Get the list of assigned User and Group Services for the specified user.static class
User.UserAssignedServicesGetListResponse
Response to UserAssignedServicesGetListRequest.static class
User.UserCallLogsClearRequest
Clear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features.static class
User.UserCallPoliciesGetRequest
Request the user level data associated with Call Policies.static class
User.UserCallPoliciesGetResponse
Response to UserCallPoliciesGetRequest19sp1.static class
User.UserCallPoliciesModifyRequest
Modify the user level data associated with Call Policies.static class
User.UserCallProcessingGetPolicyRequest
Request the user level data associated with Call Processing Policy.static class
User.UserCallProcessingGetPolicyResponse
Response to UserCallProcessingGetPolicyRequest22.static class
User.UserCallProcessingModifyPolicyRequest
Modify the user level data associated with Call Processing Policy.static class
User.UserCommunicationBarringAuthorizationCodeAddListRequest
Add a list of Communication Barring Authorization codes to a user.static class
User.UserCommunicationBarringAuthorizationCodeDeleteListRequest
Delete a list of Communication Barring Authorization codes from a user.static class
User.UserCommunicationBarringAuthorizationCodeGetListRequest
Get a list of Communication Barring Authorization Code for a user.static class
User.UserCommunicationBarringAuthorizationCodeGetListResponse
Response to UserCommunicationBarringAuthorizationCodeGetListRequest.static class
User.UserCommunicationBarringGetRequest
Gets the Communication Barring settings for a user.static class
User.UserCommunicationBarringGetResponse
Response to UserCommunicationBarringGetRequest.static class
User.UserCommunicationBarringModifyRequest
Modify the Communication Barring settings for a user.static class
User.UserConsolidatedAddRequest
Request to add a user.static class
User.UserConsolidatedDeleteRequest
Request to delete a user.static class
User.UserDeleteRequest
Request to delete a user.static class
User.UserDevicePoliciesGetRequest
Request the user level data associated with Device Policy.static class
User.UserDevicePoliciesGetResponse
Response to UserDevicePoliciesGetRequest21.static class
User.UserDevicePoliciesModifyRequest
Modify the user level data associated with Device Policy.static class
User.UserDnGetActivationListRequest
Request to get a list of DNs associated with a user and their activation state.static class
User.UserDnGetActivationListResponse
Response to UserDnGetActivationListRequest.static class
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest
Get an enterprise's common phone list for a user.static class
User.UserEnterpriseCommonPhoneListGetPagedSortedListResponse
Response to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest.static class
User.UserFeatureAccessCodeGetListRequest
Get the list of feature access codes for a user.static class
User.UserFeatureAccessCodeGetListResponse
Response to the UserFeatureAccessCodeGetListRequest21.static class
User.UserFeatureAccessCodeModifyListRequest
Enable or disable a list of feature access codes for a user.static class
User.UserGetListInGroupRequest
Request the list of users in a group.static class
User.UserGetListInGroupResponse
Response to UserGetListInGroupRequest.static class
User.UserGetListInServiceProviderRequest
Request the list of users in a service provider or enterprise.static class
User.UserGetListInServiceProviderResponse
Response to UserGetListInServiceProviderRequest.static class
User.UserGetListInSystemRequest
Request the list of users in the system.static class
User.UserGetListInSystemResponse
Response to UserGetListInSystemRequest.static class
User.UserGetRegistrationListRequest
Request to get a list of registrations for a user.static class
User.UserGetRegistrationListResponse
Response to UserGetRegistrationListRequest.static class
User.UserGetRequest
Request to get the user information.static class
User.UserGetResponse
Response to UserGetRequest22V3.static class
User.UserGetServiceInstanceListInServiceProviderRequest
Request the list of Service Instances in a service provider or an enterprise.static class
User.UserGetServiceInstanceListInServiceProviderResponse
Response to UserGetServiceInstanceListInServiceProviderRequest.static class
User.UserGetServiceInstanceListInSystemRequest
Request the list of Service Instances in the system.static class
User.UserGetServiceInstanceListInSystemResponse
Response to UserGetServiceInstanceListInSystemRequest.static class
User.UserGroupCommonPhoneListGetPagedSortedListRequest
Get a user's group's common phone list.static class
User.UserGroupCommonPhoneListGetPagedSortedListResponse
Response to the UserGroupCommonPhoneListGetPagedSortedListRequest.static class
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest
Gets a Custom Contact Directory in a group.static class
User.UserGroupCustomContactDirectoryGetPagedSortedListResponse
Response to the UserGroupCustomContactDirectoryGetPagedSortedListRequest.static class
User.UserLinePortGetListRequest
Request to get all user's configured line ports.static class
User.UserLinePortGetListResponse
Response to UserLinePortGetListRequest.static class
User.UserModifyRequest
Request to modify a user.static class
User.UserModifyUserIdRequest
Modify the user id of a real or virtual user.static class
User.UserNetworkConferencingGetRequest
Request the Network-Based Conferencing data for a specified user.static class
User.UserNetworkConferencingGetResponse
Response to UserNetworkConferencingGetRequest.static class
User.UserOCICallControlApplicationGetListRequest
Get the OCI call control application list that can be used by the user.static class
User.UserOCICallControlApplicationGetListResponse
Response to UserOCICallControlApplicationGetListRequest.static class
User.UserOCICallControlApplicationModifyRequest
Modify which OCI Call Control Applications are enabled on a user The response is either SuccessResponse or ErrorResponse.static class
User.UserPasswordInfoGetRequest
Request the user's Web password information.static class
User.UserPasswordInfoGetResponse
Response to UserPasswordInfoGetRequest.static class
User.UserPersonalPhoneListAddListRequest
Add one or more entries to a user's personal phone list.static class
User.UserPersonalPhoneListDeleteListRequest
Delete one or more entries from a user's personal phone list.static class
User.UserPersonalPhoneListGetListRequest
Get a user's personal phone list.static class
User.UserPersonalPhoneListGetListResponse
Response to the UserPersonalPhoneListGetListRequest.static class
User.UserPersonalPhoneListGetPagedSortedListRequest
Get a user's personal phone list.static class
User.UserPersonalPhoneListGetPagedSortedListResponse
Response to the UserPersonalPhoneListGetPagedSortedListRequest.static class
User.UserPersonalPhoneListModifyRequest
Modify an entry in a user's personal phone list.static class
User.UserPhoneDirectoryGetListRequest
Request a table containing the phone directory for a user's group.static class
User.UserPhoneDirectoryGetListResponse
Response to UserPhoneDirectoryGetListRequest.static class
User.UserPhoneDirectoryGetPagedListRequest
Request a table containing the phone directory for a user.static class
User.UserPhoneDirectoryGetPagedListResponse
Response to UserPhoneDirectoryGetPagedListRequest.static class
User.UserPhoneDirectoryGetPagedSortedListRequest
Request a table containing the phone directory for a user.static class
User.UserPhoneDirectoryGetPagedSortedListResponse
Response to UserPhoneDirectoryGetPagedSortedListRequest.static class
User.UserPhoneDirectoryGetSearchedListRequest
Request a table containing the phone directory for a user.static class
User.UserPhoneDirectoryGetSearchedListResponse
Response to UserPhoneDirectoryGetSearchedListRequest.static class
User.UserPortalPasscodeGetInfoRequest
Request the user's portal passcode information.static class
User.UserPortalPasscodeGetInfoResponse
Response to UserPortalPasscodeGetInfoRequest.static class
User.UserPortalPasscodeModifyRequest
Modify the user's Portal passcode The response is either a SuccessResponse or an ErrorResponse.static class
User.UserPortalPasscodeRulesGetRequest
Requests the effective passcode rules setting for a user.static class
User.UserPortalPasscodeRulesGetResponse
Response to UserPortalPasscodeRulesGetRequest.static class
User.UserPrimaryEndpointAdvancedSettingGetRequest
Get the Users Primary Endpoint setting.static class
User.UserPrimaryEndpointAdvancedSettingGetResponse
Response to the UserPrimaryEndpointAdvancedSettingGetRequest.static class
User.UserPrimaryEndpointAdvancedSettingModifyRequest
Modify the Users Primary Endpoint line control settings.static class
User.UserPushNotificationRegistrationDeleteRequest
Request to remove a push notification registration.static class
User.UserPushNotificationRegistrationGetListRequest
Request a table containing all of the push notification registrations for a user by either registration id or user id.static class
User.UserPushNotificationRegistrationGetListResponse
Response to UserPushNotificationRegistrationGetListRequest.static class
User.UserScheduleAddEventRequest
Add an event to user schedule.static class
User.UserScheduleAddRequest
Add a user schedule.static class
User.UserScheduleDeleteEventListRequest
Delete a list of events from a user schedule.static class
User.UserScheduleDeleteListRequest
Delete a list of user schedule.static class
User.UserScheduleGetEventDetailListRequest
Request the list of schedules viewable by a User.static class
User.UserScheduleGetEventDetailListResponse
Response to UserScheduleGetEventRequest.static class
User.UserScheduleGetEventListRequest
Get the list of events of a user schedule.static class
User.UserScheduleGetEventListResponse
Response to UserScheduleGetEventListRequest.static class
User.UserScheduleGetEventRequest
Get an event from a user schedule.static class
User.UserScheduleGetEventResponse
Response to UserScheduleGetEventRequest.static class
User.UserScheduleGetListRequest
Get the list of schedules viewable by a User.static class
User.UserScheduleGetListResponse
Response to UserScheduleGetListRequest17sp1.static class
User.UserScheduleModifyEventRequest
Modify an event of a user schedule.static class
User.UserScheduleModifyRequest
Modify a user schedule.static class
User.UserServiceAssignListRequest
Request to assign the user services and service packs for a user.static class
User.UserServiceGetAssignmentListRequest
Requests the user's service and service pack assignment list with status.static class
User.UserServiceGetAssignmentListResponse
Response to UserServiceGetAssignmentListRequest.static class
User.UserServiceIsAssignedRequest
Request to determine if a UserService or service pack is assigned to the user.static class
User.UserServiceIsAssignedResponse
Returns true if the UserService or service pack is assigned, otherwise false.static class
User.UserServiceUnassignListRequest
Requests to unassign the user services and service packs for a user.static class
User.UserShInterfaceGetPublicIdDataRequest
Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI).static class
User.UserShInterfaceGetPublicIdDataResponse
Response to the UserShInterfaceGetPublicIdDataRequest21sp1.static class
User.UserShInterfaceGetUserIdDataRequest
Returns the Sh non-transparent data stored against a userId.static class
User.UserShInterfaceGetUserIdDataResponse
Response to the UserShInterfaceGetUserIdDataRequest21sp1.static class
User.UserShInterfaceModifyRequest
Modifies the Sh Interface non-transparent data associated with a Public User Identity.static class
User.UserShInterfacePublicIdentityRefreshTaskStartRequest
Dispatches a Public Identity refresh task on the local Application Server node for the specified public identity.static class
User.UserTerminatingAlternateTrunkIdentityGetRequest
Request the user level data associated with Terminating Alternate Trunk Identity.static class
User.UserTerminatingAlternateTrunkIdentityGetResponse
Response to UserTerminatingAlternateTrunkIdentityGetRequest.static class
User.UserTerminatingAlternateTrunkIdentityModifyRequest
Modify the user level data associated with Terminating Alternate Trunk Identity.
-
Field Summary
-
Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser
group, groupId, serviceProvider, serviceProviderId, userId
-
Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
broadWorksServer, populated
-
-
Method Summary
-
Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksUser
getGroup, getGroupId, getServiceProvider, getServiceProviderId, getUserId, getUserId, setGroupId, setServiceProviderId, setUserId
-
Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated
-
-
-
-
Field Detail
-
lastName
protected String lastName
-
firstName
protected String firstName
-
callingLineIdLastName
protected String callingLineIdLastName
-
callingLineIdFirstName
protected String callingLineIdFirstName
-
nameDialingName
protected NameDialingName nameDialingName
-
hiraganaLastName
protected String hiraganaLastName
-
hiraganaFirstName
protected String hiraganaFirstName
-
phoneNumber
protected String phoneNumber
-
extension
protected String extension
-
callingLineIdPhoneNumber
protected String callingLineIdPhoneNumber
-
department
protected DepartmentKey department
-
departmentFullPath
protected String departmentFullPath
-
language
protected String language
-
timeZone
protected String timeZone
-
timeZoneDisplayName
protected String timeZoneDisplayName
-
defaultAlias
protected String defaultAlias
-
alias
protected String[] alias
-
accessDeviceEndpoint
protected AccessDeviceMultipleIdentityAndContactEndpointRead accessDeviceEndpoint
-
trunkAddressing
protected TrunkAddressingMultipleContactRead21sp1 trunkAddressing
-
title
protected String title
-
pagerPhoneNumber
protected String pagerPhoneNumber
-
mobilePhoneNumber
protected String mobilePhoneNumber
-
emailAddress
protected String emailAddress
-
yahooId
protected String yahooId
-
addressLocation
protected String addressLocation
-
address
protected StreetAddress address
-
countryCode
protected String countryCode
-
nationalPrefix
protected String nationalPrefix
-
networkClassOfService
protected String networkClassOfService
-
officeZoneName
protected String officeZoneName
-
primaryZoneName
protected String primaryZoneName
-
impId
protected String impId
-
alternateUserId
protected AlternateUserIdEntry[] alternateUserId
-
resellerId
protected String resellerId
-
-
Constructor Detail
-
User
public User()
Serializable Constructor
-
User
public User(BroadWorksServer broadWorksServer, String userId)
- Parameters:
broadWorksServer
-userId
-
-
-
Method Detail
-
getPopulatedUser
public static User getPopulatedUser(BroadWorksServer broadWorksServer, String userId) throws BroadWorksObjectException
Retrieves a populated User- Parameters:
broadWorksServer
-userId
-- Throws:
BroadWorksObjectException
-
getClassName
public String getClassName()
-
getLastName
public String getLastName()
-
getFirstName
public String getFirstName()
-
getCallingLineIdLastName
public String getCallingLineIdLastName()
-
getCallingLineIdFirstName
public String getCallingLineIdFirstName()
-
setNameDialingName
public User setNameDialingName(NameDialingName nameDialingName)
-
getNameDialingName
public NameDialingName getNameDialingName()
-
getHiraganaLastName
public String getHiraganaLastName()
-
getHiraganaFirstName
public String getHiraganaFirstName()
-
getPhoneNumber
public String getPhoneNumber()
-
getExtension
public String getExtension()
-
setCallingLineIdPhoneNumber
public User setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber)
-
getCallingLineIdPhoneNumber
public String getCallingLineIdPhoneNumber()
-
setDepartment
public User setDepartment(DepartmentKey department)
-
getDepartment
public DepartmentKey getDepartment()
-
getDepartmentFullPath
public String getDepartmentFullPath()
-
getLanguage
public String getLanguage()
-
getTimeZone
public String getTimeZone()
-
getTimeZoneDisplayName
public String getTimeZoneDisplayName()
-
getDefaultAlias
public String getDefaultAlias()
-
getAlias
public String[] getAlias()
-
setAccessDeviceEndpoint
public User setAccessDeviceEndpoint(AccessDeviceMultipleIdentityAndContactEndpointRead accessDeviceEndpoint)
-
getAccessDeviceEndpoint
public AccessDeviceMultipleIdentityAndContactEndpointRead getAccessDeviceEndpoint()
-
setTrunkAddressing
public User setTrunkAddressing(TrunkAddressingMultipleContactRead21sp1 trunkAddressing)
-
getTrunkAddressing
public TrunkAddressingMultipleContactRead21sp1 getTrunkAddressing()
-
getTitle
public String getTitle()
-
getPagerPhoneNumber
public String getPagerPhoneNumber()
-
getMobilePhoneNumber
public String getMobilePhoneNumber()
-
getEmailAddress
public String getEmailAddress()
-
getYahooId
public String getYahooId()
-
getAddressLocation
public String getAddressLocation()
-
setAddress
public User setAddress(StreetAddress address)
-
getAddress
public StreetAddress getAddress()
-
getCountryCode
public String getCountryCode()
-
getNationalPrefix
public String getNationalPrefix()
-
getNetworkClassOfService
public String getNetworkClassOfService()
-
getOfficeZoneName
public String getOfficeZoneName()
-
getPrimaryZoneName
public String getPrimaryZoneName()
-
getImpId
public String getImpId()
-
setAlternateUserId
public User setAlternateUserId(AlternateUserIdEntry... alternateUserId)
-
getAlternateUserId
public AlternateUserIdEntry[] getAlternateUserId()
-
getResellerId
public String getResellerId()
-
populate
public Response populate()
Method to populate the Fields of the Object via the Associated BroadWorks request- Specified by:
populate
in classBroadWorksObject
-
populate
public Response populate(User.UserGetResponse resp)
Method to populate the Fields of the Object via the Associated BroadWorks request- Parameters:
resp
- The response object to perform population
-
equals
public boolean equals(Object obj)
- Overrides:
equals
in classBroadWorksUser
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classBroadWorksUser
-
-