project35.soa.id
Interface IDGeneratorService

All Superinterfaces:

java.io.Serializable, ServiceClass

All Known Implementing Classes:

DefaultIDGeneratorService, StubbedIDGeneratorService

public interface IDGeneratorService
extends ServiceClass

An interface for describing the behaviour of a class that generates ID values for fields of type xs:ID

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Method Summary

void	excludeKey(java.lang.String key) excludes a key as a possible value to generate.
java.lang.String	generateKey(Project35FormContext project35FormContext) generates an identifier value that Project35 can insert into a field that takes ID values

Methods inherited from interface project35.soa.ServiceClass

getInitialisationParameters, initialiseService

Method Detail

generateKey

java.lang.String generateKey(Project35FormContext project35FormContext)

generates an identifier value that Project35 can insert into a field that takes ID values

Parameters:

project35FormContext - collection of environment variables that can be used to access different parts of the Project35 application. Information in these variables may help determine the best identifier to return.

excludeKey

void excludeKey(java.lang.String key)

excludes a key as a possible value to generate. This is used when Project35 reads a file that contains identifiers. This method ensures that the service won't return a value that already appears somewhere in the data set.

Parameters:

key - an identifier value that can't be generated by the ID Generator service