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 classUser.UserAccessDeviceFileGetListRequestRequest to get the list of Device Management user modifiable files.static classUser.UserAccessDeviceFileGetListResponseResponse to UserAccessDeviceFileGetListRequest.static classUser.UserAccessDeviceFileGetRequestRequest to get a user modifiable file.static classUser.UserAccessDeviceFileGetResponseResponse to UserAccessDeviceFileGetRequest.static classUser.UserAccessDeviceFileModifyRequestRequest to modify a user modifiable access device file.static classUser.UserAccessDeviceResetRequestReset a specific user SIP device that supports the reset operation.static classUser.UserAccessDeviceTagsGetRequestRequest to get all the device tag names and values for a specific device.static classUser.UserAccessDeviceTagsGetResponseResponse to UserAccessDeviceTagsGetRequest.static classUser.UserAddRequestRequest to add a user.static classUser.UserAlternateUserIdAddRequestRequest to add an alternate user Id to an user.static classUser.UserAlternateUserIdDeleteRequestRequest to delete an alternate user id of a user.static classUser.UserAlternateUserIdGetListRequestRequest to get the user id and the list of alternate user ids of an user.static classUser.UserAlternateUserIdGetListResponseResponse to UserAlternateUserIdGetListRequest.static classUser.UserAlternateUserIdModifyRequestRequest to modify an alternate user id of a user.static classUser.UserAnnouncementFileAddRequestAdd an announcement to the user announcement repository The response is either a SuccessResponse or an ErrorResponse.static classUser.UserAnnouncementFileDeleteListRequestDelete one or more announcements from the user announcement repository The response is either a SuccessResponse or an ErrorResponse.static classUser.UserAnnouncementFileGetAvailableListRequestGet 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 classUser.UserAnnouncementFileGetAvailableListResponseResponse to UserAnnouncementFileGetAvailableListRequest.static classUser.UserAnnouncementFileGetListRequestGet 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 classUser.UserAnnouncementFileGetListResponseResponse to UserAnnouncementFileGetListRequest.static classUser.UserAnnouncementFileGetRequestRequest to get the announcement repository file information.static classUser.UserAnnouncementFileGetResponseResponse to UserAnnouncementFileGetRequest.static classUser.UserAnnouncementFileModifyRequestThis 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 classUser.UserAnnouncementRepositoryGetSettingsRequestReturn the disk space being used.static classUser.UserAnnouncementRepositoryGetSettingsResponseResponse to UserAnnouncementRepositoryGetSettingsRequest.static classUser.UserAssignedServicesGetListRequestGet the list of assigned User and Group Services for the specified user.static classUser.UserAssignedServicesGetListResponseResponse to UserAssignedServicesGetListRequest.static classUser.UserCallLogsClearRequestClear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features.static classUser.UserCallPoliciesGetRequestRequest the user level data associated with Call Policies.static classUser.UserCallPoliciesGetResponseResponse to UserCallPoliciesGetRequest19sp1.static classUser.UserCallPoliciesModifyRequestModify the user level data associated with Call Policies.static classUser.UserCallProcessingGetPolicyRequestRequest the user level data associated with Call Processing Policy.static classUser.UserCallProcessingGetPolicyResponseResponse to UserCallProcessingGetPolicyRequest22.static classUser.UserCallProcessingModifyPolicyRequestModify the user level data associated with Call Processing Policy.static classUser.UserCommunicationBarringAuthorizationCodeAddListRequestAdd a list of Communication Barring Authorization codes to a user.static classUser.UserCommunicationBarringAuthorizationCodeDeleteListRequestDelete a list of Communication Barring Authorization codes from a user.static classUser.UserCommunicationBarringAuthorizationCodeGetListRequestGet a list of Communication Barring Authorization Code for a user.static classUser.UserCommunicationBarringAuthorizationCodeGetListResponseResponse to UserCommunicationBarringAuthorizationCodeGetListRequest.static classUser.UserCommunicationBarringGetRequestGets the Communication Barring settings for a user.static classUser.UserCommunicationBarringGetResponseResponse to UserCommunicationBarringGetRequest.static classUser.UserCommunicationBarringModifyRequestModify the Communication Barring settings for a user.static classUser.UserConsolidatedAddRequestRequest to add a user.static classUser.UserConsolidatedDeleteRequestRequest to delete a user.static classUser.UserDeleteRequestRequest to delete a user.static classUser.UserDevicePoliciesGetRequestRequest the user level data associated with Device Policy.static classUser.UserDevicePoliciesGetResponseResponse to UserDevicePoliciesGetRequest21.static classUser.UserDevicePoliciesModifyRequestModify the user level data associated with Device Policy.static classUser.UserDnGetActivationListRequestRequest to get a list of DNs associated with a user and their activation state.static classUser.UserDnGetActivationListResponseResponse to UserDnGetActivationListRequest.static classUser.UserEnterpriseCommonPhoneListGetPagedSortedListRequestGet an enterprise's common phone list for a user.static classUser.UserEnterpriseCommonPhoneListGetPagedSortedListResponseResponse to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest.static classUser.UserFeatureAccessCodeGetListRequestGet the list of feature access codes for a user.static classUser.UserFeatureAccessCodeGetListResponseResponse to the UserFeatureAccessCodeGetListRequest21.static classUser.UserFeatureAccessCodeModifyListRequestEnable or disable a list of feature access codes for a user.static classUser.UserGetListInGroupRequestRequest the list of users in a group.static classUser.UserGetListInGroupResponseResponse to UserGetListInGroupRequest.static classUser.UserGetListInServiceProviderRequestRequest the list of users in a service provider or enterprise.static classUser.UserGetListInServiceProviderResponseResponse to UserGetListInServiceProviderRequest.static classUser.UserGetListInSystemRequestRequest the list of users in the system.static classUser.UserGetListInSystemResponseResponse to UserGetListInSystemRequest.static classUser.UserGetRegistrationListRequestRequest to get a list of registrations for a user.static classUser.UserGetRegistrationListResponseResponse to UserGetRegistrationListRequest.static classUser.UserGetRequestRequest to get the user information.static classUser.UserGetResponseResponse to UserGetRequest22V3.static classUser.UserGetServiceInstanceListInServiceProviderRequestRequest the list of Service Instances in a service provider or an enterprise.static classUser.UserGetServiceInstanceListInServiceProviderResponseResponse to UserGetServiceInstanceListInServiceProviderRequest.static classUser.UserGetServiceInstanceListInSystemRequestRequest the list of Service Instances in the system.static classUser.UserGetServiceInstanceListInSystemResponseResponse to UserGetServiceInstanceListInSystemRequest.static classUser.UserGroupCommonPhoneListGetPagedSortedListRequestGet a user's group's common phone list.static classUser.UserGroupCommonPhoneListGetPagedSortedListResponseResponse to the UserGroupCommonPhoneListGetPagedSortedListRequest.static classUser.UserGroupCustomContactDirectoryGetPagedSortedListRequestGets a Custom Contact Directory in a group.static classUser.UserGroupCustomContactDirectoryGetPagedSortedListResponseResponse to the UserGroupCustomContactDirectoryGetPagedSortedListRequest.static classUser.UserLinePortGetListRequestRequest to get all user's configured line ports.static classUser.UserLinePortGetListResponseResponse to UserLinePortGetListRequest.static classUser.UserModifyRequestRequest to modify a user.static classUser.UserModifyUserIdRequestModify the user id of a real or virtual user.static classUser.UserNetworkConferencingGetRequestRequest the Network-Based Conferencing data for a specified user.static classUser.UserNetworkConferencingGetResponseResponse to UserNetworkConferencingGetRequest.static classUser.UserOCICallControlApplicationGetListRequestGet the OCI call control application list that can be used by the user.static classUser.UserOCICallControlApplicationGetListResponseResponse to UserOCICallControlApplicationGetListRequest.static classUser.UserOCICallControlApplicationModifyRequestModify which OCI Call Control Applications are enabled on a user The response is either SuccessResponse or ErrorResponse.static classUser.UserPasswordInfoGetRequestRequest the user's Web password information.static classUser.UserPasswordInfoGetResponseResponse to UserPasswordInfoGetRequest.static classUser.UserPersonalPhoneListAddListRequestAdd one or more entries to a user's personal phone list.static classUser.UserPersonalPhoneListDeleteListRequestDelete one or more entries from a user's personal phone list.static classUser.UserPersonalPhoneListGetListRequestGet a user's personal phone list.static classUser.UserPersonalPhoneListGetListResponseResponse to the UserPersonalPhoneListGetListRequest.static classUser.UserPersonalPhoneListGetPagedSortedListRequestGet a user's personal phone list.static classUser.UserPersonalPhoneListGetPagedSortedListResponseResponse to the UserPersonalPhoneListGetPagedSortedListRequest.static classUser.UserPersonalPhoneListModifyRequestModify an entry in a user's personal phone list.static classUser.UserPhoneDirectoryGetListRequestRequest a table containing the phone directory for a user's group.static classUser.UserPhoneDirectoryGetListResponseResponse to UserPhoneDirectoryGetListRequest.static classUser.UserPhoneDirectoryGetPagedListRequestRequest a table containing the phone directory for a user.static classUser.UserPhoneDirectoryGetPagedListResponseResponse to UserPhoneDirectoryGetPagedListRequest.static classUser.UserPhoneDirectoryGetPagedSortedListRequestRequest a table containing the phone directory for a user.static classUser.UserPhoneDirectoryGetPagedSortedListResponseResponse to UserPhoneDirectoryGetPagedSortedListRequest.static classUser.UserPhoneDirectoryGetSearchedListRequestRequest a table containing the phone directory for a user.static classUser.UserPhoneDirectoryGetSearchedListResponseResponse to UserPhoneDirectoryGetSearchedListRequest.static classUser.UserPortalPasscodeGetInfoRequestRequest the user's portal passcode information.static classUser.UserPortalPasscodeGetInfoResponseResponse to UserPortalPasscodeGetInfoRequest.static classUser.UserPortalPasscodeModifyRequestModify the user's Portal passcode The response is either a SuccessResponse or an ErrorResponse.static classUser.UserPortalPasscodeRulesGetRequestRequests the effective passcode rules setting for a user.static classUser.UserPortalPasscodeRulesGetResponseResponse to UserPortalPasscodeRulesGetRequest.static classUser.UserPrimaryEndpointAdvancedSettingGetRequestGet the Users Primary Endpoint setting.static classUser.UserPrimaryEndpointAdvancedSettingGetResponseResponse to the UserPrimaryEndpointAdvancedSettingGetRequest.static classUser.UserPrimaryEndpointAdvancedSettingModifyRequestModify the Users Primary Endpoint line control settings.static classUser.UserPushNotificationRegistrationDeleteRequestRequest to remove a push notification registration.static classUser.UserPushNotificationRegistrationGetListRequestRequest a table containing all of the push notification registrations for a user by either registration id or user id.static classUser.UserPushNotificationRegistrationGetListResponseResponse to UserPushNotificationRegistrationGetListRequest.static classUser.UserScheduleAddEventRequestAdd an event to user schedule.static classUser.UserScheduleAddRequestAdd a user schedule.static classUser.UserScheduleDeleteEventListRequestDelete a list of events from a user schedule.static classUser.UserScheduleDeleteListRequestDelete a list of user schedule.static classUser.UserScheduleGetEventDetailListRequestRequest the list of schedules viewable by a User.static classUser.UserScheduleGetEventDetailListResponseResponse to UserScheduleGetEventRequest.static classUser.UserScheduleGetEventListRequestGet the list of events of a user schedule.static classUser.UserScheduleGetEventListResponseResponse to UserScheduleGetEventListRequest.static classUser.UserScheduleGetEventRequestGet an event from a user schedule.static classUser.UserScheduleGetEventResponseResponse to UserScheduleGetEventRequest.static classUser.UserScheduleGetListRequestGet the list of schedules viewable by a User.static classUser.UserScheduleGetListResponseResponse to UserScheduleGetListRequest17sp1.static classUser.UserScheduleModifyEventRequestModify an event of a user schedule.static classUser.UserScheduleModifyRequestModify a user schedule.static classUser.UserServiceAssignListRequestRequest to assign the user services and service packs for a user.static classUser.UserServiceGetAssignmentListRequestRequests the user's service and service pack assignment list with status.static classUser.UserServiceGetAssignmentListResponseResponse to UserServiceGetAssignmentListRequest.static classUser.UserServiceIsAssignedRequestRequest to determine if a UserService or service pack is assigned to the user.static classUser.UserServiceIsAssignedResponseReturns true if the UserService or service pack is assigned, otherwise false.static classUser.UserServiceUnassignListRequestRequests to unassign the user services and service packs for a user.static classUser.UserShInterfaceGetPublicIdDataRequestReturns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI).static classUser.UserShInterfaceGetPublicIdDataResponseResponse to the UserShInterfaceGetPublicIdDataRequest21sp1.static classUser.UserShInterfaceGetUserIdDataRequestReturns the Sh non-transparent data stored against a userId.static classUser.UserShInterfaceGetUserIdDataResponseResponse to the UserShInterfaceGetUserIdDataRequest21sp1.static classUser.UserShInterfaceModifyRequestModifies the Sh Interface non-transparent data associated with a Public User Identity.static classUser.UserShInterfacePublicIdentityRefreshTaskStartRequestDispatches a Public Identity refresh task on the local Application Server node for the specified public identity.static classUser.UserTerminatingAlternateTrunkIdentityGetRequestRequest the user level data associated with Terminating Alternate Trunk Identity.static classUser.UserTerminatingAlternateTrunkIdentityGetResponseResponse to UserTerminatingAlternateTrunkIdentityGetRequest.static classUser.UserTerminatingAlternateTrunkIdentityModifyRequestModify 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:
populatein 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:
equalsin classBroadWorksUser
-
hashCode
public int hashCode()
- Overrides:
hashCodein classBroadWorksUser
-
-