oracle.panama.model
Interface ModelServices

public interface ModelServices

The model services. The entry point to find model objects.

Method Summary

Type	Method
void	copyFolderContent(Folder source, Folder target, User newOwner) Copy the content of one folder to another and change the owner of the new services to the specified user.
ResultSetEnumeration	findAdapters(java.lang.String nameExpr) Find Adapters by name
ResultSetEnumeration	findAdministrators() Finds all administrators.
ResultSetEnumeration	findAlertAddresses(java.lang.String nameExpr) Find AlertAddress by name
ResultSetEnumeration	findAlerts(java.lang.String urlExpr) Find Alerts by their "url" path name
ResultSetEnumeration	findAlerts(java.lang.String urlExpr, int[] orderBy) Find Alerts by their "url" path name
AlertService[]	findAlertServices(java.lang.String nameExpr) Finds AlertServices which names match the search criteria.
AlertService[]	findAlertServices(java.lang.String nameExpr, int[] orderBy) Returns and enumeartion of AlertServices which names match the search criteria.
ResultSetEnumeration	findAsyncMasterServices(java.lang.String urlExpr) Find async enabled MasterServices by their "url" path name
ResultSetEnumeration	findAsyncMasterServices(java.lang.String urlExpr, int category, int[] orderBy) Find async enabled MasterServices by their "url" path name
ResultSetEnumeration	findAsyncMasterServicesByName(java.lang.String nameExpr, int category, int[] orderBy) Find async enabled MasterServices by their name
ResultSetEnumeration	findAsyncServices(DeliveryType deliveryType) Finds async services which can be invoked by a delivery type mechanism
ResultSetEnumeration	findAsyncServices(DeliveryType deliveryType, int[] orderBy) Finds async services which can be invoked by a delivery type mechanism
ResultSetEnumeration	findAsyncServices(java.lang.String asyncNameExpr) Finds async services whose async names match the search criteria.
ResultSetEnumeration	findAsyncServices(java.lang.String asyncNameExpr, int category, int[] orderBy) Finds async services whose async names match the search criteria.
ResultSetEnumeration	findCommunities(java.lang.String nameExpr) Find Communities by name
ResultSetEnumeration	findCommunity() Find all Communities in the system
ResultSetEnumeration	findCommunity(java.lang.String cmtyType) Find Community by community type
ResultSetEnumeration	findCreatedCommunity(User creator) Find Community by community creator
ResultSetEnumeration	findCreatedCommunity(User creator, java.lang.String cmtyType) Find Community by creator and the community type
ResultSetEnumeration	findDataFeeders(java.lang.String nameExpr) Find DataFeeders by name
ResultSetEnumeration	findDevices(java.lang.String nameExpr) Find Devices by name
ResultSetEnumeration	findDevices(java.lang.String urlExpr, int[] orderBy) Find Devices by name
ResultSetEnumeration	findDevicesByDeviceCategory(DeviceCategory category, int[] orderBy) Find Devices by DeviceCategory
Device[]	findDevicesByTransformer(java.lang.String nameExpr, int[] orderBy) Find Devices by a name of a transformer
Device[]	findDevicesByUserAgent(java.lang.String nameExpr, int[] orderBy) Find Devices by the HTTP User-Agent used to detect the device
ResultSetEnumeration	findExternalLinks(java.lang.String urlExpr) Find ExternalLinks by their "url" path name
ResultSetEnumeration	findExternalLinks(java.lang.String urlExpr, int category, int[] orderBy) Find ExternalLinks by their "url" path name
ResultSetEnumeration	findExternalLinksByName(java.lang.String nameExpr, int category, int[] orderBy) Find ExternalLinks by their name
ResultSetEnumeration	findFolders(java.lang.String urlExpr) Find Folders by their "url" path name
ResultSetEnumeration	findFolders(java.lang.String urlExpr, int category, int[] orderBy) Find Folders by their "url" path name
ResultSetEnumeration	findFoldersByName(java.lang.String nameExpr, int category, int[] orderBy) Find Folders by their name
ResultSetEnumeration	findGroups(java.lang.String nameExpr) Find Groups which names match the search criteria.
ResultSetEnumeration	findLinks(java.lang.String urlExpr) Find Links by their "url" path name
ResultSetEnumeration	findLinks(java.lang.String urlExpr, int category, int[] orderBy) Find Links by their "url" path name
ResultSetEnumeration	findLinksByName(java.lang.String nameExpr, int category, int[] orderBy) Find Links by their name
ResultSetEnumeration	findLocalModules(java.lang.String urlExpr, boolean virtual) Find LocalModules by their "url"
ResultSetEnumeration	findLocalModules(java.lang.String urlExpr, boolean virtual, int category, int[] orderBy) Find LocalModules by their "url"
ResultSetEnumeration	findLocalModulesByName(java.lang.String nameExpr, int category, int[] orderBy) Find LocalModules by their name
ResultSetEnumeration	findLocationMarks(java.lang.String nameExpr) Find LocationMark by name
ResultSetEnumeration	findLocationPrivacyAuths(Service service) Find LocationPrivacyAuth by service
ResultSetEnumeration	findLocationPrivacyAuths(Service service, User owner, java.lang.String positionRequesterType, java.lang.String status) Find LocationPrivacyAuth by service, the privacy owner, the type of the positionRequester and the status of the authorization
ResultSetEnumeration	findLocationPrivacyAuths(java.lang.String nameExpr) Find LocationPrivacyAuth by name
MasterAlertService[]	findMasterAlertServices(java.lang.String nameExpr) Returns and enmeartion of MasterAlertServices which names match the search criteria.
MasterAlertService[]	findMasterAlertServices(java.lang.String nameExpr, int[] orderBy) Find Master alert services ordered as specified
ResultSetEnumeration	findMasterServices(java.lang.String urlExpr) Find MasterServices by their "url" path name
ResultSetEnumeration	findMasterServices(java.lang.String urlExpr, int category, int[] orderBy) Find MasterServices by their "url" path name
ResultSetEnumeration	findMasterServicesByName(java.lang.String nameExpr, int category, int[] orderBy) Find MasterServices by their name
ResultSetEnumeration	findModulableMasterServices(java.lang.String urlExpr) Find modulable MasterServices by their "url" path name
ResultSetEnumeration	findModulableMasterServices(java.lang.String urlExpr, int category, int[] orderBy) Find modulable MasterServices by their "url" path name
ResultSetEnumeration	findModulableMasterServicesByName(java.lang.String nameExpr, int category, int[] orderBy) Find modulable MasterServices by their name
ResultSetEnumeration	findModules(java.lang.String urlExpr, boolean virtual) Find Modules by their "url"
ResultSetEnumeration	findModules(java.lang.String urlExpr, boolean virtual, int category, int[] orderBy) Find Modules by their "url"
ResultSetEnumeration	findPresetCategory(java.lang.String nameExpr) Finds preset categorys which names match the search criteria.
ResultSetEnumeration	findRoles(java.lang.String nameExpr) Find Roles which names match the search criteria.
ResultSetEnumeration	findServices(java.lang.String urlExpr) Find Services by their "url" path name
ResultSetEnumeration	findServices(java.lang.String urlExpr, int category, int[] orderBy) Find Services by their "url" path name
ResultSetEnumeration	findServicesByName(java.lang.String nameExpr, int category, int[] orderBy) Find Services by their name
MasterAlertService[]	findTimeEnabledMasterAlerts(java.lang.String nameExpr, int[] orderBy) Find time enabled Master alert services ordered as specified
Topic[]	findTopics(java.lang.String nameExpr) Finds topics which names match the search criteria.
Topic[]	findTopics(java.lang.String nameExpr, int[] orderBy) Find Topics ordered as specified
ResultSetEnumeration	findTransformers(java.lang.String nameExpr) Find Transformers by name
ResultSetEnumeration	findTransformers(java.lang.String nameExpr, int[] orderBy) Find Transformers by name
ResultSetEnumeration	findTransformersByMimeType(java.lang.String mimeType) Find Transformers by mime type
ResultSetEnumeration	findUsers(java.lang.String nameExpr) Finds users which names match the search criteria.
ResultSetEnumeration	findUsers(java.lang.String nameExpr, java.lang.String displayNameExpr, int maxHits) Finds users which names match the search criteria.
ResultSetEnumeration	findVisibleCommunity(User user, java.lang.String cmtyType) Find the communities which are visible to the user and have the type of cmtyType A private community is only visible to the its creator.
AlertConditionType	getAlertConditionTypeByName(java.lang.String typeName) Gets the condition type by name
AlertConditionType[]	getAlertConditionTypes(java.lang.String paramDataType) Gets the condition types
ResultSetEnumeration	getAlertServices(java.lang.String nameExpr) Finds alert services which do not have a parent topic
AlertTimeFrequency[]	getAlertTimeFrequencies() Returns an array of the allowed Alert Time Frequencies
ResultSetEnumeration	getMasterAlertServices(java.lang.String nameExpr) Returns and enmeartion of MasterAlertServices which names match the search criteria.
DataType[]	getPresetDataTypes() Get valid Preset Data Types.
AlertService[]	getRootAlertServices() Finds alert services which do not have a parent topic
ResultSetEnumeration	getRootServices() Get all root services
Topic[]	getRootTopics() Finds topics which do not have a parent topic
ResultSetEnumeration	getTopics(java.lang.String nameExpr) Finds topics which do not have a parent topic
Adapter	lookupAdapter(long id) Lookup a Adapter
Adapter	lookupAdapter(java.lang.String name) Lookup an Adapter
Alert	lookupAlert(long id) Lookup an Alert
Alert	lookupAlert(java.lang.String url) Lookup an Alert
AlertAddress	lookupAlertAddress(long id) Lookup an AlertAddress
AlertAddress	lookupAlertAddress(java.lang.String url) Lookup an AlertAddress
AlertService	lookupAlertService(long id) Get a AlertService for the given id
AlertService	lookupAlertService(java.lang.String name) Get a AlertService for the given name
Service	lookupAsyncService(DeliveryType deliveryType, java.lang.String address) Lookup an async service by delivery type and address
Service	lookupAsyncService(long id) Lookup an async service by object id
Service	lookupAsyncService(java.lang.String asyncName) Lookup an async service by async name
Community	lookupCommunity(long id) Lookup a Community
Community	lookupCommunity(User creator, java.lang.String cmtyName) Lookup a Community by creator and the community name.
DataFeeder	lookupDataFeeder(long id) Lookup Transformer
DataFeeder	lookupDataFeeder(java.lang.String name) Get a named DataFeeder
Device	lookupDevice(long id) Lookup Device
Device	lookupDevice(java.lang.String name) Lookup a Device
DeviceAddress	lookupDeviceAddress(DeliveryType deliveryType, java.lang.String address) Lookup a device address
DeviceAddress	lookupDeviceAddress(long id) Lookup a device address
ExternalLink	lookupExternalLink(long id) Lookup an ExternalLink
ExternalLink	lookupExternalLink(java.lang.String url) Lookup an ExternalLink
Folder	lookupFolder(long id) Lookup a Folder
Folder	lookupFolder(java.lang.String url) Lookup a Folder
Group	lookupGroup(long id) Lookup a Group by object id
Group	lookupGroup(java.lang.String name) Lookup a Group by name
Link	lookupLink(long id) Lookup a Link
Link	lookupLink(java.lang.String url) Lookup a Link
LocalModule	lookupLocalModule(long id) Lookup a LocalModule
LocalModule	lookupLocalModule(java.lang.String url, boolean virtual) Lookup a LocalModule
LocationMark	lookupLocationMark(long id) Lookup an LocationMark
LocationMark	lookupLocationMark(java.lang.String name, java.lang.String userName) Lookup a LocationMark by name and user name (logical key)
LocationPrivacyAuth	lookupLocationPrivacyAuth(long id) Lookup a LocationPrivacyAuth
LocationPrivacyAuth	lookupLocationPrivacyAuth(Service service, User owner, ModelObject positionRequester) Lookup a LocationPrivacyAuth by service, privacy owner and the positionRequester.
MasterAlertService	lookupMasterAlertService(long id) Get a MasterAlertService for the given id
MasterAlertService	lookupMasterAlertService(java.lang.String name) Get a MasterAlertService given the name
MasterService	lookupMasterService(long id) Lookup a MasterService
MasterService	lookupMasterService(java.lang.String url) Lookup a MasterService
Module	lookupModule(long id) Lookup a Module
Module	lookupModule(java.lang.String url, boolean virtual) Lookup a LocalModule
PresetCategory	lookupPresetCategory(long id) Lookup a preset category by id.
PresetCategory	lookupPresetCategory(java.lang.String name) Lookup a preset category by name.
Role	lookupRole(long id) Lookup a Role by object id
Role	lookupRole(java.lang.String name) Lookup a Role by name
Service	lookupService(long id) Lookup a Service, this class is abstract and the method will always return the leaf class.
Service	lookupService(java.lang.String url) Lookup a Service, this class is abstract and the method will always return the leaf class.
Topic	lookupTopic(long id) Get a topic for the given id
Topic	lookupTopic(java.lang.String name) Get a topic for the given name
Transformer	lookupTransformer(long id) Lookup Transformer
Transformer	lookupTransformer(java.lang.String name) Lookup a Transformer
User	lookupUser(long id) Lookup an user by object id.
User	lookupUser(java.lang.String name) Lookup an user by name.
User	lookupUserByAccountNumber(java.lang.String accountNumber) Lookup an user by account number
User	lookupUserByDeviceId(java.lang.String deviceId) Lookup an user by device id
User	lookupUserByGlobalUID(java.lang.String guid) Lookup an user by global UID

Method Detail

lookupUser

public User lookupUser(java.lang.String name)
                throws PanamaRuntimeException

Lookup an user by name.

Parameters:

name - the complete not null name of the user.

Returns:

User the user.

Throws:

PanamaRuntimeException - if the user cannot be found

lookupUser

public User lookupUser(long id)
                throws PanamaRuntimeException

Lookup an user by object id.

Parameters:

id - the system level unique object id

Returns:

User the user.

Throws:

PanamaRuntimeException - if the user cannot be found

lookupUserByDeviceId

public User lookupUserByDeviceId(java.lang.String deviceId)
                          throws PanamaRuntimeException

Lookup an user by device id

Parameters:

deviceId - the device id of the user

Returns:

User the user

Throws:

PanamaRuntimeException - if the user cannot be found)

lookupUserByAccountNumber

public User lookupUserByAccountNumber(java.lang.String accountNumber)
                               throws PanamaRuntimeException

Lookup an user by account number

Parameters:

accountNumber - the account number of the user

Returns:

User the user

Throws:

PanamaRuntimeException - if the user cannot be found)

lookupUserByGlobalUID

public User lookupUserByGlobalUID(java.lang.String guid)
                           throws PanamaRuntimeException

Lookup an user by global UID

Parameters:

guid - the global UID of the user

Returns:

User the user

Throws:

PanamaRuntimeException - if the user cannot be found)

findUsers

public ResultSetEnumeration findUsers(java.lang.String nameExpr)
                               throws PanamaRuntimeException

Finds users which names match the search criteria.

Parameters:

nameExpr - the name including wildcards as [%*, _?].

Returns:

ResultSetEnumeration of User objects.

Throws:

PanamaRuntimeException - if the users cannot be found

findUsers

public ResultSetEnumeration findUsers(java.lang.String nameExpr,
                                      java.lang.String displayNameExpr,
                                      int maxHits)
                               throws PanamaRuntimeException

Finds users which names match the search criteria.

Parameters:

nameExpr - the name including wildcards as [%*, _?].

displayNameExpr - the display name expression including wildcards or null for all.

maxHits - the maximum number of hits or -1 for no limitation.

Returns:

ResultSetEnumeration of User objetcs.

Throws:

PanamaRuntimeException - if the users cannot be found

findAdministrators

public ResultSetEnumeration findAdministrators()
                                        throws PanamaRuntimeException

Finds all administrators.

Returns:

ResultSetEnumeration with all administrators as User objects.

Throws:

PanamaRuntimeException - if the administrators cannot be found

lookupGroup

public Group lookupGroup(java.lang.String name)
                  throws PanamaRuntimeException

Lookup a Group by name

Parameters:

name - the complete not null name of the Group

Returns:

Group the group

Throws:

PanamaRuntimeException - if the Group cannot be found

lookupGroup

public Group lookupGroup(long id)
                  throws PanamaRuntimeException

Lookup a Group by object id

Parameters:

id - the system level unique object id

Returns:

Group the group

Throws:

PanamaRuntimeException - if the Group cannot be found

findGroups

public ResultSetEnumeration findGroups(java.lang.String nameExpr)
                                throws PanamaRuntimeException

Find Groups which names match the search criteria.

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of Group objetcs

Throws:

PanamaRuntimeException - if the Groups cannot be found

lookupRole

public Role lookupRole(java.lang.String name)
                throws PanamaRuntimeException

Lookup a Role by name

Parameters:

name - the complete not null name of the Role

Returns:

Role the role

Throws:

PanamaRuntimeException - if the Role cannot be found

lookupRole

public Role lookupRole(long id)
                throws PanamaRuntimeException

Lookup a Role by object id

Parameters:

id - the system level unique object id

Returns:

Role the role

Throws:

PanamaRuntimeException - if the Role cannot be found

findRoles

public ResultSetEnumeration findRoles(java.lang.String nameExpr)
                               throws PanamaRuntimeException

Find Roles which names match the search criteria.

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of Role objetcs

Throws:

PanamaRuntimeException - if the Roles cannot be found

lookupService

public Service lookupService(java.lang.String url)
                      throws PanamaRuntimeException

Lookup a Service, this class is abstract and the method will always return the leaf class.

Parameters:

url - the complete path to the service.

Returns:

Service the service.

Throws:

PanamaRuntimeException - if the Service cannot be found

lookupService

public Service lookupService(long id)
                      throws PanamaRuntimeException

Lookup a Service, this class is abstract and the method will always return the leaf class.

Parameters:

id - the system object id user.

Returns:

the interface to the service.

Throws:

PanamaRuntimeException - if the Service cannot be found

findServices

public ResultSetEnumeration findServices(java.lang.String urlExpr)
                                  throws PanamaRuntimeException

Find Services by their "url" path name

Parameters:

urlExpr - the path to the Folder including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different Service leaf-class objects

Throws:

PanamaRuntimeException - if the Services cannot be found

findServices

public ResultSetEnumeration findServices(java.lang.String urlExpr,
                                         int category,
                                         int[] orderBy)
                                  throws PanamaRuntimeException

Find Services by their "url" path name

Parameters:

urlExpr - the path to the Service including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Service leaf-class objects

Throws:

PanamaRuntimeException - if the Services cannot be found

findServicesByName

public ResultSetEnumeration findServicesByName(java.lang.String nameExpr,
                                               int category,
                                               int[] orderBy)
                                        throws PanamaRuntimeException

Find Services by their name

Parameters:

nameExpr - the name of the Service including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Service leaf-class objects

Throws:

PanamaRuntimeException - if the Services cannot be found

lookupAdapter

public Adapter lookupAdapter(java.lang.String name)
                      throws PanamaRuntimeException

Lookup an Adapter

Parameters:

name - the name of the Adapter

Returns:

Adapter the Adapter

Throws:

PanamaRuntimeException - if the Adapter cannot be found

lookupAdapter

public Adapter lookupAdapter(long id)
                      throws PanamaRuntimeException

Lookup a Adapter

Parameters:

id - the system object id user.

Returns:

the interface to the service.

Throws:

PanamaRuntimeException - if the Adapter cannot be found

findAdapters

public ResultSetEnumeration findAdapters(java.lang.String nameExpr)
                                  throws PanamaRuntimeException

Find Adapters by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of Adapter objetcs

Throws:

PanamaRuntimeException - if the Adapters cannot be found

lookupFolder

public Folder lookupFolder(java.lang.String url)
                    throws PanamaRuntimeException

Lookup a Folder

Parameters:

url - the complete path to the Folder.

Returns:

Folder the folder.

Throws:

PanamaRuntimeException - if the Folder cannot be found

lookupFolder

public Folder lookupFolder(long id)
                    throws PanamaRuntimeException

Lookup a Folder

Parameters:

id - the system object id.

Returns:

Folder the interface to the Folder.

Throws:

PanamaRuntimeException - if the Folder cannot be found

findFolders

public ResultSetEnumeration findFolders(java.lang.String urlExpr)
                                 throws PanamaRuntimeException

Find Folders by their "url" path name

Parameters:

urlExpr - the path to the Folder including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different Service leaf-class objects

Throws:

PanamaRuntimeException - if the Services cannot be found

findFolders

public ResultSetEnumeration findFolders(java.lang.String urlExpr,
                                        int category,
                                        int[] orderBy)
                                 throws PanamaRuntimeException

Find Folders by their "url" path name

Parameters:

urlExpr - the path to the Folder including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Service leaf-class objects

Throws:

PanamaRuntimeException - if the Services cannot be found

findFoldersByName

public ResultSetEnumeration findFoldersByName(java.lang.String nameExpr,
                                              int category,
                                              int[] orderBy)
                                       throws PanamaRuntimeException

Find Folders by their name

Parameters:

nameExpr - the name of the Folder including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Service leaf-class objects

Throws:

PanamaRuntimeException - if the Services cannot be found

lookupMasterService

public MasterService lookupMasterService(java.lang.String url)
                                  throws PanamaRuntimeException

Lookup a MasterService

Parameters:

url - the complete path to the MasterService.

Returns:

Folder the folder.

Throws:

PanamaRuntimeException - if the MasterService cannot be found

lookupMasterService

public MasterService lookupMasterService(long id)
                                  throws PanamaRuntimeException

Lookup a MasterService

Parameters:

id - the system object id.

Returns:

MasterService the interface to the MasterService.

Throws:

PanamaRuntimeException - if the MasterService cannot be found

findMasterServices

public ResultSetEnumeration findMasterServices(java.lang.String urlExpr)
                                        throws PanamaRuntimeException

Find MasterServices by their "url" path name

Parameters:

urlExpr - the path to the MasterService including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findMasterServices

public ResultSetEnumeration findMasterServices(java.lang.String urlExpr,
                                               int category,
                                               int[] orderBy)
                                        throws PanamaRuntimeException

Find MasterServices by their "url" path name

Parameters:

urlExpr - the path to the MasterService including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findMasterServicesByName

public ResultSetEnumeration findMasterServicesByName(java.lang.String nameExpr,
                                                     int category,
                                                     int[] orderBy)
                                              throws PanamaRuntimeException

Find MasterServices by their name

Parameters:

nameExpr - the name of the MasterService including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findModulableMasterServices

public ResultSetEnumeration findModulableMasterServices(java.lang.String urlExpr)
                                                 throws PanamaRuntimeException

Find modulable MasterServices by their "url" path name

Parameters:

urlExpr - the path to the MasterService including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different modulable MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findModulableMasterServices

public ResultSetEnumeration findModulableMasterServices(java.lang.String urlExpr,
                                                        int category,
                                                        int[] orderBy)
                                                 throws PanamaRuntimeException

Find modulable MasterServices by their "url" path name

Parameters:

urlExpr - the path to the MasterService including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different modulable MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findModulableMasterServicesByName

public ResultSetEnumeration findModulableMasterServicesByName(java.lang.String nameExpr,
                                                              int category,
                                                              int[] orderBy)
                                                       throws PanamaRuntimeException

Find modulable MasterServices by their name

Parameters:

nameExpr - the name of the MasterService including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different modulable MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findAsyncMasterServices

public ResultSetEnumeration findAsyncMasterServices(java.lang.String urlExpr)
                                             throws PanamaRuntimeException

Find async enabled MasterServices by their "url" path name

Parameters:

urlExpr - the path to the MasterService including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different modulable MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findAsyncMasterServices

public ResultSetEnumeration findAsyncMasterServices(java.lang.String urlExpr,
                                                    int category,
                                                    int[] orderBy)
                                             throws PanamaRuntimeException

Find async enabled MasterServices by their "url" path name

Parameters:

urlExpr - the path to the MasterService including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different modulable MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

findAsyncMasterServicesByName

public ResultSetEnumeration findAsyncMasterServicesByName(java.lang.String nameExpr,
                                                          int category,
                                                          int[] orderBy)
                                                   throws PanamaRuntimeException

Find async enabled MasterServices by their name

Parameters:

nameExpr - the name of the MasterService including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different modulable MasterService objects

Throws:

PanamaRuntimeException - if the MasterServices cannot be found

lookupLocalModule

public LocalModule lookupLocalModule(java.lang.String url,
                                     boolean virtual)
                              throws PanamaRuntimeException

Lookup a LocalModule

Parameters:

url - the absolute or virtual URL to this LocalModule.

virtual - flag if the an absolute (false) or virtual (true) URL should be used

Returns:

LocalModule the LocalModule.

Throws:

PanamaRuntimeException - if the LocalModule cannot be found

lookupLocalModule

public LocalModule lookupLocalModule(long id)
                              throws PanamaRuntimeException

Lookup a LocalModule

Parameters:

id - the system object id.

Returns:

LocalModule the interface to the LocalModule.

Throws:

PanamaRuntimeException - if the LocalModule cannot be found

findLocalModules

public ResultSetEnumeration findLocalModules(java.lang.String urlExpr,
                                             boolean virtual)
                                      throws PanamaRuntimeException

Find LocalModules by their "url"

Parameters:

urlExpr - the absolute or virtual URL to this LocalModule including wildcards as [%*, _?]

virtual - flag if the an absolute (false) or virtual (true) URL should be used

Returns:

ResultSetEnumeration of different LocalModule objects

Throws:

PanamaRuntimeException - if the LocalModules cannot be found

findLocalModules

public ResultSetEnumeration findLocalModules(java.lang.String urlExpr,
                                             boolean virtual,
                                             int category,
                                             int[] orderBy)
                                      throws PanamaRuntimeException

Find LocalModules by their "url"

Parameters:

urlExpr - the absolute or virtual URL to this LocalModule including wildcards as [%*, _?]

virtual - flag if the an absolute (false) or virtual (true) URL should be used

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different LocalModule objects

Throws:

PanamaRuntimeException - if the LocalModules cannot be found

findLocalModulesByName

public ResultSetEnumeration findLocalModulesByName(java.lang.String nameExpr,
                                                   int category,
                                                   int[] orderBy)
                                            throws PanamaRuntimeException

Find LocalModules by their name

Parameters:

nameExpr - the name of the LocalModule including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different LocalModule objects

Throws:

PanamaRuntimeException - if the LocalModules cannot be found

lookupModule

public Module lookupModule(java.lang.String url,
                           boolean virtual)
                    throws PanamaRuntimeException

Lookup a LocalModule

Parameters:

url - the absolute or virtual URL to this LocalModule.

virtual - flag if the an absolute (false) or virtual (true) URL should be used

Returns:

Module the Module.

Throws:

PanamaRuntimeException - if the Module cannot be found

lookupModule

public Module lookupModule(long id)
                    throws PanamaRuntimeException

Lookup a Module

Parameters:

id - the system object id.

Returns:

Module the interface to the Module.

Throws:

PanamaRuntimeException - if the Module cannot be found

findModules

public ResultSetEnumeration findModules(java.lang.String urlExpr,
                                        boolean virtual)
                                 throws PanamaRuntimeException

Find Modules by their "url"

Parameters:

urlExpr - the absolute or virtual URL to this Module including wildcards as [%*, _?]

virtual - flag if the an absolute (false) or virtual (true) URL should be used

Returns:

ResultSetEnumeration of different Module objects

Throws:

PanamaRuntimeException - if the Modules cannot be found

findModules

public ResultSetEnumeration findModules(java.lang.String urlExpr,
                                        boolean virtual,
                                        int category,
                                        int[] orderBy)
                                 throws PanamaRuntimeException

Find Modules by their "url"

Parameters:

urlExpr - the absolute or virtual URL to this Module including wildcards as [%*, _?]

virtual - flag if the an absolute (false) or virtual (true) URL should be used

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Module objects

Throws:

PanamaRuntimeException - if the Modules cannot be found

lookupLink

public Link lookupLink(java.lang.String url)
                throws PanamaRuntimeException

Lookup a Link

Parameters:

url - the complete path to the Link.

Returns:

Link the Link.

Throws:

PanamaRuntimeException - if the Link cannot be found

lookupLink

public Link lookupLink(long id)
                throws PanamaRuntimeException

Lookup a Link

Parameters:

id - the system object id.

Returns:

Link the interface to the Link.

Throws:

PanamaRuntimeException - if the Link cannot be found

findLinks

public ResultSetEnumeration findLinks(java.lang.String urlExpr)
                               throws PanamaRuntimeException

Find Links by their "url" path name

Parameters:

urlExpr - the path to the Link including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different Link objects

Throws:

PanamaRuntimeException - if the Link cannot be found

findLinks

public ResultSetEnumeration findLinks(java.lang.String urlExpr,
                                      int category,
                                      int[] orderBy)
                               throws PanamaRuntimeException

Find Links by their "url" path name

Parameters:

urlExpr - the path to the Link including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Link objects

Throws:

PanamaRuntimeException - if the Link cannot be found

findLinksByName

public ResultSetEnumeration findLinksByName(java.lang.String nameExpr,
                                            int category,
                                            int[] orderBy)
                                     throws PanamaRuntimeException

Find Links by their name

Parameters:

nameExpr - the name of the Link including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Link objects

Throws:

PanamaRuntimeException - if the Link cannot be found

lookupExternalLink

public ExternalLink lookupExternalLink(java.lang.String url)
                                throws PanamaRuntimeException

Lookup an ExternalLink

Parameters:

url - the complete path to the ExternalLink.

Returns:

ExternalLink the ExternalLink.

Throws:

PanamaRuntimeException - if the ExternalLink cannot be found

lookupExternalLink

public ExternalLink lookupExternalLink(long id)
                                throws PanamaRuntimeException

Lookup an ExternalLink

Parameters:

id - the system object id.

Returns:

ExternalLink the interface to the ExternalLink.

Throws:

PanamaRuntimeException - if the ExternalLink cannot be found

findExternalLinks

public ResultSetEnumeration findExternalLinks(java.lang.String urlExpr)
                                       throws PanamaRuntimeException

Find ExternalLinks by their "url" path name

Parameters:

urlExpr - the path to the ExternalLink including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different ExternalLink objects

Throws:

PanamaRuntimeException - if the ExternalLink cannot be found

findExternalLinks

public ResultSetEnumeration findExternalLinks(java.lang.String urlExpr,
                                              int category,
                                              int[] orderBy)
                                       throws PanamaRuntimeException

Find ExternalLinks by their "url" path name

Parameters:

urlExpr - the path to the ExternalLink including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different ExternalLink objects

Throws:

PanamaRuntimeException - if the ExternalLink cannot be found

findExternalLinksByName

public ResultSetEnumeration findExternalLinksByName(java.lang.String nameExpr,
                                                    int category,
                                                    int[] orderBy)
                                             throws PanamaRuntimeException

Find ExternalLinks by their name

Parameters:

urlExpr - the name of the ExternalLink including wildcards as [%*, _?]

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different ExternalLink objects

Throws:

PanamaRuntimeException - if the ExternalLink cannot be found

lookupAlert

public Alert lookupAlert(java.lang.String url)
                  throws PanamaRuntimeException

Lookup an Alert

Parameters:

url - the complete path to the Alert.

Returns:

Alert the Alert.

Throws:

PanamaRuntimeException - if the Alert cannot be found

lookupAlert

public Alert lookupAlert(long id)
                  throws PanamaRuntimeException

Lookup an Alert

Parameters:

id - the system object id.

Returns:

Alert the interface to the Alert.

Throws:

PanamaRuntimeException - if the Alert cannot be found

findAlerts

public ResultSetEnumeration findAlerts(java.lang.String urlExpr)
                                throws PanamaRuntimeException

Find Alerts by their "url" path name

Parameters:

urlExpr - the path to the Alert including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different Alert objects

Throws:

PanamaRuntimeException - if the Alerts cannot be found

findAlerts

public ResultSetEnumeration findAlerts(java.lang.String urlExpr,
                                       int[] orderBy)
                                throws PanamaRuntimeException

Find Alerts by their "url" path name

Parameters:

urlExpr - the path to the Alert including wildcards as [%*, _?]

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of different Alert objects

Throws:

PanamaRuntimeException - if the Alerts cannot be found

lookupAlertAddress

public AlertAddress lookupAlertAddress(java.lang.String url)
                                throws PanamaRuntimeException

Lookup an AlertAddress

Parameters:

url - the complete path to the AlertAddress.

Returns:

AlertAddress the AlertAddress.

Throws:

PanamaRuntimeException - if the AlertAddress cannot be found

lookupAlertAddress

public AlertAddress lookupAlertAddress(long id)
                                throws PanamaRuntimeException

Lookup an AlertAddress

Parameters:

id - the system object id.

Returns:

AlertAddress the interface to the AlertAddress.

Throws:

PanamaRuntimeException - if the AlertAddress cannot be found

findAlertAddresses

public ResultSetEnumeration findAlertAddresses(java.lang.String nameExpr)
                                        throws PanamaRuntimeException

Find AlertAddress by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different Alert objects

Throws:

PanamaRuntimeException - if the Alerts cannot be found

lookupDeviceAddress

public DeviceAddress lookupDeviceAddress(long id)
                                  throws PanamaRuntimeException

Lookup a device address

Parameters:

id - the system object id

Returns:

the devicve address

Throws:

PanamaRuntimeException - if the device address cannot be found

lookupDeviceAddress

public DeviceAddress lookupDeviceAddress(DeliveryType deliveryType,
                                         java.lang.String address)
                                  throws PanamaRuntimeException

Lookup a device address

Parameters:

deliveryType - the delivery type

address - the address

Returns:

the device address

Throws:

PanamaRuntimeExceotion - if the device address cannot be found

lookupLocationMark

public LocationMark lookupLocationMark(java.lang.String name,
                                       java.lang.String userName)
                                throws PanamaRuntimeException

Lookup a LocationMark by name and user name (logical key)

Parameters:

name - the complete not null name of the LocationMark

userName - the complete not null name of the PanamaUser

Returns:

the interface to the LocationMark

Throws:

PanamaRuntimeException - if the LocationMark cannot be found

lookupLocationMark

public LocationMark lookupLocationMark(long id)
                                throws PanamaRuntimeException

Lookup an LocationMark

Parameters:

id - the system object id.

Returns:

LocationMark the interface to the LocationMark.

Throws:

PanamaRuntimeException - if the LocationMark cannot be found

findLocationMarks

public ResultSetEnumeration findLocationMarks(java.lang.String nameExpr)
                                       throws PanamaRuntimeException

Find LocationMark by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different LocationMarks objects

Throws:

PanamaRuntimeException - if the LocationMarks cannot be found

lookupDevice

public Device lookupDevice(java.lang.String name)
                    throws PanamaRuntimeException

Lookup a Device

Parameters:

name - the name of the Device

Returns:

Device the Device

Throws:

PanamaRuntimeException - if the Device cannot be found

lookupDevice

public Device lookupDevice(long id)
                    throws PanamaRuntimeException

Lookup Device

Parameters:

id - the system object id.

Returns:

Device the interface to the Device.

Throws:

PanamaRuntimeException - if the Device cannot be found

findDevices

public ResultSetEnumeration findDevices(java.lang.String nameExpr)
                                 throws PanamaRuntimeException

Find Devices by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of Device objects

Throws:

PanamaRuntimeException - if the Devices cannot be found

findDevices

public ResultSetEnumeration findDevices(java.lang.String urlExpr,
                                        int[] orderBy)
                                 throws PanamaRuntimeException

Find Devices by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

orderBy - the order in which the Devices should be sorted

Returns:

ResultSetEnumeration of Device objects

Throws:

PanamaRuntimeException - if the Devices cannot be found

findDevicesByTransformer

public Device[] findDevicesByTransformer(java.lang.String nameExpr,
                                         int[] orderBy)
                                  throws PanamaRuntimeException

Find Devices by a name of a transformer

Parameters:

nameExpr - the transformer name including wildcards as [%*, _?]

orderBy - the order in which the Devices should be sorted

Returns:

ResultSetEnumeration of Device objects

Throws:

PanamaRuntimeException - if the Devices cannot be found

findDevicesByUserAgent

public Device[] findDevicesByUserAgent(java.lang.String nameExpr,
                                       int[] orderBy)
                                throws PanamaRuntimeException

Find Devices by the HTTP User-Agent used to detect the device

Parameters:

nameExpr - the User-Agent including wildcards as [%*, _?]

orderBy - the order in which the Devices should be sorted

Returns:

ResultSetEnumeration of Device objects

Throws:

PanamaRuntimeException - if the Devices cannot be found

findDevicesByDeviceCategory

public ResultSetEnumeration findDevicesByDeviceCategory(DeviceCategory category,
                                                        int[] orderBy)
                                                 throws PanamaRuntimeException

Find Devices by DeviceCategory

Parameters:

category - the DeviceCategory

orderBy - the order in which the Devices should be sorted

Returns:

ResultSetEnumeration of Device objects

Throws:

PanamaRuntimeException - if the Devices cannot be found

lookupTransformer

public Transformer lookupTransformer(java.lang.String name)
                              throws PanamaRuntimeException

Lookup a Transformer

Parameters:

name - the name of the Transformer

Returns:

Transformer the Transformer

Throws:

PanamaRuntimeException - if the Transformer cannot be found

lookupTransformer

public Transformer lookupTransformer(long id)
                              throws PanamaRuntimeException

Lookup Transformer

Parameters:

id - the system object id.

Returns:

Transformer the interface to the Transformer.

Throws:

PanamaRuntimeException - if the Transformer cannot be found

findTransformers

public ResultSetEnumeration findTransformers(java.lang.String nameExpr)
                                      throws PanamaRuntimeException

Find Transformers by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of Transformer objects

Throws:

PanamaRuntimeException - if the Transformers cannot be found

findTransformers

public ResultSetEnumeration findTransformers(java.lang.String nameExpr,
                                             int[] orderBy)
                                      throws PanamaRuntimeException

Find Transformers by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

orderBy - the order in which the Transformers should be sorted

Returns:

ResultSetEnumeration of Transformer objects

Throws:

PanamaRuntimeException - if the Transformers cannot be found

findTransformersByMimeType

public ResultSetEnumeration findTransformersByMimeType(java.lang.String mimeType)
                                                throws PanamaRuntimeException

Find Transformers by mime type

Parameters:

mimeType - the mimeType

Returns:

ResultSetEnumeration of Transformer objects

Throws:

PanamaRuntimeException - if the transformers cannot be found

lookupDataFeeder

public DataFeeder lookupDataFeeder(java.lang.String name)
                            throws PanamaRuntimeException

Get a named DataFeeder

Parameters:

DataFeeder - name

Throws:

PanamaRuntimeException - if the DataFeeder cannot be found

getRootServices

public ResultSetEnumeration getRootServices()
                                     throws PanamaRuntimeException

Get all root services

Returns:

ResultSetEnumeration with all root services

Throws:

PanamaRuntimeException - if the root services cannot be found

lookupTopic

public Topic lookupTopic(long id)
                  throws PanamaRuntimeException

Get a topic for the given id

Parameters:

id - Topic id

Throws:

PanamaRuntimeException - if the Topic cannot be found

lookupTopic

public Topic lookupTopic(java.lang.String name)
                  throws PanamaRuntimeException

Get a topic for the given name

Parameters:

name - Topic name

Throws:

PanamaRuntimeException - if the Topic cannot be found

findTopics

public Topic[] findTopics(java.lang.String nameExpr)
                   throws PanamaRuntimeException

Finds topics which names match the search criteria.

Parameters:

nameExpr - the name including wildcard as [%].

Returns:

Array of Topic objects.

Throws:

PanamaRuntimeException - if the Topics cannot be found

getRootTopics

public Topic[] getRootTopics()
                      throws PanamaRuntimeException

Finds topics which do not have a parent topic

Returns:

Array of Topic objects.

Throws:

PanamaRuntimeException - if the Topics cannot be found

getRootAlertServices

public AlertService[] getRootAlertServices()
                                    throws PanamaRuntimeException

Finds alert services which do not have a parent topic

Returns:

Array of AlertService objects.

Throws:

PanamaRuntimeException - if the AlertService cannot be found

lookupMasterAlertService

public MasterAlertService lookupMasterAlertService(long id)
                                            throws PanamaRuntimeException

Get a MasterAlertService for the given id

Parameters:

id - MasterAlertService id

Throws:

PanamaRuntimeException - if the MasterAlertService id cannot be found

findMasterAlertServices

public MasterAlertService[] findMasterAlertServices(java.lang.String nameExpr)
                                             throws PanamaRuntimeException

Returns and enmeartion of MasterAlertServices which names match the search criteria.

Parameters:

nameExpr - the name including wildcard as [%].

Returns:

array of MasterAlertService objects.

Throws:

PanamaRuntimeException - if the MasterAlertService cannot be found

lookupAlertService

public AlertService lookupAlertService(long id)
                                throws PanamaRuntimeException

Get a AlertService for the given id

Parameters:

id - AlertService id

Throws:

PanamaRuntimeException - if the AlertService cannot be found

lookupAlertService

public AlertService lookupAlertService(java.lang.String name)
                                throws PanamaRuntimeException

Get a AlertService for the given name

Parameters:

id - AlertService name

Throws:

PanamaRuntimeException - if the AlertService cannot be found

findAlertServices

public AlertService[] findAlertServices(java.lang.String nameExpr)
                                 throws PanamaRuntimeException

Finds AlertServices which names match the search criteria.

Parameters:

nameExpr - the name including wildcard as [%].

Returns:

Array of AlertServices objects.

Throws:

PanamaRuntimeException - if the AlertServices cannot be found

getAlertConditionTypes

public AlertConditionType[] getAlertConditionTypes(java.lang.String paramDataType)
                                            throws PanamaRuntimeException

Gets the condition types

Parameters:

paramDataType - the param data type name e.g. TEXT_180, NUMBER_10, etc

Returns:

array of AlertConditonTypes objects.

Throws:

PanamaRuntimeException - if the AlertConditionTypes cannot be found

getAlertTimeFrequencies

public AlertTimeFrequency[] getAlertTimeFrequencies()

Returns an array of the allowed Alert Time Frequencies

Returns:

array of AlertTimeFrequncy objects

getAlertConditionTypeByName

public AlertConditionType getAlertConditionTypeByName(java.lang.String typeName)
                                               throws PanamaRuntimeException

Gets the condition type by name

Parameters:

typeName - the condition type name a.k.a cond_type_code e.g. LT, GT, EQ, etc.

Returns:

AlertConditonType object.

Throws:

PanamaRuntimeException - if the AlertConditionType cannot be found

lookupDataFeeder

public DataFeeder lookupDataFeeder(long id)
                            throws PanamaRuntimeException

Lookup Transformer

Parameters:

id - the system object id.

Returns:

Transformer the interface to the Transformer.

Throws:

PanamaRuntimeException - if the Transformer cannot be found

findDataFeeders

public ResultSetEnumeration findDataFeeders(java.lang.String nameExpr)
                                     throws PanamaRuntimeException

Find DataFeeders by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of DataFeeder objects

Throws:

PanamaRuntimeException - if the DataFeeders cannot be found

copyFolderContent

public void copyFolderContent(Folder source,
                              Folder target,
                              User newOwner)
                       throws PanamaRuntimeException

Copy the content of one folder to another and change the owner of the new services to the specified user. This is a deep copy, i.e. all subforders of the source folders will be copied to the target folder, too.

Parameters:

source - the source Folder which content we want to copy. This Folder must exist.

target - the target Folder. This Folder must exist.

newOwner - the User owner of all newly created services.

Throws:

PanamaRuntimeException - if in some reasons the operation fails

lookupPresetCategory

public PresetCategory lookupPresetCategory(java.lang.String name)
                                    throws PanamaRuntimeException

Lookup a preset category by name.

Parameters:

name - the complete not null name of the preset category.

Returns:

PresetCategory the preset category.

Throws:

PanamaRuntimeException - if the preset category cannot be found

lookupPresetCategory

public PresetCategory lookupPresetCategory(long id)
                                    throws PanamaRuntimeException

Lookup a preset category by id.

Parameters:

name - the complete not null name of the preset category.

Returns:

PresetCategory the preset category.

Throws:

PanamaRuntimeException - if the preset category cannot be found

findPresetCategory

public ResultSetEnumeration findPresetCategory(java.lang.String nameExpr)
                                        throws PanamaRuntimeException

Finds preset categorys which names match the search criteria.

Parameters:

nameExpr - the name including wildcards as [%*, _?].

Returns:

ResultSetEnumeration of PresetCategory objects.

Throws:

PanamaRuntimeException - if the preset category cannot be found

findAsyncServices

public ResultSetEnumeration findAsyncServices(java.lang.String asyncNameExpr)
                                       throws PanamaRuntimeException

Finds async services whose async names match the search criteria.

Parameters:

asyncNameExpr - the name including wildcards as [%*, _?].

Returns:

ResultSetEnumeration of Link objects.

Throws:

PanamaRuntimeException - if the async services cannot be found

findAsyncServices

public ResultSetEnumeration findAsyncServices(java.lang.String asyncNameExpr,
                                              int category,
                                              int[] orderBy)
                                       throws PanamaRuntimeException

Finds async services whose async names match the search criteria.

Parameters:

asyncNameExpr - the name including wildcards as [%*, _?].

category - the category

1. Service.CATEGORY_SERVICERegular services
2. Service.CATEGORY_MASTERMaster services
3. Service.CATEGORY_USER_HOMEUsers home folders
4. -1All folders

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of Link objects.

Throws:

PanamaRuntimeException - if the async services cannot be found

findAsyncServices

public ResultSetEnumeration findAsyncServices(DeliveryType deliveryType)
                                       throws PanamaRuntimeException

Finds async services which can be invoked by a delivery type mechanism

Parameters:

deliveryType - the delivery type

Returns:

ResultSetEnumeration of Link objects.

Throws:

PanamaRuntimeException - if the async services cannot be found

findAsyncServices

public ResultSetEnumeration findAsyncServices(DeliveryType deliveryType,
                                              int[] orderBy)
                                       throws PanamaRuntimeException

Finds async services which can be invoked by a delivery type mechanism

Parameters:

deliveryType - the delivery type

orderBy - the order in which the services should be sorted

Returns:

ResultSetEnumeration of Link objects.

Throws:

PanamaRuntimeException - if the async services cannot be found

lookupAsyncService

public Service lookupAsyncService(java.lang.String asyncName)
                           throws PanamaRuntimeException

Lookup an async service by async name

Parameters:

asyncName - the name of the async service

Returns:

Service the async service

Throws:

PanamaRuntimeException - if the async service cannot be found

lookupAsyncService

public Service lookupAsyncService(long id)
                           throws PanamaRuntimeException

Lookup an async service by object id

Parameters:

id - the object id of the async service

Returns:

Service the async service

Throws:

PanamaRuntimeException - if the async service cannot be found

lookupAsyncService

public Service lookupAsyncService(DeliveryType deliveryType,
                                  java.lang.String address)
                           throws PanamaRuntimeException

Lookup an async service by delivery type and address

Parameters:

deliveryType - the delivery type of the async service

address - the address of the async service

Returns:

Service the async service

Throws:

PanamaRuntimeException - if the async service cannot be found

getMasterAlertServices

public ResultSetEnumeration getMasterAlertServices(java.lang.String nameExpr)
                                            throws PanamaRuntimeException

Returns and enmeartion of MasterAlertServices which names match the search criteria.

Parameters:

nameExpr - the name including wildcard as [%].

Returns:

array of MasterAlertService objects.

Throws:

PanamaRuntimeException - if the MasterAlertService cannot be found

getTopics

public ResultSetEnumeration getTopics(java.lang.String nameExpr)
                               throws PanamaRuntimeException

Finds topics which do not have a parent topic

Returns:

ResultSetEnumeration of Topic objects.

Throws:

PanamaRuntimeException - if the Topics cannot be found

getAlertServices

public ResultSetEnumeration getAlertServices(java.lang.String nameExpr)
                                      throws PanamaRuntimeException

Finds alert services which do not have a parent topic

Returns:

ResultSetEnumeration of AlertService objects.

Throws:

PanamaRuntimeException - if the AlertService cannot be found

lookupMasterAlertService

public MasterAlertService lookupMasterAlertService(java.lang.String name)
                                            throws PanamaRuntimeException

Get a MasterAlertService given the name

Parameters:

name - MasterAlertService name

Throws:

PanamaRuntimeException - if the MasterAlertService cannot be found

getPresetDataTypes

public DataType[] getPresetDataTypes()

Get valid Preset Data Types.

lookupLocationPrivacyAuth

public LocationPrivacyAuth lookupLocationPrivacyAuth(Service service,
                                                     User owner,
                                                     ModelObject positionRequester)
                                              throws PanamaRuntimeException

Lookup a LocationPrivacyAuth by service, privacy owner and the positionRequester.

Parameters:

service - the service in which the authorization is in effect

owner - the user who grants the authorization

positionRequester - the positionRequester who is authorized to access the owner's location information

Returns:

the interface to the LocationPrivacyAuth

Throws:

PanamaRuntimeException - if the LocationPrivacyAuth cannot be found

lookupLocationPrivacyAuth

public LocationPrivacyAuth lookupLocationPrivacyAuth(long id)
                                              throws PanamaRuntimeException

Lookup a LocationPrivacyAuth

Parameters:

id - the system object id.

Returns:

the interface to the LocationPrivacyAuth

Throws:

PanamaRuntimeException - if the LocationPrivacyAuth cannot be found

findLocationPrivacyAuths

public ResultSetEnumeration findLocationPrivacyAuths(Service service)
                                              throws PanamaRuntimeException

Find LocationPrivacyAuth by service

Parameters:

service - the service to which the requested loation privacy authorization items belong

Returns:

ResultSetEnumeration of different LocationPrivacyAuth objects

Throws:

PanamaRuntimeException - if the LocationPrivacyAuths cannot be found

findLocationPrivacyAuths

public ResultSetEnumeration findLocationPrivacyAuths(java.lang.String nameExpr)
                                              throws PanamaRuntimeException

Find LocationPrivacyAuth by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different LocationPrivacyAuth objects

Throws:

PanamaRuntimeException - if the LocationPrivacyAuths cannot be found

findLocationPrivacyAuths

public ResultSetEnumeration findLocationPrivacyAuths(Service service,
                                                     User owner,
                                                     java.lang.String positionRequesterType,
                                                     java.lang.String status)
                                              throws PanamaRuntimeException

Find LocationPrivacyAuth by service, the privacy owner, the type of the positionRequester and the status of the authorization

Parameters:

service - the service where the requested location privacy authorization happens

owner - the user who grants the authorization

positionRequesterType - the type of the positionRequester. If it is set, the value is either User.typeName or Community.TypeName. If this parameter is null, return both types

status - the status of the authorization. If the status parameter is null, return all the authorizations that meet the other criteria no matter what status the authorization has.

Returns:

ResultSetEnumeration of LocationPrivacyAuth objects

Throws:

PanamaRuntimeException - if the LocationPrivacyAuths cannot be found

See Also:

LocationPrivacyAuth

lookupCommunity

public Community lookupCommunity(User creator,
                                 java.lang.String cmtyName)
                          throws PanamaRuntimeException

Lookup a Community by creator and the community name. Creator and community name together uniquely identify a community in the system.

Parameters:

creator - the user who creates the community

cmtyName - the name of the community

Returns:

the interface to the Community

Throws:

PanamaRuntimeException - if the Community cannot be found

lookupCommunity

public Community lookupCommunity(long id)
                          throws PanamaRuntimeException

Lookup a Community

Parameters:

id - the system object id.

Returns:

the interface to the Communtity

Throws:

PanamaRuntimeException - if the Community cannot be found

findCommunity

public ResultSetEnumeration findCommunity()
                                   throws PanamaRuntimeException

Find all Communities in the system

Returns:

ResultSetEnumeration of different Community objects

Throws:

PanamaRuntimeException - if the Communities cannot be found

findCommunity

public ResultSetEnumeration findCommunity(java.lang.String cmtyType)
                                   throws PanamaRuntimeException

Find Community by community type

Parameters:

cmtyType - the type of the community. It can be one of the three values CMTY_PRIVATE, CMTY_SHARED, CMTY_SYSTEM which are defined in oracle.panama.model.Community

Returns:

ResultSetEnumeration of Community objects

Throws:

PanamaRuntimeException - if the Commnities cannot be found

See Also:

Community

findCreatedCommunity

public ResultSetEnumeration findCreatedCommunity(User creator)
                                          throws PanamaRuntimeException

Find Community by community creator

Parameters:

creator - the user who creates the community

Returns:

ResultSetEnumeration of Community objects

Throws:

PanamaRuntimeException - if the Commnities cannot be found

findCreatedCommunity

public ResultSetEnumeration findCreatedCommunity(User creator,
                                                 java.lang.String cmtyType)
                                          throws PanamaRuntimeException

Find Community by creator and the community type

Parameters:

creator - the user who creates the community

cmtyType - the type of the community. It can be one of the three values CMTY_PRIVATE, CMTY_SHARED, CMTY_SYSTEM which are defined in oracle.panama.model.Community

Returns:

ResultSetEnumeration of Community objects

Throws:

PanamaRuntimeException - if the Commnities cannot be found

See Also:

Community

findVisibleCommunity

public ResultSetEnumeration findVisibleCommunity(User user,
                                                 java.lang.String cmtyType)
                                          throws PanamaRuntimeException

Find the communities which are visible to the user and have the type of cmtyType A private community is only visible to the its creator. A shared community is visible to all its members. A system community is visible to all the users in the system.

Parameters:

user - the user who requests the visible communities

cmtyType - the type of the community. It can be one of the three values CMTY_PRIVATE, CMTY_SHARED, CMTY_SYSTEM which are defined in oracle.panama.model.Community

Returns:

ResultSetEnumeration of Community objects

Throws:

PanamaRuntimeException - if the Commnities cannot be found

See Also:

Community

findCommunities

public ResultSetEnumeration findCommunities(java.lang.String nameExpr)
                                     throws PanamaRuntimeException

Find Communities by name

Parameters:

nameExpr - the name including wildcards as [%*, _?]

Returns:

ResultSetEnumeration of different Community objects

Throws:

PanamaRuntimeException - if the Communities cannot be found

findMasterAlertServices

public MasterAlertService[] findMasterAlertServices(java.lang.String nameExpr,
                                                    int[] orderBy)
                                             throws PanamaRuntimeException

Find Master alert services ordered as specified

Parameters:

nameExpr - the name including wildcards as [%,*]

orderBy - the order in which the services should be sorted

Returns:

Array of MasterAlertServices ordered as specified

Throws:

PanamaRuntimeException - if the MasterAlertServices cannot be found

findTimeEnabledMasterAlerts

public MasterAlertService[] findTimeEnabledMasterAlerts(java.lang.String nameExpr,
                                                        int[] orderBy)
                                                 throws PanamaRuntimeException

Find time enabled Master alert services ordered as specified

Parameters:

nameExpr - the name including wildcards as [%,*]

orderBy - the order in which the services should be sorted

Returns:

Array of MasterAlertServices ordered as specified

Throws:

PanamaRuntimeException - if the MasterAlertServices cannot be found

findTopics

public Topic[] findTopics(java.lang.String nameExpr,
                          int[] orderBy)
                   throws PanamaRuntimeException

Find Topics ordered as specified

Parameters:

nameExpr - the name including wildcards as [%,*]

orderBy - the order in which the services should be sorted

Returns:

Array of Topics ordered as specified

Throws:

PanamaRuntimeException - if the Topics cannot be found

findAlertServices

public AlertService[] findAlertServices(java.lang.String nameExpr,
                                        int[] orderBy)
                                 throws PanamaRuntimeException

Returns and enumeartion of AlertServices which names match the search criteria.

Parameters:

nameExpr - the name including wildcard as [%].

int - orderBy the order by clause to choose

Returns:

array of AlertService objects.

Throws:

PanamaRuntimeException - if the AlertService cannot be found