Package co.ecg.alpaca.toolkit.generated
Class Group
java.lang.Object
co.ecg.alpaca.toolkit.model.BroadWorksObject
co.ecg.alpaca.toolkit.generated.Group
- All Implemented Interfaces:
Serializable
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAdd a group administrator.static classRequest to add an alternate admin Id to a group administrator.static classRequest to delete an alternate admin user id of a group administrator.static classRequest to get the admin id and the list of alternate admin ids of an admin.static classResponse to GroupAdminAlternateIdGetListRequest.static classRequest to modify an alternate id of a group admin.static classDelete a group administrator.static classGet a list of group and department administrators within the group.static classResponse to GroupAdminGetListRequest.static classGet a list of group and department administrators within the group.static classResponse to GroupAdminGetPagedSortedListRequest.static classRequests the Group administrator's policy settings.static classResponse to GroupAdminGetPolicyRequestRI.static classGet a group administrators profile.static classResponse to the GroupAdminGetRequest22V3.static classRequests the effective password rules setting for a group administrator.static classResponse to GroupAdministratorPasswordRulesGetRequest.static classRequest to modify the group administrator's policy settings.static classModify a group administrator.static classRequest to get the list of alternate user ids in the group.static classResponse to GroupAlternateUserIdGetListRequest.static classAdd an announcement to the group announcement repository The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId announcementFileExternalId The response is either a SuccessResponse or an ErrorResponse.static classDelete one or more announcements from the group announcement repository The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId announcementFileExternalId The response is either a SuccessResponse or an ErrorResponse.static classGet the list of available announcement files for a Group.static classResponse to GroupAnnouncementFileGetListRequest.static classGet the list of available announcement files for a Group.static classResponse to GroupAnnouncementFileGetPagedSortedListRequest.static classRequest to get the announcement repository file information.static classResponse to GroupAnnouncementFileGetRequest22.static classModify an existing announcement in the group repository The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId The response is either a SuccessResponse or an ErrorResponse.static classReturn the disk space being used.static classResponse to GroupAnnouncementFileGetSettingsRequest.static classGet the Application Server set for a group.static classResponse to the GroupApplicationServerSetGetRequest.static classModify the Application Server set for a group.static classRequests the list of services and service packs assigned to a group.static classResponse to GroupServiceGetAuthorizedListRequest.static classRequest the group level data associated with Call Processing Policy.static classResponse to GroupCallProcessingGetPolicyRequest22V3.static classModify the group level data associated with Call Processing Policy.static classAdd one or more entries to a group's common phone list.static classDelete one or more entries from a group's common phone list.static classGet a group's common phone list.static classResponse to the GroupCommonPhoneListGetListRequest.static classModify an entry in a group's common phone list.static classAdd a list of Communication Barring Authorization codes to a group.static classDelete a list of Communication Barring Authorization codes from a group.static classGet a list of Communication Barring Authorization Codes for a group.static classResponse to GroupCommunicationBarringAuthorizationCodeGetListRequest21sp1.static classRequest the group Communication Barring Authorization Code setting.static classResponse to GroupCommunicationBarringAuthorizationCodeGetRequest.static classModify the group Communication Barring Authorization Code settings The response is either a SuccessResponse or an ErrorResponse.static classGets Communication Barring setting for a group.static classResponse to GroupCommunicationBarringGetRequest.static classGets Communication Barring setting for a group.static classGet the list of all communication barring profiles assigned to the group.static classResponse to the GroupCommunicationBarringProfileGetAssignedListRequest.static classAssign a replacement list of Communication Barring Profiles to a group.static classAdd a group.static classResponse to GroupConsolidatedAddRequest.static classAdds DNs to enterprise and group and activates the DNs on assignment.static classResponse to GroupConsolidatedDnAssignListRequest.static classRebuild the group default config file for the specified device type.static classRebuild the config file for a specified device.static classReorder the lines of a group device.static classReset a specific group device.static classReset all the devices of the specified device type in a group.static classRequest to set a new group default configuration file for a device type.static classAdds a Custom Contact Directory to a group.static classDeletes a Custom Contact Directory to a group.static classGet a list of users that can be part of a custom contact directory.static classResponse to the GroupCustomContactDirectoryGetAvailableUserListRequest17.static classGets the list of Custom Contact Directories for a group.static classResponse to the GroupCustomContactDirectoryGetListRequest.static classGets a Custom Contact Directory in a group.static classResponse to the GroupCustomContactDirectoryGetRequest17.static classAdds a Custom Contact Directory to a group.static classDelete a group.static classAdd a department to a group.static classAdd a department administrator to a group department.static classDelete a group department administrator.static classGet a list of department administrators for the department.static classResponse to GroupDepartmentAdminGetListRequest.static classGet a group department administrators profile.static classResponse to the GroupDepartmentAdminGetRequest22V2.static classModify a group department administrator.static classDelete a department from a group.static classGet a list of departments that could be the parent department of the specified department.static classResponse to GroupDepartmentGetAvailableParentListRequest.static classRequest a list of departments in a group.static classResponse to GroupDepartmentGetListRequest18.static classRequest the attributes of a department.static classResponse to GroupDepartmentGetRequest.static classModify a department of a group.static classRequest the Device Activation policy of a group.static classResponse to GroupDeviceActivationPolicyGetRequest.static classModify the Device Activation policy of a group.static classRequest device management's events for a specific queue.static classResponse to GroupDeviceManagementEventGetListRequest22.static classRequest the number of access device of a particular device type and group.static classResponse to GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupRequest.static classCancel pending and in progress events.static classRequest to add a static configuration tag for an access device type used in a group.static classRequest to delete static configuration tags for an access device type used in a group.static classRequest to get the list of custom configuration tags managed by the Device Management System, on a per-device type basis for a group.static classResponse to GroupDeviceTypeCustomTagGetListRequest.static classRequest to modify a static configuration tag for an access device type used in a group.static classRequest to get the list of device type files managed by the Device Management System, on a per-group basis.static classResponse to GroupDeviceTypeFileGetListRequest21.static classRequest to get a group device type file.static classResponse to GroupDeviceTypeFileGetRequest16sp1.static classRequest to modify a specified device type file for a group.static classRequest to get the custom configuration tag set defined for the group and device type.static classResponse to GroupDeviceTypeTagSetGetRequest.static classRequest to modify a static configuration tag set.static classAdd a new Dialable Caller ID Criteria.static classDelete a Dialable Caller ID Criteria.static classGet an existing Dialable Caller ID Criteria.static classResponse to the GroupDialableCallerIDCriteriaGetRequest.static classModify a Dialable Caller ID Criteria.static classGet the Group's Dialable Caller ID settings and criteria list.static classResponse to the GroupDialableCallerIDGetRequest.static classModify the group's Dialable Caller ID settings and criteria list.static classRequest to add a Group level Dial Plan Access Code and its all attribues.static classRequest to delete a Group level Dial Plan Access Code and its all attribues.static classRequest the Group level data associated with Dial Plan Policy.static classResponse to GroupDialPlanPolicyGetAccessCodeListRequest Contains a table with column headings: "Access Code", "Enable Secondary Dial Tone", "Description"static classRequest access code data associated with Group level Dial Plan Policy access codes.static classResponse to GroupDialPlanPolicyGetAccessCodeRequeststatic classRequest the Group level data associated with Dial Plan Policy.static classResponse to GroupDialPlanPolicyGetRequest22 The following elements are only used in AS data mode: overrideResolvedDeviceDigitMap The following elements are only used in AS data mode and not returned in XS data mode: deviceDigitMapstatic classRequest to modify a Group level Dial Plan Access Code and its attribues.static classModify the Group level data associated with Dial Plan Policy.static classRequest the group's digit collection attributes.static classResponse to GroupDigitCollectionGetRequest13mp4.static classModifies the group's digit collection attributes.static classActivate a list of assigned DNs on a group.static classAssign a list of service provider DNs to a group.static classDeactivate a list of activated DNs on a group.static classGet the list of activated and deactivated DNs in a group.static classResponse to the GroupDnGetActivationListRequest.static classGet the list of assigned and unassigned DNs in a group.static classResponse to the GroupDnGetAssignmentListRequest18.static classGet the list of assigned and unassigned DNs in a group.static classResponse to the GroupDnGetAssignmentPagedSortedListRequest.static classGet the list of DNs that are available to be assigned as user ECBN or group ECBN in group.static classResponse to the GroupDnGetAvailableECBNListRequest.static classGet the list of DNs that are assigned to a group and still available for assignment to users or service instances within the group.static classResponse to the GroupDnGetAvailableListRequest.static classGet a list of group DNs that are not assigned to user, service instances or IMRN pool.static classResponse to the GroupDnGetAvailableRangesListRequest.static classGet the list of DNs that are assigned to a group and still available for assignment to users within the group with the department name, if the DN is assigned to the department.static classResponse to the GroupDnGetDetailedAvailableListRequest.static classGet the list of DNs that are assigned to a group.static classResponse to the GroupDnGetListRequest.static classValidates DNs given in the request The response is GroupDnGetStatusListResponse.static classResponse to GroupDnGetStatusListRequest.static classGet the list of assigned and unassigned DN ranges in a group.static classResponse to the GroupDnGetSummaryListRequest.static classAssign a list of group DNs to a department.static classUnassign a list of service provider DNs from a group.static classAssign a list of domains to a group.static classRequests the list of all domains assigned to a group.static classContains a simple list of all group domain names.static classRequest a list of users within in a group that have a given domain assigned.static classResponse to GroupDomainGetAssignedUserListRequest.static classUnassign a list of domains from a group.static classRequest the group level data associated with Emergency Call Notification.static classResponse to GroupEmergencyCallNotificationGetRequest.static classModify the group level data associated with Emergency Call Notification.static classRequest to search endpoints in the group.static classResponse to GroupEndpointGetListRequest.static classRequest the group level configuration for Exchange Integration.static classResponse to GroupExchangeIntegrationGetRequest.static classModify the group level configuration for Exchange Integration.static classRequest to assign the user services and service packs to all existing users within the group.static classRequests to unassign the user services and service packs for all existing users within the group.static classRequest the group's extension length.static classResponse to GroupExtensionLengthGetRequest22.static classModify the group's extension length range.static classGet group FAC code level and the list of feature access codes for a group.static classResponse to the GroupFeatureAccessCodeGetRequest21.static classModify group FAC code level and the list of feature access codes for a group.static classAdd a new group file repository user.static classDelete a group file repository user.static classRequest the list of group users for a file repository in the system.static classResponse to GroupFileRepositoryDeviceUserGetListRequest.static classModify a group file repository user.static classRequests the list of available leaf devices that can be linked to a tree device within a specific group.static classResponse to GroupGetAvailableLeafDeviceListRequest22.static classRequests the list of available tree devices to which leaf devices can be linked to within a specific group.static classResponse to GroupGetAvailableTreeDeviceListRequest.static classRequest the default profile for a group.static classResponse to the GroupGetDefaultRequest.static classRequest the list of groups in a service provider or enterprise.static classResponse to GroupGetListInServiceProviderPagedSortedListRequest.static classRequest the list of groups in a service provider or enterprise.static classResponse to GroupGetListInServiceProviderRequest.static classRequest the list of groups in the system.static classResponse to GroupGetListInSystemRequest.static classGet the profile for a group.static classResponse to the GroupGetRequest24.static classGet the list of users assigned the user service or service pack.static classReturn a table containing the list of users assigned the user service or service pack.static classAssign a list of group DNs to the IMRN pool.static classRequest a summary table of all DNs in a group IMRN pool.static classResponse to GroupIMRNGetListRequest.static classUnassign a list of group DNs from the group IMRN pool.static classModify the profile for a group.static classAssign a list of Network Classes of Service to a group.static classAssign a Network Classes of Service to all users with in a group.static classGet a list of Network Classes of Service assigned to a group.static classResponse to GroupNetworkClassOfServiceGetAssignedListRequest.static classGet a list of users within a group that have a given Network Class of Service assigned.static classResponse to GroupNetworkClassOfServiceGetAssignedUserListRequest21.static classModifies the default Network Classes of Service of a group.static classUnassign a list of Network Classes of Service from a group.static classRequest to assign the user services and service packs to all new users created within the group after the completion of this request.static classRequests to unassign the user services and service packs for all new users created within the group after the completion of this request.static classAssign a list of Office Zones to a group.static classGet a list of Office Zones assigned to a group.static classResponse to GroupOfficeZoneGetAssignedListRequest.static classGet a list of users within a group that have a given Office Zone assigned.static classResponse to GroupOfiiceZoneGetAssignedUserListRequest.static classUnassign a list of OfficeZones from a group.static classRequests the group's password rules setting that is applicable to users within the group.static classResponse to GroupPasswordRulesGetRequestRI.static classRequest to modify the group's password rules setting that apply to the users within the group.static classRequest a table containing the phone directory for a group.static classResponse to GroupPhoneDirectoryGetPagedSortedListRequest.static classRequests the Group's policy settings.static classResponse to GroupPolicyGetRequest22.static classRequest to modify the policies for a Group.static classRequests the group's passcode rules setting.static classResponse to GroupPortalPasscodeRulesGetRequestRI.static classRequest to modify the group's passcode rules setting.static classAssign a list of route point external systems to a group.static classRequests the list of all Route Point External Systems assigned to a group.static classResponse to the GroupRoutePointExternalSystemGetAssignedListRequest.static classRequest a list of route points within in a group that have a given external system assigned.static classResponse to the GroupRoutePointExternalSystemGetAssignedRoutePointListRequest.static classUnassign a list of route point external systems from a group.static classRequest the routing profile for the group.static classResponse to GroupRoutingProfileGetRequest.static classRequests to modify the routing profile for a group.static classAdd an event to group schedule.static classAdd a group schedule.static classDelete a list of events from a group schedule.static classDelete a list of group schedule.static classGet the list of events of a group schedule.static classResponse to GroupScheduleGetEventDetailListRequest.static classGet the list of events of a group schedule.static classResponse to GroupScheduleGetEventListRequest.static classGet an event from a group schedule.static classResponse to GroupScheduleGetEventRequest.static classGet the list of schedules viewable by a group.static classResponse to GroupScheduleGetListRequest17sp1.static classGet the list of schedules viewable by a group.static classResponse to GroupScheduleGetPagedSortedListRequest.static classModify an event of a group schedule.static classModify a group schedule.static classGet the list of services using a group schedule.static classResponse to GroupScheduleUsageRequest.static classGet the available group security classification list.static classResponse to GroupClassificationCustomizationGetAvailableListRequest.static classAssign one or more group services to the group.static classRequests the group's service authorization status.static classResponse to GroupServiceGetAuthorizationListRequest.static classRequests the group's service authorization information for a specific service or service pack.static classResponse to GroupServiceGetAuthorizationRequest.static classRequests the list of services and service packs authorized to a group.static classResponse to GroupServiceGetAuthorizedListRequest.static classRequest to determine if a GroupService is assigned to the group.static classReturns true if the GroupService is assigned, otherwise false.static classRequests to change the group's service authorization status.static classLookup if the given number is defined in the specified service in the group.static classResponse to the GroupServicePhoneNumberLookupRequest.static classUnassign one or more of the group's assigned services.static classRequest to get the list of devices can be assigned to session admission control group for the group.static classResponse to GroupSessionAdmissionControlGetAvailableDeviceListRequest.static classGet the session admission control capacity for the group.static classResponse to the GroupSessionAdmissionControlGetRequest.static classRequest to add one ore more devices to a group level session admission control group.static classRequest to add a session admission control group for the group.static classRequest to delete one or more devices from a group level session admission control group.static classRequest to delete one or more session admission control groups for the group.static classRequest to get the list of session admission control group for the group.static classResponse to GroupSessionAdmissionControlGroupGetListRequest.static classRequest to get a session admission control group for the group.static classResponse to GroupSessionAdmissionControlGroupGetRequest21sp1V2.static classRequest to modify a session admission control group for the group.static classRequest to modify session admission control capacity for the group.static classReturns a list of all Public User Identities and associated data in a group.static classResponse to the GroupShInterfaceGetUserListRequest21sp1.static classGet Group Stir Shaken service settings.static classResponse to the GroupStirShakenGetRequest23V4.static classModify Group Stir Shaken service settings.static classRequest to get the list of template files used to support a VDM device defined at group level.static classResponse to GroupTemplateOnlyDeviceFileGetListRequest.static classGet the third-party emergency call service settings for the Group.static classResponse to the GroupThirdPartyEmergencyCallingGetRequest22.static classModify the third-party emergency call service settings for the Group.static classRequests the list of available trunk groups within a group.static classResponse to GroupTrunkGroupGetAvailableDetailListRequest.static classGet Group Trunk Group Stir Shaken service settings.static classResponse to the GroupTrunkGroupStirShakenGetRequest23V4.static classModify group trunk group Stir Shaken service settings.static classGet a list of users and the service settings for a Call Forwarding service.static classResponse to the GroupUserCallForwardingSettingsGetListRequest.static classGet a list of users and the default or custom calling plan setting.static classResponse to the GroupUserCallingPlanSettingsGetListRequest.static classGet a list of users and the Call Waiting service status (active or not active).static classResponse to the GroupUserCallWaitingSettingsGetListRequest.static classGet a list of users and their Hoteling Guest service status (active or not active).static classResponse to the GroupUserHotelingGuestSettingsGetListRequest.static classRequest to modify language of the users within a group.static classGet the information for a specified device supporting visual device management.static classResponse to GroupVisualDeviceManagementGetDeviceInfoRequest.static classAssign a group level Xsi policy profile and a list of user Xsi policy profiles to a group.static classGet a list of Xsi policy profile assigned.static classResponse to GroupXsiPolicyProfileGetAssignedListRequest.static classGet a list of user within a group that have a given user Xsi policy profile assigned.static classResponse to GroupXsiPolicyProfileGetAssignedUserListRequest.static classModifies the default Xsi policy profile for a group.static classUnassign a list of Xsi policy profile. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StreetAddressprotected Stringprotected Stringprotected Stringprotected Stringprotected Contactprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Integerprotected IntegerFields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
broadWorksServer, populated -
Constructor Summary
ConstructorsConstructorDescriptionGroup()Serializable ConstructorGroup(ServiceProvider serviceProvider, String groupId) Creates a new GroupGroup(BroadWorksServer broadWorksServer) -
Method Summary
Modifier and TypeMethodDescriptionbooleanRetrieves the list of GroupAccessDevices in the Groupstatic GroupgetPopulatedGroup(ServiceProvider serviceProvider, String groupId) Retrieves a populated GroupReturns a handle on the User's Service ProviderRetrieves the list of Users in the GroupinthashCode()populate()Method to populate the Fields of the Object via the Associated BroadWorks requestMethod to populate the Fields of the Object via the Associated BroadWorks requestsetAddress(StreetAddress address) setCallingLineIdDisplayPhoneNumber(String callingLineIdDisplayPhoneNumber) setCallingLineIdName(String callingLineIdName) setCallingLineIdPhoneNumber(String callingLineIdPhoneNumber) setCallProcessingSliceId(String callProcessingSliceId) setContact(Contact contact) setDefaultDomain(String defaultDomain) setDefaultUserCallingLineIdPhoneNumber(String defaultUserCallingLineIdPhoneNumber) setEmergencyCallbackNumber(String emergencyCallbackNumber) setGroupExternalId(String groupExternalId) setGroupId(String groupId) setGroupName(String groupName) setLocationDialingCode(String locationDialingCode) setPreferredDataCenter(String preferredDataCenter) setProvisioningSliceId(String provisioningSliceId) setResellerId(String resellerId) setServicePolicy(String servicePolicy) setServiceProvider(ServiceProvider serviceProvider) setServiceProviderId(String serviceProviderId) setSubscriberPartition(String subscriberPartition) setTimeZone(String timeZone) setTimeZoneDisplayName(String timeZoneDisplayName) setUserCount(Integer userCount) setUserLimit(Integer userLimit) toString()Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated
-
Field Details
-
defaultDomain
-
userLimit
-
userCount
-
groupName
-
callingLineIdName
-
callingLineIdPhoneNumber
-
emergencyCallbackNumber
-
callingLineIdDisplayPhoneNumber
-
timeZone
-
timeZoneDisplayName
-
locationDialingCode
-
contact
-
address
-
servicePolicy
-
callProcessingSliceId
-
provisioningSliceId
-
subscriberPartition
-
preferredDataCenter
-
resellerId
-
defaultUserCallingLineIdPhoneNumber
-
serviceProviderId
-
groupId
-
groupExternalId
-
-
Constructor Details
-
Group
public Group()Serializable Constructor -
Group
- Parameters:
broadWorksServer-
-
Group
Creates a new Group- Parameters:
serviceProvider-groupId-
-
-
Method Details
-
setServiceProvider
-
getServiceProvider
Returns a handle on the User's Service Provider -
getPopulatedGroup
public static Group getPopulatedGroup(ServiceProvider serviceProvider, String groupId) throws BroadWorksObjectException Retrieves a populated Group- Parameters:
serviceProvider-groupId-- Throws:
BroadWorksObjectException
-
getUsersInGroup
Retrieves the list of Users in the Group- Returns:
- An ArrayList of User objects
-
getGroupAccessDevicesInGroup
Retrieves the list of GroupAccessDevices in the Group- Returns:
- An ArrayList of GroupAccessDevice objects
-
getClassName
-
setDefaultDomain
-
getDefaultDomain
-
setUserLimit
-
getUserLimit
-
setUserCount
-
getUserCount
-
setGroupName
-
getGroupName
-
setCallingLineIdName
-
getCallingLineIdName
-
setCallingLineIdPhoneNumber
-
getCallingLineIdPhoneNumber
-
setEmergencyCallbackNumber
-
getEmergencyCallbackNumber
-
setCallingLineIdDisplayPhoneNumber
-
getCallingLineIdDisplayPhoneNumber
-
setTimeZone
-
getTimeZone
-
setTimeZoneDisplayName
-
getTimeZoneDisplayName
-
setLocationDialingCode
-
getLocationDialingCode
-
setContact
-
getContact
-
setAddress
-
getAddress
-
setServicePolicy
-
getServicePolicy
-
setCallProcessingSliceId
-
getCallProcessingSliceId
-
setProvisioningSliceId
-
getProvisioningSliceId
-
setSubscriberPartition
-
getSubscriberPartition
-
setPreferredDataCenter
-
getPreferredDataCenter
-
setResellerId
-
getResellerId
-
setDefaultUserCallingLineIdPhoneNumber
-
getDefaultUserCallingLineIdPhoneNumber
-
setServiceProviderId
-
getServiceProviderId
-
setGroupId
-
getGroupId
-
setGroupExternalId
-
getGroupExternalId
-
populate
Method to populate the Fields of the Object via the Associated BroadWorks request- Specified by:
populatein classBroadWorksObject
-
populate
Method to populate the Fields of the Object via the Associated BroadWorks request- Parameters:
resp- The response object to perform population
-
equals
-
hashCode
public int hashCode() -
toString
-