DialingLocation

AddLocalTollPrefix CarrierCodes Confirm HandleRemovedCallingCard HandleRemovedCallingCardWithConfirmation HasValidAreaCode MakeDialingLocationStamp NeedsAlwaysDialAreaCodeSwitch NeedsAreaCode NeedsDontDialNationalAccessLocallySwitch

Attributes

AreaCode CallingCard CountryCode DialingCountry DontDialInternationalAccessCode DontDialNationalAccessLocally HasLocalTolls HasMultipleOutsideLineCodes

Image InternationalCarrierCode LocalDialingMethod LocalDialingSpeed LocalTolls LocationDictionary LongDistanceCarrierCode ManualDialing

MustDialAreaCode MustNotWaitForDialTone OutsideLineCode PhoneAreaCode PhonePrefix ServiceDialingAudible ShouldUseLongDistanceCarrierCode

Fields

instance DialingLocation tag;
 dialingCountry: nilObject;
       areaCode: nilObject;
outsideLineCode: nilObject;
     localTolls: nilObject;
dialingLocationType: 0;
mustDialAreaCode: false;
mustNotWaitForDialTone: false;
  manualDialing: false;
serviceDialingAudible: false;
dontDialNationalAccessLocally: false;
dontDialInternationalAccessCode: false;
localDialingMethod: 0;
localDialingSpeed: 0;
    callingCard: nilObject;
longDistanceCarrierCode: nilObject;
internationalCarrierCode: nilObject;
locationDictionary: nilObject;
end instance;

Define Class DialingLocation;
    inherits from Object;
    inherits from EditAttributeClient;
    inherits from HasCountryCode;

    field dialingCountry: Text;
    field areaCode:                 Text, getter;
    field outsideLineCode:          Text, getter, setter;
    field localTolls:               ObjectList, getter, setter;
    field dialingLocationType:      UnsignedByte;
    field mustDialAreaCode:         Boolean, getter;
        // must include the area code when dialing long-distance calls in same area code
    field mustNotWaitForDialTone:   Boolean, getter, setter;
        // don't want to wait for dial tone in some locations (airplanes, cell phones)
    field manualDialing:            Boolean, getter, setter;
        // user will dial numbers manually from this location
    field serviceDialingAudible:    Boolean, getter, setter;
    field dontDialNationalAccessLocally: Boolean, getter, setter;
    field dontDialInternationalAccessCode:  Boolean;

    // complete dialing preferences stuff
    field localDialingMethod:       UnsignedShort, getter, setter;
        // Tone, pulse or european pulse
    field localDialingSpeed:        UnsignedShort, getter, setter;
        // Slow, medium, or fast
    field callingCard:              CallingCard, weak, getter, setter;
    field longDistanceCarrierCode:  Text, getter;
    field internationalCarrierCode: Text, getter;

    field locationDictionary:       SimpleObjectDictionary;
        // provides general storage for information associated with this location.  
        
    attribute DialingCountry: DialingCountry;
        // uses the stored unique country code text to retrieve the country from iDialingCountries
    attribute AreaCode: Text;
        // the setter strips out ignorable characters before storing the area code
    attribute OutsideLineCode: Text;
    attribute LocalTolls: ObjectList, safe;
    attribute MustDialAreaCode: Boolean;
    attribute MustNotWaitForDialTone: Boolean;
    attribute ManualDialing: Boolean;

    // support for ContentListView

    attribute PhoneAreaCode: Text, readOnly;
    attribute PhonePrefix: Text;

    operation MakeDialingLocationStamp(): DialingLocationStamp;
        // returns a dialing location stamp for self

    attribute Image: Image, readOnly;
    operation HasValidAreaCode(): Boolean;
        // returns true if the area code is valid for that dialing country
    
    // complete dialing preferences stuff
    attribute LocalDialingMethod: UnsignedShort;
    attribute LocalDialingSpeed: UnsignedShort;
    attribute ServiceDialingAudible: Boolean;
    attribute DontDialNationalAccessLocally: Boolean;
        // used only when MustDialAreaCode is true to determine whether or not to dial the national access code
    attribute CallingCard: CallingCard;
        // used to store billing preferences for each location
    attribute LongDistanceCarrierCode: Text;
        // returns the long distance carrier access code for this location
    attribute ShouldUseLongDistanceCarrierCode: Boolean, readOnly;
        // returns boolean whether the user specified a long distance
        // carrier code that should be dialed before long distance calls
    attribute InternationalCarrierCode: Text;
        // the carrier code for making international calls from this location
    attribute DontDialInternationalAccessCode: Boolean;
        // will only return true if there is an international carrier code and the user has checked the checkbox
        // if this is true, it doesn't add the international access code for the current country
    operation CarrierCodes(): Text;
        // returns the long distance and international carrier codes on separate lines
    attribute HasMultipleOutsideLineCodes: Boolean, readOnly;

    attribute LocationDictionary: SimpleObjectDictionary, readOnly;
        // returns the dictionary which provides general storage for information associated
        // with this location.  If it did not already exist, one is created.  This dictionary 
        // may be added to by any package wishing to associate information with the 
        // dialing location.
    
    // removing calling cards from the system
    
    operation HandleRemovedCallingCardWithConfirmation(removedCard: CallingCard);
        // opens a confirmation window asking the user if they really want to remove the calling card
    operation HandleRemovedCallingCard(removedCard: CallingCard);
        // called when the user removes a calling card from the list of calling cards
        // makes sure to remove the deleted calling card from any existing dialing location
    
    // custom access number stuff

    overrides CountryCode;
        // overridden to get country code from dialing country
        
    // complete dialing preferences stuff
    overrides Confirm;

    attribute HasLocalTolls: Boolean, readOnly;
        // True if this location's country supports local tolls (like the US).
    operation AddLocalTollPrefix(prefixText: HasText): Boolean;
        // adds the local toll prefix to the list of local tolls for this dialing location
        // returns false if the user from enters any non-digit characters

    operation NeedsAlwaysDialAreaCodeSwitch(): Boolean;
        // true if this location's dialing country has area codes but doesn't require them to be dialed
    operation NeedsDontDialNationalAccessLocallySwitch(): Boolean;
        // true if NeedsAlwaysDialAreaCodeSwitch and MustDialAreaCode are true
    operation NeedsAreaCode(): Boolean;
        // True if this location must have an area code to know how to dial.
end class;