Package co.ecg.alpaca.toolkit.generated
Class ServiceProvider
java.lang.Object
co.ecg.alpaca.toolkit.model.BroadWorksObject
co.ecg.alpaca.toolkit.generated.ServiceProvider
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
Enterprise
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Add a service provider or enterprise.static class
Add a service provider administrator.static class
Request to add an alternate admin Id to a service provider administrator.static class
Request to delete an alternate admin user id of a user.static class
Request to get the admin id and the list of alternate admin ids of an admin.static class
Response to ServiceProviderAdminAlternateIdGetListRequest.static class
Request to modify an alternate id of a service provider admin.static class
Delete a service provider administrator.static class
Get a list of service provider administrators.static class
Response to ServiceProviderAdminGetListRequest14.static class
Get a list of service provider administrators.static class
Response to ServiceProviderAdminGetPagedSortedListRequest.static class
Requests the service provider administrator's policy settings.static class
Response to ServiceProviderAdminGetPolicyRequest20.static class
Get a service provider administrators profile.static class
Response to the ServiceProviderAdminGetRequest21sp1.static class
Requests the effective password rules setting for a service provider administrator The response is either ServiceProviderAdministratorPasswordRulesGetResponse or ErrorResponse.static class
Response to ServiceProviderAdministratorPasswordRulesGetRequest.static class
Request to modify the service provider administrator's policy settings.static class
Modify a service provider administrator.static class
Get a service provider or enterprise's answer confirmation settings.static class
Response to the ServiceProviderAnswerConfirmationGetRequest16.static class
Modify a service provider or enterprise's answer confirmation settings.static class
Get the Application Server set for a service provider or enterprise.static class
Response to the ServiceProviderApplicationServerSetGetRequest.static class
Modify the Application Server set assigned to the service provider or enterprise.static class
Request the service provider level data associated with Call Processing Policy.static class
Response to ServiceProviderCallProcessingGetPolicyRequest22V3.static class
Modify the service provider level data associated with Call Processing Policy.static class
Assign a list of Communication Barring Criteria to a service provider.static class
Get a list of Communication Barring Criteria assigned to a service provider.static class
Response to ServiceProviderCommunicationBarringCriteriaGetAssignedListRequest.static class
Unassign a list of Communication Barring Criteria from a service provider.static class
Add a new Communication Barring Digit Pattern Criteria.static class
Delete an existing Communication Barring Digit Pattern Criteria.static class
Get the list of all Digit Pattern Criteria defined for the service provider.static class
Response to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetListRequest.static class
Get an existing Digit Pattern Criteria.static class
Response to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest.static class
Get an existing Digit Pattern Criteria.static class
Response to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetRequest.static class
Modify an existing Communication Barring Digit Pattern Criteria.static class
Assign a list of Communication Barring Incoming Criteria to a service provider.static class
Get a list of Communication Barring Incoming Criteria assigned to a service provider.static class
Response to ServiceProviderCommunicationBarringIncomingCriteriaGetAssignedListRequest.static class
Unassign a list of Communication Barring Incoming Criteria from a service provider.static class
Add a new Communication Barring Profile.static class
Deletes an existing Communication Barring Profile.static class
Get a list of groups within a service provider that have a given Communication Barring Profile assigned.static class
Response to ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest.static class
Get a list of Communication Barring profiles within a service provider that have a given Communication Barring Criteria assigned.static class
Response to ServiceProviderCommunicationBarring ProfileGetCriteriaUsageListRequest.static class
Get the list of Profiles that use a specific Digit Pattern Criteria.static class
Response to the ServiceProviderCommunicationBarringProfileGetDigitPatternCriteriaUsageListRequest.static class
Get a list of Communication Barring profiles within a service provider that have a given Communication Barring Incoming Criteria assigned.static class
Response to ServiceProviderCommunicationBarringProfileGetIncomingCriteriaUsageListRequest.static class
Get the list of all Communication Barring Profiles.static class
Response to the ServiceProviderCommunicationBarringProfileGetListRequest.static class
Get an existing Communication Barring Profile.static class
Response to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2.static class
Modifies the default Communication Barring Profile of a Service Provider.static class
Modify an existing Communication Barring Profile.static class
Add a service provider or enterprise.static class
Rebuild the service provider default config file for the specified device type.static class
Rebuild the config file for a specified device.static class
Reorder the lines of a Service Provider device.static class
Reset a specific service provider or enterprise device.static class
Reset all the devices of the specified device type in a service provider.static class
Request to set a new service provider default configuration file for a device type.static class
Delete a service provider or enterprise.static class
Request the Device Activation policy of a service provider or an enterprise.static class
Response to ServiceProviderDeviceActivationPolicyGetRequest.static class
Modify the Device Activation policy of a service provider or an enterprise.static class
Request device management's events for a specific queue.static class
Response to ServiceProviderDeviceManagementEventGetListRequest22.static class
Request the number of access device of a particular device type and service provider.static class
Response to ServiceProviderDeviceManagementGetAccessDeviceCountForDeviceTypeServiceProviderRequest.static class
Cancel pending and in progress events.static class
Request to get the service provider level device profile authentication password rule settings.static class
Response to ServiceProviderDeviceProfileAuthenticationPasswordRulesGetRequest.static class
Request to modify the service provider level device profile authentication password rule settings.static class
Request to add a static configuration tag for an access device type used in a service provider.static class
Request to delete static configuration tags for an access device type used in a service provider.static class
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device type basis for a service provider.static class
Response to ServiceProviderDeviceTypeCustomTagGetListRequest.static class
Request to modify a static configuration tag for an access device type used in a service provider.static class
Request to get the list of device type files managed by the Device Management System, on a per-service provider basis.static class
Response to ServiceProviderDeviceTypeFileGetListRequest.static class
Request to get a service provider device type file.static class
Response to ServiceProviderDeviceTypeFileGetRequest.static class
Request to modify a specified device type file for a service provider.static class
Request to get the custom configuration tag set defined for the service provider and device type.static class
Response to ServiceProviderDeviceTypeGetRequest.static class
Request to modify a static configuration tag set.static class
Add a new Dialable Caller ID Criteria.static class
Delete a Dialable Caller ID Criteria.static class
Get an existing Dialable Caller ID Criteria.static class
Response to the ServiceProviderDialableCallerIDCriteriaGetRequest.static class
Modify a Dialable Caller ID Criteria.static class
Get the service provider?s Dialable Caller ID settings and criteria list.static class
Response to the ServiceProviderDialableCallerIDGetRequest.static class
Modify the service provider?s Dialable Caller ID settings and criteria list.static class
Request to add a Service Provider level Dial Plan Access Code and its all attribues.static class
Request to delete a Service Provider level Dial Plan Access Code and its all attribues.static class
Request the Service Provider level data associated with Dial Plan Policy.static class
Response to ServiceProviderDialPlanPolicyGetAccessCodeListRequest.static class
Request access code data associated with Service Provider level Dial Plan Policy access codes.static class
Response to ServiceProviderDialPlanPolicyGetAccessCodeRequeststatic class
Request the Service Provider level data associated with Dial Plan Policy.static class
Response to ServiceProviderDialPlanPolicyGetRequest22 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 class
Request to modify a Service Provider level Dial Plan Access Code and its attribues.static class
Modify the Service Provider level data associated with Dial Plan Policy.static class
Request the service provider's digit collection attributes.static class
Response to ServiceProviderDigitCollectionGetRequest13mp4.static class
Modifies the service provider's digit collection attributes.static class
Adds DNs to a service provider.static class
Deletes DNs from a service provider.static class
Request a list of available DNs not yet assigned to any group.static class
Response to ServiceProviderDnGetAvailableListRequest.static class
Validates DNs given in the request The response is ServiceProviderDnGetStatusListResponse.static class
Response to ServiceProviderDnGetStatusListRequest.static class
Request a summary table of all DNs in a service provider.static class
Response to ServiceProviderDnGetSummaryListRequest.static class
Assign a list of domains to a service provider.static class
Requests a list of groups within a service provider that have a given domain assigned.static class
Response to ServiceProviderDomainGetAssignedGroupListRequest.static class
Requests the list of all matching domains assigned to a service provider .static class
Contains a simple list of service provider domain names.static class
Unassign a list of domains from a service provider.static class
Request the service provider level data associated with Emergency Call Notification.static class
Response to ServiceProviderEmergencyCallNotificationGetRequest.static class
Modify the service provider or enterprise level data associated with Emergency Call Notification.static class
Request to search endpoints in the service provider/enterprise.static class
Response to ServiceProviderEndpointGetListRequest.static class
Request the service provider's extension length.static class
Response to ServiceProviderExtensionLengthGetRequest.static class
Modify the service provider's extension length range.static class
Get the list of feature access codes for a service provider or enterprise.static class
Response to the ServiceProviderFeatureAccessCodeGetListRequest21.static class
Modify a list of feature access codes for a service provider or enterprise.static class
Add a new service provider file repository user.static class
Delete a service provider file repository user.static class
Request the list of service provider users for a file repository in the system.static class
Response to ServiceProviderFileRepositoryDeviceUserGetListRequest.static class
Modify a service provider file repository user.static class
Request the default profile for a service provider or enterprise.static class
Response to the ServiceProviderGetDefaultRequest.static class
Request a list of service providers and/or enterprises in the system.static class
Response to ServiceProviderGetListRequest.static class
Request a list of service providers and/or enterprises in the system.static class
Response to ServiceProviderGetPagedSortedListRequest.static class
Get the profile for a service provider or enterprise.static class
Response to the ServiceProviderGetRequest22V4.static class
Request to get the Alternate Carrier Selection parameters.static class
Response to the ServiceProviderHPBXAlternateCarrierSelectionGetRequest.static class
Request to modify the Alternate Carrier Selection parameters.static class
Assign a list of service provider DNs to the IMRN pool.static class
Returns a list of dns or dn ranges in a service provider IMRN pool.static class
Response to ServiceProviderIMRNGetListRequest.static class
Unassign a list of service provider DNs from the service provider IMRN pool.static class
Request to add a language for a service provder.static class
Request to delete a language from a service provider supported languages.static class
Request the list of languages that a user or admin in a service provider is allowed to use.static class
Response to ServiceProviderLanguageGetAvailableListRequest.static class
Request the defined languages for a service provider.static class
Response to ServiceProviderLanguageGetListRequest.static class
Request to modify a language properties for a service provider/enterprise.static class
Modify the profile for a service provider or enterprise.static class
Assign a list of Network Classes of Service to a service provider.static class
Assign a list of Network Classes of Service to all groups with in a service provider.static class
Assign a Network Classes of Service to all users with in a service provider.static class
Get a list of groups within a service provider that have a given Network Class of Service assigned.static class
Response to ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest.static class
Get a list of Network Classes of Service assigned to a service provider.static class
Response to ServiceProviderNetworkClassOfServiceGetAssignedListRequest.static class
Modifies the default Network Classes of Service of a Service Provider.static class
Unassign a list of Network Classes of Service from a service provider.static class
Add a list of the Service Provider Number Portability Query Digit Patterns.static class
Request to get the Service Provider Number Portability Query Digit Pattern Trigger List information.static class
Response to the ServiceProviderNumberPortabilityQueryGetRequest.static class
Modify the Service Provider Number Portability Query information.static class
Assign a list of Office Zones to a service provider.static class
Get a list of groups within a service provider that have a given Office Zone assigned.static class
Response to ServiceProviderOfficeZoneGetAssignedGroupListRequest.static class
Get a list of Office Zones assigned to a service provider.static class
Response to ServiceProviderOfficeZoneGetAssignedListRequest.static class
Unassign a list of OfficeZones from a service provider.static class
Requests the service provider's password rules setting applicable to Administrators (Group and Department) and Users.static class
Response to ServiceProviderPasswordRulesGetRequest22.static class
Request to modify the service provider's password rules settings setting applicable to Administrators (Group and Department) and Users.static class
Requests the service provider's passcode rules setting.static class
Response to ServiceProviderPortalPasscodeRulesGetRequest19.static class
Request to modify the service provider's passcode rules setting.static class
Assign a list of route point external systems to a service provider.static class
Requests a list of groups within a service provider that have a given external system assigned.static class
Response to ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest.static class
Requests the list of all Route Point External Systems assigned to a service provider.static class
Response to the ServiceProviderRoutePointExternalSystemGetAssignedListRequest.static class
Unassign a list of route point external systems from a service provider.static class
Request the routing profile for the service provider/enterprise.static class
Response to ServiceProviderRoutingProfileGetRequest.static class
Requests to modify the routing profile for a service provider.static class
Add an event to service provider schedule.static class
Add a service provider schedule.static class
Delete a list of events from a service provider schedule.static class
Delete a list of service provider schedule.static class
Get the list of events of a service provider schedule.static class
Response to ServiceProviderScheduleGetEventDetailListRequest.static class
Get the list of events of a service provider schedule.static class
Response to ServiceProviderScheduleGetEventListRequest.static class
Get an event from a service provider schedule.static class
Response to ServiceProviderScheduleGetEventRequest.static class
Get the list of a service provider schedules.static class
Response to ServiceProviderScheduleGetListRequest.static class
Modify an event of a service provider schedule.static class
Modify a service provider schedule.static class
Requests the service provider's service authorization status.static class
Response to ServiceProviderServiceGetAuthorizationListRequest.static class
Requests the service provider's service authorization information for a specific service or service pack.static class
Response to ServiceProviderServiceGetAuthorizationRequest.static class
Requests the list of all user services assignable to users in the specified service provider.static class
Response to ServiceProviderServiceGetUserAssignableListRequest.static class
Requests to change the service provider's service authorization status.static class
Request to add a service pack to a service provider.static class
Request to add services to a service pack if the pack has not been authorized to a group.static class
Request to delete a service pack from a service provider.static class
Request to get a service pack details.static class
Response to ServiceProviderServicePackGetDetailListRequest.static class
Request to get a list of defined service packs for a service provider.static class
Response to ServiceProviderServicePackGetListRequest.static class
Request to get the list of service packs containing a specified service.static class
Response to ServiceProviderServicePackGetServiceUsageListRequest.static class
Request to get the service pack utilization for a service provider.static class
Response to ServiceProviderServicePackGetUtilizationListRequest.static class
Create a service pack migration task.static class
Makes a copy of one or more existing service pack migration tasks.static class
Deletes a service pack migration task.static class
Requests a list of groups to migrate.static class
Response to ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest.static class
Requests a list of all service pack migration tasks for a service provider.static class
Response to ServiceProviderServicePackMigrationTaskGetListRequest21.static class
Requests the details of a specified service pack migration task.static class
Response to ServiceProviderServicePackMigrationTaskGetRequest21.static class
Replace the list of services and packs to be assigned to users during the service pack migration.static class
Replace the list of groups to be migrated for a specified service pack migration task.static class
Replace the list of services and packs to be removed from users during the service pack migration.static class
Modify the properties of a specified service pack migration task.static class
Replace the list of services and packs used to select which users will be migrated.static class
Terminates a service pack migration task that is currently executing.static class
Requests to modify a service pack for a service provider.static class
Lookup if the given number is defined in the specified service in the service provider.static class
Response to the ServiceProviderServicePhoneNumberLookupRequest.static class
Get the session admission control capacity for the service provider.static class
Response to the ServiceProviderSessionAdmissionControlGetRequest.static class
Request to modify session admission control capacity for the service provider.static class
Request to get the Service Provider Session Admission White List information.static class
Response to the ServiceProviderSessionAdmissionControlWhiteListGetRequest.static class
Modify the Service Provider Session Admission Control White List information.static class
Request to get the service provider level SIP authentication password rule settings.static class
Response to ServiceProviderSIPAuthenticationPasswordRulesGetRequest.static class
Request to modify the service provider level SIP authentication password rule settings.static class
Get service provider Stir Shaken service settings.static class
Response to the ServiceProviderStirShakenGetRequest.static class
Modify service provider Stir Shaken service settings.static class
Get the third-party emergency call service settings for the service provider.static class
Response to the ServiceProviderThirdPartyEmergencyCallingGetRequest.static class
Modify the third-party emergency call service settings for the service provider.static class
Assign a list of group and user Xsi policy profile to a service provider.static class
Get a list of group within a service provider that have a given group Xsi policy profile assigned.static class
Response to ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest.static class
Get a list of Xsi policy profile assigned.static class
Response to ServiceProviderXsiPolicyProfileGetAssignedListRequest.static class
Modifies the default Xsi policy profile for a service provider.static class
Unassign a list of Xsi policy profile. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StreetAddress
protected String
protected Contact
protected String
protected Boolean
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected String
protected Boolean
protected Boolean
Fields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
broadWorksServer, populated
-
Constructor Summary
ConstructorsModifierConstructorDescriptionSerializable Constructorprotected
ServiceProvider
(BroadWorksServer broadWorksServer) ServiceProvider
(BroadWorksServer broadWorksServer, String serviceProviderId) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Retrieves a list of Groups in the ServiceProvider.static ServiceProvider
getPopulatedServiceProvider
(BroadWorksServer broadWorksServer, String serviceProviderId) Retrieves a populated ServiceProviderint
hashCode()
boolean
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) setCallProcessingSliceId
(String callProcessingSliceId) setContact
(Contact contact) setDefaultDomain
(String defaultDomain) setPreferredDataCenter
(String preferredDataCenter) setProvisioningSliceId
(String provisioningSliceId) setResellerId
(String resellerId) setServicePolicy
(String servicePolicy) setServiceProviderExternalId
(String serviceProviderExternalId) setServiceProviderId
(String serviceProviderId) setServiceProviderName
(String serviceProviderName) setSubscriberPartition
(String subscriberPartition) setSupportEmail
(String supportEmail) setUseCustomRoutingProfile
(Boolean useCustomRoutingProfile) setUseServiceProviderLanguages
(Boolean useServiceProviderLanguages) toString()
Methods inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
getBroadWorksServer, hasPopulated, isPopulated, setBroadWorksServer, setPopulated
-
Field Details
-
isEnterprise
-
useCustomRoutingProfile
-
defaultDomain
-
serviceProviderName
-
supportEmail
-
contact
-
address
-
useServiceProviderLanguages
-
servicePolicy
-
callProcessingSliceId
-
provisioningSliceId
-
subscriberPartition
-
preferredDataCenter
-
resellerId
-
serviceProviderId
-
serviceProviderExternalId
-
-
Constructor Details
-
ServiceProvider
public ServiceProvider()Serializable Constructor -
ServiceProvider
- Parameters:
broadWorksServer
-
-
ServiceProvider
- Parameters:
broadWorksServer
-serviceProviderId
-
-
-
Method Details
-
getPopulatedServiceProvider
public static ServiceProvider getPopulatedServiceProvider(BroadWorksServer broadWorksServer, String serviceProviderId) throws BroadWorksObjectException Retrieves a populated ServiceProvider- Parameters:
broadWorksServer
-serviceProviderId
-- Throws:
BroadWorksObjectException
-
getGroupsInServiceProvider
Retrieves a list of Groups in the ServiceProvider. The Groups are not populated by default.- Returns:
- A
List
of Groups
-
getClassName
-
setFlagIsEnterprise
-
isEnterpriseFlagExist
public boolean isEnterpriseFlagExist() -
getIsEnterprise
-
setUseCustomRoutingProfile
-
getUseCustomRoutingProfile
-
setDefaultDomain
-
getDefaultDomain
-
setServiceProviderName
-
getServiceProviderName
-
setSupportEmail
-
getSupportEmail
-
setContact
-
getContact
-
setAddress
-
getAddress
-
setUseServiceProviderLanguages
-
getUseServiceProviderLanguages
-
setServicePolicy
-
getServicePolicy
-
setCallProcessingSliceId
-
getCallProcessingSliceId
-
setProvisioningSliceId
-
getProvisioningSliceId
-
setSubscriberPartition
-
getSubscriberPartition
-
setPreferredDataCenter
-
getPreferredDataCenter
-
setResellerId
-
getResellerId
-
setServiceProviderId
-
getServiceProviderId
-
setServiceProviderExternalId
-
getServiceProviderExternalId
-
populate
Method to populate the Fields of the Object via the Associated BroadWorks request- Specified by:
populate
in 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
-