Package ca.macewan.ims.enterprise

The IMS enterprise package attempts to provide a one-on-one representation of the IMS Enterprise Specification v1.1.

See:
Description

Class Summary

Adr	Represents an "adr" element.
Comments	Represents a "comments" element.
Demographics	Represents a "demographics" element.
Description	Represents a "description" element.
EnrollControl	Represents an "enroll control" element.
Enterprise	Represents the root "enterprise" element.
Extension	Represents an "extension" element.
FinalResult	Represents a "final result" element.
Group	Represents a "group" element.
GroupType	Represents a "group type" element.
InstitutionRole	Represents an "institution role" element.
InterimResult	Represents an "interim result" element.
Member	Represents a "member" element.
Membership	Represents a "membership" element.
N	Represents an "n" element.
Name	Represents a "name" element.
Org	Represents an "org" element.
PartName	Represents a "part name" element.
Person	Represents a "person" element.
Photo	Represents a "photo" element.
Properties	Represents a "properties" element.
Relationship	Represents a "relationshsip" element.
Result	This is the abstract superclass of FinalResult and InterimResult.
Role	Represents a "role" element.
SourcedID	Represents a "sourcedid" element.
Tel	Represents a "tel" element.
TimeFrame	Represents a "time frame" element.
TypeValue	Represents a "type value" element.
UserID	Represents a "user id" element.
Values	Represents a "values" element.

Exception Summary

IMSEnterpriseException

The IMSEnterpriseException is used by those setter methods that validate their arguments, as well as by validate methods, where applicable.

Package ca.macewan.ims.enterprise Description

The IMS enterprise package attempts to provide a one-on-one representation of the IMS Enterprise Specification v1.1.

An IMS enterprise document can be represented by an Enterprise object, which provides methods to gain access to all elements underneath.

Typically, each attribute, property or sub-element of an element can be set with a set<Element> method and retrieved with a get<Element> method. If an element can have more than one instance of a particular sub-element, however, the name of the setter method will be add<Element>. In these cases the get<Element> method will return an array of the expected type, instead of a single instance. The getter and setter methods follow the names of the elements regardless of singular or plural form, with the exception of the top-level element getter methods in the Enterprise object, which are all pluralized:

• getComments (Returns a single Comments object)
• getProperties (Returns a single Properties object)
• getPersons (Returns an array of Person objects)
• getGroups (Returns an array of Group objects)
• getMemberships (Returns an array of Membership objects)

Version:

0.1

Author:

Erwin Veugelers

See Also:

IMS Enterprise Specification