16 Enabling User Customization

Example 16-2 Adding attributes to the user schema

import oracle.panama.model.ModelFactory;
import oracle.panama.model.PresetCategory;
import oracle.panama.model.PresetDescriptor;
import oracle.panama.ArgumentType;
import oracle.panama.PanamaException;
 
public void createAddressBook() throws PanamaException {
 
        ModelFactory factory = MetaLocator.getInstance().getModelFactory();
        ModelServices services = MetaLocator.getInstance().getModelServices();
 
 
        PresetCategory category;
        try {
            category = services.lookupPresetCategory("Billing Address");    [13]
        } catch (PanamaRuntimeException ex) {
            category = null;
        }
 
        if (category != null) {
            return;   // category already exists
        }
         category = factory.createPresetCategory("Billing Address");        [21]
 
        PresetDescriptor descriptor = category.createPresetDescriptor("Addressee Name");   [23]
        descriptor.setDescription("The name of the addressee");
        descriptor.setPresetType(ArgumentType.SINGLE_LINE);   [25]
        descriptor.setStoredType(Java.sql.Types.VARCHAR);
        descriptor.setSize(new Long(40));[27]
 
        descriptor = category.createPresetDescriptor("Street Address");
        descriptor.setDescription("The street address");
        descriptor.setPresetType(ArgumentType.MULTI_LINE);    [31]
        descriptor.setStoredType(Java.sql.Types.VARCHAR);
        descriptor.setSize(new Long(120));
 
        descriptor = category.createPresetDescriptor("State");
        descriptor.setDescription("The name of the state");
        descriptor.setPresetType(ArgumentType.SINGLE_LINE);
        descriptor.setStoredType(Java.sql.Types.VARCHAR);
        descriptor.setSize(new Long(2));
 
        descriptor = category.createPresetDescriptor("Zip code");
        descriptor.setDescription("The postal zip code");
        descriptor.setPresetType(ArgumentType.SINGLE_LINE);
        descriptor.setStoredType(Java.sql.Types.NUMERIC);
        descriptor.setSize(new Long(5));
 
        factory.save();   [47]
    }

Example 16-3 Adding persistent attributes to a user

import oracle.panama.model.*;
 
public void addBillingAddress(User user, String addressee, String streetAddress,
                             String state, int zipCode) throws PanamaException {
        ModelFactory factory = MetaLocator.getInstance().getModelFactory();
        ModelServices services = MetaLocator.getInstance().getModelServices();
 
        PresetCategory category;
        try {
            category = services.lookupPresetCategory("Billing Address");
        } catch (PanamaRuntimeException ex) {
            createAddressBook();[9]
            category = services.lookupPresetCategory("Billing Address");
        }
 
        Presets presets = user.getPresets(category, Long.toString(user.getId()));[13]
 
        if (presets == null) {
            presets = user.createPresets(category, Long.toString(user.getId()));    [16]
        }
        
        presets.setPresetValue("Addressee Name", addressee);    [18]
        presets.setPresetValue("Street Address", streetAddress);
        presets.setPresetValue("State", state);
        presets.setPresetValue("Zip code", Integer.toString(zipCode));     [21]
 
 
        factory.save();   [23]
    }

Example 16-4 Adding unique presets to user profiles

import oracle.panama.model.*;
import Java.util.Date;
import Java.text.DateFormat;
 
public void addCreditAccount(User user, Profile profile, String cardNumber,
                            String cardType, int expireMonth, int expireYear)
                            throws PanamaException {
        ModelFactory factory = MetaLocator.getInstance().getModelFactory();
        ModelServices services = MetaLocator.getInstance().getModelServices();
 
        PresetCategory category;
        try {
            category = services.lookupPresetCategory("Credit Card Charge Account");
        } catch (PanamaRuntimeException ex1) {
            try {
                category = factory.createPresetCategory("Credit Card Charge Account");
            } catch (PanamaException ex2) {
                throw ex2;
            }
 
 
            PresetDescriptor descriptor = category.createPresetDescriptor("Account Number");
            descriptor.setDescription("The credit card account number");
            descriptor.setPresetType(ArgumentType.SINGLE_LINE);
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(40));
 
            descriptor = category.createPresetDescriptor("Card Type");
            descriptor.setDescription("The type of credit card");
            descriptor.setPresetType(ArgumentType.ENUM);    [25]
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(40));
            String cardTypes[] = { "Master", "Visa", "Discover", "American Express", "Diners Club" };      [28]
            try {
                descriptor.setOptions(cardTypes);     [30]
            } catch (TooManyOptionsException ex3) {
                throw new PanamaException(ex3);
            }
 
            descriptor = category.createPresetDescriptor("Expiration Date");
            descriptor.setDescription("The expiration date of the credit card");
            descriptor.setPresetType(ArgumentType.SINGLE_LINE);
            descriptor.setStoredType(Java.sql.Types.DATE);
 
            factory.save();      [40]
        }
 
        String presetsName = Long.toString(user.getId()) + "-" + Long.toString(profile.getId()); [43]
        Presets presets = profile.getPresets(category, presetsName);
        if (presets == null) {
            presets = profile.createPresets(category, presetsName);
        }
 
        presets.setPresetValue("Account Number", cardNumber);
        presets.setPresetValue("Card Type", cardType);
        Date date = new Date(expireYear, expireMonth, 1);   [60]
        String dateStr = DateFormat.getInstance().format(date);    [61]
        presets.setPresetValue("Expiration Date", dateStr);    [62]
 
        factory.save();     [64]
    }

Example 16-5 Accessing the Presets relation

import oracle.panama.rt.event.RequestEvent;
import oracle.panama.rt.event.AbortServiceException;
import oracle.panama.rt.Session;
import oracle.panama.rt.Request;
 
public void serviceBegin(RequestEvent event) throws AbortServiceException {
        Request request = event.getRequest();
        PresetCategory category;
        String presetsName;
        ModelServices services = MetaLocator.getInstance().getModelServices();
        String serviceName = request.getServicePath();
        User user;
 
        Profile profile = request.getProfile();      [14]
        if (profile == null) {
            profile = request.getSession().getProfile();    [16]
        }
        if (profile != null) {
            user = profile.getUser();
            presetsName = Long.toString(user.getId()) + "-" + Long.toString(profile.getId());
        } else {
            user = request.getSession().getUser();
            presetsName = Long.toString(user.getId());
        }
 
        try {
            category = services.lookupPresetCategory("Credit Card Charge Account");
        } catch (PanamaRuntimeException ex1) {
            throw new AbortServiceException("This service " + serviceName + " requires a valid charge account");
        }
 
        Presets presets = null;
        if (profile == null) {
            presets = user.getPresets(category, presetsName);
        } else { 
            presets = profile.getPresets(category, presetsName);
            if (presets == null) {
                presets = user.getPresets(category, presetsName);
            }
        }
 
        if (presets == null) {
 
            throw new AbortServiceException("This service " + serviceName + " requires a valid charge account");
        }
 
        String creditCardNumber;
        String cardType;
        String expiration;
        try {
            creditCardNumber = presets.getPresetValue("Account Number");
            cardType = presets.getPresetValue("Card Type");
            expiration = presets.getPresetValue("Expiration Date");
        } catch (PanamaException ex) {
            throw new AbortServiceException("This service " + serviceName + " requires a valid charge account");
        }
 
        if (! creditAvailable(creditCardNumber, cardType, expiration)) {
            throw new AbortServiceException("This service " + serviceName + " requires a valid charge account");
        }
 
        request.setParameter("Account Number", creditCardNumber);     [51]
        request.setParameter("Card Type", cardType);      [52]
        request.setParameter("Expiration Date", expiration);    [53]
    }

Example 16-6 Creating presets

import oracle.panama.model.*;
import oracle.panama.PanamaException;
import oracle.panama.PanamaRuntimeException;
import oracle.panama.ArgumentType;
 
import Java.util.Vector;
import Java.util.Enumeration;
import Java.util.Date;
import Java.text.DateFormat;
import Java.text.ParseException;
 
public class SamplePresets {
 
    public void addAppointment(User user, String title, String memo, Date time,
                               boolean alarm, String phone) throws PanamaException {
        ModelFactory factory = MetaLocator.getInstance().getModelFactory();
        ModelServices services = MetaLocator.getInstance().getModelServices();
 
        PresetCategory category;
        try {
            category = services.lookupPresetCategory("Appointments");
        } catch (PanamaRuntimeException ex1) {
            try {
                category = factory.createPresetCategory("Appointments");
                category.setSystem(false);         [25]
            } catch (PanamaException ex2) {
                throw ex2;
            }
 
            PresetDescriptor descriptor = category.createPresetDescriptor("Short Title");
            descriptor.setDescription("Brief description of the event");
            descriptor.setPresetType(ArgumentType.SINGLE_LINE);
 
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(40));
 
            descriptor = category.createPresetDescriptor("Memo");
            descriptor.setDescription("Memo for the event");
            descriptor.setPresetType(ArgumentType.MULTI_LINE);
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(400));
 
            descriptor = category.createPresetDescriptor("Time");
            descriptor.setDescription("Time of event");
            descriptor.setPresetType(ArgumentType.SINGLE_LINE);
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(40));
 
            descriptor = category.createPresetDescriptor("Alarm");
            descriptor.setDescription("Enable or disable alarm before event");
            descriptor.setPresetType(ArgumentType.SINGLE_LINE);
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(1));
 
            descriptor = category.createPresetDescriptor("Phone Number");
            descriptor.setDescription("Optional phone number to ring for alarm");
            descriptor.setPresetType(ArgumentType.SINGLE_LINE);
            descriptor.setStoredType(Java.sql.Types.VARCHAR);
            descriptor.setSize(new Long(40));
            descriptor.setFormat("\\s*[(]?[1-9]\\d{2}[)]?\\s*-?\\s*\\d{3}\\s*-?\\s*\\d{4}");      [59]
            descriptor.setEmptyOK(true);
 
            factory.save();
        }
 
        Presets presets = user.createPresets(category);    [65]
 
        presets.setPresetValue("Short Title", title);
        presets.setPresetValue("Memo", memo);
        String timeStr = DateFormat.getDateTimeInstance().format(time);   [69]
        presets.setPresetValue("Time", timeStr);
        if (alarm) {
            presets.setPresetValue("Alarm", "Y");
        } else {
            presets.setPresetValue("Alarm", "Y");
 
        }
       try {
            presets.setPresetValue("Phone Number", phone);         [77]
        } catch (PanamaException ex) {
            // ignore
        }
 
        factory.save();
    }
 
    public Presets[] getAppointments(User user) throws PanamaException {
        ModelFactory factory = MetaLocator.getInstance().getModelFactory();
        ModelServices services = MetaLocator.getInstance().getModelServices();
 
        PresetCategory category;
        try {
            category = services.lookupPresetCategory("Appointments");
        } catch (PanamaRuntimeException ex1) {
            throw new PanamaException(ex1);
        }
 
        Date now = new Date(System.currentTimeMillis());
        Vector allPresets = user.getAllPresets(category);       [97]
        Enumeration enum = allPresets.elements();
        Vector pending = new Vector();
        while (enum.hasMoreElements()) {
            Presets event = (Presets) enum.nextElement();
            String timeStr = event.getPresetValue("Time");
            Date time;
            try {
                time = DateFormat.getDateTimeInstance().parse(timeStr);   [105]
            } catch (ParseException ex) {
                time = null;
            }
            if (time != null && time.after(now)) {
                pending.add(event);
            } else {
                user.deletePresets(category, new Long(event.getId()));    [112]
            }
        }
        factory.save();
 
        Presets presetsArray[] = new Presets[pending.size()];
        pending.copyInto(presetsArray);
        return presetsArray;
 
    }
 
}