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 classAdd a service provider or enterprise.static classAdd a service provider administrator.static classRequest to add an alternate admin Id to a service provider administrator.static classRequest to delete an alternate admin user id of a user.static classRequest to get the admin id and the list of alternate admin ids of an admin.static classResponse to ServiceProviderAdminAlternateIdGetListRequest.static classRequest to modify an alternate id of a service provider admin.static classDelete a service provider administrator.static classGet a list of service provider administrators.static classResponse to ServiceProviderAdminGetListRequest14.static classGet a list of service provider administrators.static classResponse to ServiceProviderAdminGetPagedSortedListRequest.static classRequests the service provider administrator's policy settings.static classResponse to ServiceProviderAdminGetPolicyRequest20.static classGet a service provider administrators profile.static classResponse to the ServiceProviderAdminGetRequest21sp1.static classRequests the effective password rules setting for a service provider administrator The response is either ServiceProviderAdministratorPasswordRulesGetResponse or ErrorResponse.static classResponse to ServiceProviderAdministratorPasswordRulesGetRequest.static classRequest to modify the service provider administrator's policy settings.static classModify a service provider administrator.static classGet a service provider or enterprise's answer confirmation settings.static classResponse to the ServiceProviderAnswerConfirmationGetRequest16.static classModify a service provider or enterprise's answer confirmation settings.static classGet the Application Server set for a service provider or enterprise.static classResponse to the ServiceProviderApplicationServerSetGetRequest.static classModify the Application Server set assigned to the service provider or enterprise.static classRequest the service provider level data associated with Call Processing Policy.static classResponse to ServiceProviderCallProcessingGetPolicyRequest22V3.static classModify the service provider level data associated with Call Processing Policy.static classAssign a list of Communication Barring Criteria to a service provider.static classGet a list of Communication Barring Criteria assigned to a service provider.static classResponse to ServiceProviderCommunicationBarringCriteriaGetAssignedListRequest.static classUnassign a list of Communication Barring Criteria from a service provider.static classAdd a new Communication Barring Digit Pattern Criteria.static classDelete an existing Communication Barring Digit Pattern Criteria.static classGet the list of all Digit Pattern Criteria defined for the service provider.static classResponse to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetListRequest.static classGet an existing Digit Pattern Criteria.static classResponse to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetPatternListRequest.static classGet an existing Digit Pattern Criteria.static classResponse to the ServiceProviderCommunicationBarringDigitPatternCriteriaGetRequest.static classModify an existing Communication Barring Digit Pattern Criteria.static classAssign a list of Communication Barring Incoming Criteria to a service provider.static classGet a list of Communication Barring Incoming Criteria assigned to a service provider.static classResponse to ServiceProviderCommunicationBarringIncomingCriteriaGetAssignedListRequest.static classUnassign a list of Communication Barring Incoming Criteria from a service provider.static classAdd a new Communication Barring Profile.static classDeletes an existing Communication Barring Profile.static classGet a list of groups within a service provider that have a given Communication Barring Profile assigned.static classResponse to ServiceProviderCommunicationBarringProfileGetAssignedGroupListRequest.static classGet a list of Communication Barring profiles within a service provider that have a given Communication Barring Criteria assigned.static classResponse to ServiceProviderCommunicationBarring ProfileGetCriteriaUsageListRequest.static classGet the list of Profiles that use a specific Digit Pattern Criteria.static classResponse to the ServiceProviderCommunicationBarringProfileGetDigitPatternCriteriaUsageListRequest.static classGet a list of Communication Barring profiles within a service provider that have a given Communication Barring Incoming Criteria assigned.static classResponse to ServiceProviderCommunicationBarringProfileGetIncomingCriteriaUsageListRequest.static classGet the list of all Communication Barring Profiles.static classResponse to the ServiceProviderCommunicationBarringProfileGetListRequest.static classGet an existing Communication Barring Profile.static classResponse to the ServiceProviderCommunicationBarringProfileGetRequest19sp1V2.static classModifies the default Communication Barring Profile of a Service Provider.static classModify an existing Communication Barring Profile.static classAdd a service provider or enterprise.static classRebuild the service provider default config file for the specified device type.static classRebuild the config file for a specified device.static classReorder the lines of a Service Provider device.static classReset a specific service provider or enterprise device.static classReset all the devices of the specified device type in a service provider.static classRequest to set a new service provider default configuration file for a device type.static classDelete a service provider or enterprise.static classRequest the Device Activation policy of a service provider or an enterprise.static classResponse to ServiceProviderDeviceActivationPolicyGetRequest.static classModify the Device Activation policy of a service provider or an enterprise.static classRequest device management's events for a specific queue.static classResponse to ServiceProviderDeviceManagementEventGetListRequest22.static classRequest the number of access device of a particular device type and service provider.static classResponse to ServiceProviderDeviceManagementGetAccessDeviceCountForDeviceTypeServiceProviderRequest.static classCancel pending and in progress events.static classRequest to get the service provider level device profile authentication password rule settings.static classResponse to ServiceProviderDeviceProfileAuthenticationPasswordRulesGetRequest.static classRequest to modify the service provider level device profile authentication password rule settings.static classRequest to add a static configuration tag for an access device type used in a service provider.static classRequest to delete static configuration tags for an access device type used in a service provider.static classRequest 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 classResponse to ServiceProviderDeviceTypeCustomTagGetListRequest.static classRequest to modify a static configuration tag for an access device type used in a service provider.static classRequest to get the list of device type files managed by the Device Management System, on a per-service provider basis.static classResponse to ServiceProviderDeviceTypeFileGetListRequest.static classRequest to get a service provider device type file.static classResponse to ServiceProviderDeviceTypeFileGetRequest.static classRequest to modify a specified device type file for a service provider.static classRequest to get the custom configuration tag set defined for the service provider and device type.static classResponse to ServiceProviderDeviceTypeGetRequest.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 ServiceProviderDialableCallerIDCriteriaGetRequest.static classModify a Dialable Caller ID Criteria.static classGet the service provider?s Dialable Caller ID settings and criteria list.static classResponse to the ServiceProviderDialableCallerIDGetRequest.static classModify the service provider?s Dialable Caller ID settings and criteria list.static classRequest to add a Service Provider level Dial Plan Access Code and its all attribues.static classRequest to delete a Service Provider level Dial Plan Access Code and its all attribues.static classRequest the Service Provider level data associated with Dial Plan Policy.static classResponse to ServiceProviderDialPlanPolicyGetAccessCodeListRequest.static classRequest access code data associated with Service Provider level Dial Plan Policy access codes.static classResponse to ServiceProviderDialPlanPolicyGetAccessCodeRequeststatic classRequest the Service Provider level data associated with Dial Plan Policy.static classResponse 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 classRequest to modify a Service Provider level Dial Plan Access Code and its attribues.static classModify the Service Provider level data associated with Dial Plan Policy.static classRequest the service provider's digit collection attributes.static classResponse to ServiceProviderDigitCollectionGetRequest13mp4.static classModifies the service provider's digit collection attributes.static classAdds DNs to a service provider.static classDeletes DNs from a service provider.static classRequest a list of available DNs not yet assigned to any group.static classResponse to ServiceProviderDnGetAvailableListRequest.static classValidates DNs given in the request The response is ServiceProviderDnGetStatusListResponse.static classResponse to ServiceProviderDnGetStatusListRequest.static classRequest a summary table of all DNs in a service provider.static classResponse to ServiceProviderDnGetSummaryListRequest.static classAssign a list of domains to a service provider.static classRequests a list of groups within a service provider that have a given domain assigned.static classResponse to ServiceProviderDomainGetAssignedGroupListRequest.static classRequests the list of all matching domains assigned to a service provider .static classContains a simple list of service provider domain names.static classUnassign a list of domains from a service provider.static classRequest the service provider level data associated with Emergency Call Notification.static classResponse to ServiceProviderEmergencyCallNotificationGetRequest.static classModify the service provider or enterprise level data associated with Emergency Call Notification.static classRequest to search endpoints in the service provider/enterprise.static classResponse to ServiceProviderEndpointGetListRequest.static classRequest the service provider's extension length.static classResponse to ServiceProviderExtensionLengthGetRequest.static classModify the service provider's extension length range.static classGet the list of feature access codes for a service provider or enterprise.static classResponse to the ServiceProviderFeatureAccessCodeGetListRequest21.static classModify a list of feature access codes for a service provider or enterprise.static classAdd a new service provider file repository user.static classDelete a service provider file repository user.static classRequest the list of service provider users for a file repository in the system.static classResponse to ServiceProviderFileRepositoryDeviceUserGetListRequest.static classModify a service provider file repository user.static classRequest the default profile for a service provider or enterprise.static classResponse to the ServiceProviderGetDefaultRequest.static classRequest a list of service providers and/or enterprises in the system.static classResponse to ServiceProviderGetListRequest.static classRequest a list of service providers and/or enterprises in the system.static classResponse to ServiceProviderGetPagedSortedListRequest.static classGet the profile for a service provider or enterprise.static classResponse to the ServiceProviderGetRequest22V4.static classRequest to get the Alternate Carrier Selection parameters.static classResponse to the ServiceProviderHPBXAlternateCarrierSelectionGetRequest.static classRequest to modify the Alternate Carrier Selection parameters.static classAssign a list of service provider DNs to the IMRN pool.static classReturns a list of dns or dn ranges in a service provider IMRN pool.static classResponse to ServiceProviderIMRNGetListRequest.static classUnassign a list of service provider DNs from the service provider IMRN pool.static classRequest to add a language for a service provder.static classRequest to delete a language from a service provider supported languages.static classRequest the list of languages that a user or admin in a service provider is allowed to use.static classResponse to ServiceProviderLanguageGetAvailableListRequest.static classRequest the defined languages for a service provider.static classResponse to ServiceProviderLanguageGetListRequest.static classRequest to modify a language properties for a service provider/enterprise.static classModify the profile for a service provider or enterprise.static classAssign a list of Network Classes of Service to a service provider.static classAssign a list of Network Classes of Service to all groups with in a service provider.static classAssign a Network Classes of Service to all users with in a service provider.static classGet a list of groups within a service provider that have a given Network Class of Service assigned.static classResponse to ServiceProviderNetworkClassOfServiceGetAssignedGroupListRequest.static classGet a list of Network Classes of Service assigned to a service provider.static classResponse to ServiceProviderNetworkClassOfServiceGetAssignedListRequest.static classModifies the default Network Classes of Service of a Service Provider.static classUnassign a list of Network Classes of Service from a service provider.static classAdd a list of the Service Provider Number Portability Query Digit Patterns.static classRequest to get the Service Provider Number Portability Query Digit Pattern Trigger List information.static classResponse to the ServiceProviderNumberPortabilityQueryGetRequest.static classModify the Service Provider Number Portability Query information.static classAssign a list of Office Zones to a service provider.static classGet a list of groups within a service provider that have a given Office Zone assigned.static classResponse to ServiceProviderOfficeZoneGetAssignedGroupListRequest.static classGet a list of Office Zones assigned to a service provider.static classResponse to ServiceProviderOfficeZoneGetAssignedListRequest.static classUnassign a list of OfficeZones from a service provider.static classRequests the service provider's password rules setting applicable to Administrators (Group and Department) and Users.static classResponse to ServiceProviderPasswordRulesGetRequest22.static classRequest to modify the service provider's password rules settings setting applicable to Administrators (Group and Department) and Users.static classRequests the service provider's passcode rules setting.static classResponse to ServiceProviderPortalPasscodeRulesGetRequest19.static classRequest to modify the service provider's passcode rules setting.static classAssign a list of route point external systems to a service provider.static classRequests a list of groups within a service provider that have a given external system assigned.static classResponse to ServiceProviderRoutePointExternalSystemGetAssignedGroupListRequest.static classRequests the list of all Route Point External Systems assigned to a service provider.static classResponse to the ServiceProviderRoutePointExternalSystemGetAssignedListRequest.static classUnassign a list of route point external systems from a service provider.static classRequest the routing profile for the service provider/enterprise.static classResponse to ServiceProviderRoutingProfileGetRequest.static classRequests to modify the routing profile for a service provider.static classAdd an event to service provider schedule.static classAdd a service provider schedule.static classDelete a list of events from a service provider schedule.static classDelete a list of service provider schedule.static classGet the list of events of a service provider schedule.static classResponse to ServiceProviderScheduleGetEventDetailListRequest.static classGet the list of events of a service provider schedule.static classResponse to ServiceProviderScheduleGetEventListRequest.static classGet an event from a service provider schedule.static classResponse to ServiceProviderScheduleGetEventRequest.static classGet the list of a service provider schedules.static classResponse to ServiceProviderScheduleGetListRequest.static classModify an event of a service provider schedule.static classModify a service provider schedule.static classRequests the service provider's service authorization status.static classResponse to ServiceProviderServiceGetAuthorizationListRequest.static classRequests the service provider's service authorization information for a specific service or service pack.static classResponse to ServiceProviderServiceGetAuthorizationRequest.static classRequests the list of all user services assignable to users in the specified service provider.static classResponse to ServiceProviderServiceGetUserAssignableListRequest.static classRequests to change the service provider's service authorization status.static classRequest to add a service pack to a service provider.static classRequest to add services to a service pack if the pack has not been authorized to a group.static classRequest to delete a service pack from a service provider.static classRequest to get a service pack details.static classResponse to ServiceProviderServicePackGetDetailListRequest.static classRequest to get a list of defined service packs for a service provider.static classResponse to ServiceProviderServicePackGetListRequest.static classRequest to get the list of service packs containing a specified service.static classResponse to ServiceProviderServicePackGetServiceUsageListRequest.static classRequest to get the service pack utilization for a service provider.static classResponse to ServiceProviderServicePackGetUtilizationListRequest.static classCreate a service pack migration task.static classMakes a copy of one or more existing service pack migration tasks.static classDeletes a service pack migration task.static classRequests a list of groups to migrate.static classResponse to ServiceProviderServicePackMigrationTaskGetAvailableGroupListRequest.static classRequests a list of all service pack migration tasks for a service provider.static classResponse to ServiceProviderServicePackMigrationTaskGetListRequest21.static classRequests the details of a specified service pack migration task.static classResponse to ServiceProviderServicePackMigrationTaskGetRequest21.static classReplace the list of services and packs to be assigned to users during the service pack migration.static classReplace the list of groups to be migrated for a specified service pack migration task.static classReplace the list of services and packs to be removed from users during the service pack migration.static classModify the properties of a specified service pack migration task.static classReplace the list of services and packs used to select which users will be migrated.static classTerminates a service pack migration task that is currently executing.static classRequests to modify a service pack for a service provider.static classLookup if the given number is defined in the specified service in the service provider.static classResponse to the ServiceProviderServicePhoneNumberLookupRequest.static classGet the session admission control capacity for the service provider.static classResponse to the ServiceProviderSessionAdmissionControlGetRequest.static classRequest to modify session admission control capacity for the service provider.static classRequest to get the Service Provider Session Admission White List information.static classResponse to the ServiceProviderSessionAdmissionControlWhiteListGetRequest.static classModify the Service Provider Session Admission Control White List information.static classRequest to get the service provider level SIP authentication password rule settings.static classResponse to ServiceProviderSIPAuthenticationPasswordRulesGetRequest.static classRequest to modify the service provider level SIP authentication password rule settings.static classGet service provider Stir Shaken service settings.static classResponse to the ServiceProviderStirShakenGetRequest.static classModify service provider Stir Shaken service settings.static classGet the third-party emergency call service settings for the service provider.static classResponse to the ServiceProviderThirdPartyEmergencyCallingGetRequest.static classModify the third-party emergency call service settings for the service provider.static classAssign a list of group and user Xsi policy profile to a service provider.static classGet a list of group within a service provider that have a given group Xsi policy profile assigned.static classResponse to ServiceProviderXsiPolicyProfileGetAssignedGroupListRequest.static classGet a list of Xsi policy profile assigned.static classResponse to ServiceProviderXsiPolicyProfileGetAssignedListRequest.static classModifies the default Xsi policy profile for a service provider.static classUnassign a list of Xsi policy profile. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StreetAddressprotected Stringprotected Contactprotected Stringprotected Booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Booleanprotected BooleanFields inherited from class co.ecg.alpaca.toolkit.model.BroadWorksObject
broadWorksServer, populated -
Constructor Summary
ConstructorsModifierConstructorDescriptionSerializable ConstructorprotectedServiceProvider(BroadWorksServer broadWorksServer) ServiceProvider(BroadWorksServer broadWorksServer, String serviceProviderId) -
Method Summary
Modifier and TypeMethodDescriptionbooleanRetrieves a list of Groups in the ServiceProvider.static ServiceProvidergetPopulatedServiceProvider(BroadWorksServer broadWorksServer, String serviceProviderId) Retrieves a populated ServiceProviderinthashCode()booleanpopulate()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
Listof 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:
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
-